사용자 및 그룹 API
사용자 및 그룹 API에 대한 참조 가이드
초록
1장. 사용자 및 그룹 API
1.1. Group [user.openshift.io/v1]
- 설명
group은 참조 가능한 사용자 세트를 나타냅니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
1.2. Identity [user.openshift.io/v1]
- 설명
ID는 ID 공급자가 있는 사용자의 성공적인 인증을 기록합니다. 인증 소스에 대한 정보는 ID에 저장되고 ID는 단일 사용자 오브젝트와 연결됩니다. 여러 ID는 단일 사용자를 참조할 수 있습니다. 인증 공급자에서 검색된 정보는 공급자가 결정한 스키마를 사용하여 추가 필드에 저장됩니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
1.3. UserIdentityMapping [user.openshift.io/v1]
- 설명
useridentitymapping은 사용자를 ID에 매핑
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
1.4. 사용자 [user.openshift.io/v1]
- 설명
로그인하면 시스템의 모든 사용자가 User 및 Identity 리소스를 수신합니다. 관리자는 사용자의 속성을 자체 추적에 대해 직접 조작하거나 API를 통해 그룹을 설정할 수 있습니다. 사용자 이름은 고유하며 ID 공급자가 제공하는 값에 따라 선택합니다. - 사용자가 들어오는 이름이 이미 있는 경우 사용자 이름에 시스템 구성에 따라 추가된 숫자가 있을 수 있습니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
2장. Group [user.openshift.io/v1]
- 설명
group은 참조 가능한 사용자 세트를 나타냅니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
사용자
-
2.1. 사양
속성 | 유형 | 설명 |
---|---|---|
|
| APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| ||
|
| 사용자는 이 그룹의 사용자 목록입니다. |
2.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/user.openshift.io/v1/groups
-
DELETE
: 그룹 컬렉션 삭제 -
GET
: 그룹 유형의 오브젝트 목록 또는 감시 -
POST
: 그룹 생성
-
/apis/user.openshift.io/v1/watch/groups
-
GET
: 더 이상 사용되지 않는 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
/apis/user.openshift.io/v1/groups/{name}
-
DELETE
: 그룹 삭제 -
GET
: 지정된 그룹 읽기 -
PATCH
: 지정된 그룹을 부분적으로 업데이트 -
PUT
: 지정된 그룹 교체
-
/apis/user.openshift.io/v1/watch/groups/{name}
-
GET
: 더 이상 사용되지 않는 유형의 오브젝트를 감시합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
2.2.1. /apis/user.openshift.io/v1/groups
매개변수 | 유형 | 설명 |
---|---|---|
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
- HTTP 방법
-
DELETE
- 설명
- 그룹 컬렉션 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| 더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다. |
|
| 가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 그룹 유형의 오브젝트 나열 또는 감시
매개변수 | 유형 | 설명 |
---|---|---|
|
| AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다. |
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
|
| 설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- 그룹 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
2.2.2. /apis/user.openshift.io/v1/watch/groups
매개변수 | 유형 | 설명 |
---|---|---|
|
| AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다. |
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
|
| 설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다. |
- HTTP 방법
-
GET
- 설명
- 더 이상 사용되지 않는 그룹에 대한 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
2.2.3. /apis/user.openshift.io/v1/groups/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| 그룹 이름 |
매개변수 | 유형 | 설명 |
---|---|---|
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
- HTTP 방법
-
DELETE
- 설명
- 그룹 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| 오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다. |
|
| 더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다. |
|
| 가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 그룹 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 그룹을 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다. |
|
| 강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 그룹 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
2.2.4. /apis/user.openshift.io/v1/watch/groups/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| 그룹 이름 |
매개변수 | 유형 | 설명 |
---|---|---|
|
| AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다. |
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
|
| 설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다. |
- HTTP 방법
-
GET
- 설명
- 더 이상 사용되지 않는 유형의 오브젝트를 감시합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
3장. Identity [user.openshift.io/v1]
- 설명
ID는 ID 공급자가 있는 사용자의 성공적인 인증을 기록합니다. 인증 소스에 대한 정보는 ID에 저장되고 ID는 단일 사용자 오브젝트와 연결됩니다. 여러 ID는 단일 사용자를 참조할 수 있습니다. 인증 공급자에서 검색된 정보는 공급자가 결정한 스키마를 사용하여 추가 필드에 저장됩니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
providerName
-
providerUserName
-
user
-
3.1. 사양
속성 | 유형 | 설명 |
---|---|---|
|
| APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| 이 ID에 대한 추가 정보가 있습니다. |
|
| kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| ||
|
| ProviderName은 ID 정보의 소스입니다. |
|
| ProviderUserName은 공급자 범위에서 이 ID를 고유하게 나타냅니다. |
| 사용자는 이 ID가 둘 다 이름과 UID와 연결되어 있는 사용자에 대한 참조입니다. |
3.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/user.openshift.io/v1/identities
-
DELETE
: Identity의 컬렉션 삭제 -
GET
: ID 유형의 오브젝트 목록 또는 감시 -
POST
: Identity 생성
-
/apis/user.openshift.io/v1/watch/identities
-
GET
: individual changes to a list of Identity. deprecated: 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
/apis/user.openshift.io/v1/identities/{name}
-
DELETE
: Identity 삭제 -
GET
: 지정된 ID 읽기 -
PATCH
: 지정된 ID를 부분적으로 업데이트 -
PUT
: 지정된 ID를 교체
-
/apis/user.openshift.io/v1/watch/identities/{name}
-
GET
: 더 이상 사용되지 않는 개체의 변경 사항을 조사합니다. 대신 목록 작업과 함께 'watch' 매개 변수를 사용하여 'fieldSelector' 매개 변수를 사용하여 단일 항목으로 필터링합니다.
-
3.2.1. /apis/user.openshift.io/v1/identities
매개변수 | 유형 | 설명 |
---|---|---|
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
- HTTP 방법
-
DELETE
- 설명
- ID 컬렉션 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| 더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다. |
|
| 가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ID 유형의 오브젝트 나열 또는 감시
매개변수 | 유형 | 설명 |
---|---|---|
|
| AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다. |
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
|
| 설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- ID 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
3.2.2. /apis/user.openshift.io/v1/watch/identities
매개변수 | 유형 | 설명 |
---|---|---|
|
| AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다. |
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
|
| 설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다. |
- HTTP 방법
-
GET
- 설명
- 더 이상 사용되지 않는 ID 목록에 대한 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
3.2.3. /apis/user.openshift.io/v1/identities/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ID의 이름 |
매개변수 | 유형 | 설명 |
---|---|---|
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
- HTTP 방법
-
DELETE
- 설명
- ID 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| 오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다. |
|
| 더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다. |
|
| 가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ID 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ID를 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다. |
|
| 강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ID 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
3.2.4. /apis/user.openshift.io/v1/watch/identities/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ID의 이름 |
매개변수 | 유형 | 설명 |
---|---|---|
|
| AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다. |
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
|
| 설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다. |
- HTTP 방법
-
GET
- 설명
- 더 이상 사용되지 않는 오브젝트의 변경 사항을 확인합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
4장. UserIdentityMapping [user.openshift.io/v1]
- 설명
useridentitymapping은 사용자를 ID에 매핑
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
4.1. 사양
속성 | 유형 | 설명 |
---|---|---|
|
| APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| ID는 ID에 대한 참조입니다. | |
|
| kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| ||
| 사용자는 사용자에 대한 참조입니다. |
4.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/user.openshift.io/v1/useridentitymappings
-
POST
: UserIdentityMapping 생성
-
/apis/user.openshift.io/v1/useridentitymappings/{name}
-
DELETE
: UserIdentityMapping 삭제 -
GET
: 지정된 UserIdentityMapping 읽기 -
PATCH
: 지정된 UserIdentityMapping을 부분적으로 업데이트 -
PUT
: 지정된 UserIdentityMapping을 교체합니다.
-
4.2.1. /apis/user.openshift.io/v1/useridentitymappings
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. |
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
- HTTP 방법
-
POST
- 설명
- UserIdentityMapping 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
4.2.2. /apis/user.openshift.io/v1/useridentitymappings/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| UserIdentityMapping의 이름 |
매개변수 | 유형 | 설명 |
---|---|---|
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
- HTTP 방법
-
DELETE
- 설명
- UserIdentityMapping 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| 오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다. |
|
| 더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다. |
|
| 가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 UserIdentityMapping 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 UserIdentityMapping을 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다. |
|
| 강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 UserIdentityMapping을 바꿉니다.
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
5장. 사용자 [user.openshift.io/v1]
- 설명
로그인하면 시스템의 모든 사용자가 User 및 Identity 리소스를 수신합니다. 관리자는 사용자의 속성을 자체 추적에 대해 직접 조작하거나 API를 통해 그룹을 설정할 수 있습니다. 사용자 이름은 고유하며 ID 공급자가 제공하는 값에 따라 선택합니다. - 사용자가 들어오는 이름이 이미 있는 경우 사용자 이름에 시스템 구성에 따라 추가된 숫자가 있을 수 있습니다.
호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
groups
-
5.1. 사양
속성 | 유형 | 설명 |
---|---|---|
|
| APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Fullname은 사용자의 전체 이름입니다. |
|
| groups는 이 사용자가 멤버인 그룹 이름을 지정합니다. 이 필드는 더 이상 사용되지 않으며 향후 릴리스에서 제거될 예정입니다. 대신 이 User의 이름이 포함된 Group 오브젝트를 만듭니다. |
|
| ID는 이 사용자와 연결된 ID입니다. |
|
| kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
5.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/user.openshift.io/v1/users
-
DELETE
: 사용자 컬렉션 삭제 -
GET
: 사용자 유형의 오브젝트 목록 또는 감시 -
POST
: 사용자 생성
-
/apis/user.openshift.io/v1/watch/users
-
GET
: individual changes to a list of users. deprecated: 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
/apis/user.openshift.io/v1/users/{name}
-
DELETE
: 사용자 삭제 -
GET
: 지정된 사용자 읽기 -
PATCH
: 지정된 사용자를 부분적으로 업데이트 -
PUT
: 지정된 사용자 교체
-
/apis/user.openshift.io/v1/watch/users/{name}
-
GET
: 더 이상 사용되지 않는 유형의 오브젝트를 감시합니다. 대신 'fieldSelector' 매개변수를 사용하여 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
-
5.2.1. /apis/user.openshift.io/v1/users
매개변수 | 유형 | 설명 |
---|---|---|
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
- HTTP 방법
-
DELETE
- 설명
- 사용자 컬렉션 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| 더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다. |
|
| 가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 사용자 유형의 오브젝트 나열 또는 감시
매개변수 | 유형 | 설명 |
---|---|---|
|
| AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다. |
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
|
| 설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- 사용자 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
5.2.2. /apis/user.openshift.io/v1/watch/users
매개변수 | 유형 | 설명 |
---|---|---|
|
| AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다. |
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
|
| 설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다. |
- HTTP 방법
-
GET
- 설명
- User. deprecated 목록에 대한 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
5.2.3. /apis/user.openshift.io/v1/users/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| 사용자 이름 |
매개변수 | 유형 | 설명 |
---|---|---|
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
- HTTP 방법
-
DELETE
- 설명
- 사용자 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| 오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다. |
|
| 더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다. |
|
| 가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 사용자 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 사용자를 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다. |
|
| 강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 사용자 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
5.2.4. /apis/user.openshift.io/v1/watch/users/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| 사용자 이름 |
매개변수 | 유형 | 설명 |
---|---|---|
|
| AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다. |
|
| 서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다. watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다. |
|
| 반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
| 라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다. |
|
|
제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다. |
|
| 'true'인 경우 출력이 상당히 인쇄됩니다. |
|
| resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오. 기본값이 설정되지 않음 |
|
| resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 기본값이 설정되지 않음 |
|
| list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다. |
|
| 설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다. |
- HTTP 방법
-
GET
- 설명
- User. deprecated 오브젝트 변경 사항을 확인합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.