이 가이드는 API 명세를 기반으로 자동 생성했습니다.
Classic/VPC 환경에서 이용 가능합니다.
Ncloud API 표준 규격을 적용한 API입니다.
지정한 서브 계정에서 키 값으로 식별되는 액세스 키를 활성화하거나 비활성화합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /sub-accounts/{subAccountId}/access-keys/{accessKey}/change-status |
요청 헤더
Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
subAccountId |
String (uuid) | Required | 대상 서브 계정의 식별자
|
accessKey |
String | Required | 대상 액세스 키 값. 신규 발급 키는 ncp_iam_ 접두어를 포함한 28자이며, 이전에 발급된 20자 영숫자 키도 사용 가능
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
active |
Boolean | Required | 액세스 키 활성화 여부
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://subaccount.apigw.gov-ntruss.com/api/v2/sub-accounts/4e066e50-9c3a-11e7-8a66-1e5021fa7c80/access-keys/ncp_iam_BPASKRxmpl0123456789/change-status' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"active": true
}'
응답
응답 형식을 설명합니다.
응답 상태 코드
Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.
이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 204 | - | - | 요청을 정상적으로 처리했으며 응답 본문 없음 |
| 400 | BadRequest | The request is malformed or contains an error such as an invalid parameter value or a missing required parameter. | 필수 필드 누락, 형식 오류 등 입력값 검증 실패 |
| 400 | LimitExceeded | The request exceeds the resource limit. | 서브 계정당 활성 상태로 보유할 수 있는 액세스 키 최대 2개를 이미 사용 중 |
| 403 | Forbidden | You do not have sufficient permissions to perform this action. | 요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환 |
| 404 | SubAccountNotFound | The specified sub account could not be found. | 지정한 서브 계정이 존재하지 않음 |
| 404 | AccessKeyNotFound | The specified access key could not be found. | 지정한 액세스 키가 해당 서브 계정에 존재하지 않음 |
| 409 | Conflict | The request could not be processed because of a conflict in the current status of the resource. | 서브 계정의 API Gateway 접근이 비활성화되어 있어 액세스 키 상태 변경 불가. 서브 계정의 apiGatewayAccessible을 먼저 활성화 필요 |