Disable Key Version

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

키의 버전을 비활성화합니다. 단, 가장 최신 버전은 비활성화할 수 없으며, 사용 중지 상태인 키의 버전도 비활성화할 수 없습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /keys/{keyTag}/versions/{version}/disable

요청 헤더

Key Management Service API에서 공통으로 사용하는 헤더에 대한 정보는 Key Management Service 요청 헤더에서 계정 인증 방식을 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
keyTag String Required 키 태그
  • 키 이름에서 파생된 키의 고유 식별자
  • Get Key List를 통해 확인
  • REST API로 암호화 또는 복호화 요청 시 사용
  • 키 태그는 기밀 정보로 취급되지 않음
version Integer Required 키 버전
  • 1~100

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/versions/1/disable' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
code String - 성공 여부
data Object - 응답 결과
data.version Integer - 비활성화된 키 버전
data.status String - 키 버전 상태
  • DISABLE: 비활성화
data.statusDate Long - 키 버전을 비활성화 상태로 변경한 일시(밀리초)
  • Unix Timestamp 형식

응답 상태 코드

Key Management Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Key Management Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": "SUCCESS",
    "data": {
        "version": 1,
        "status": "DISABLE",
        "statusDate": 1733461810876
    }
}