Classic/VPC 환경에서 이용 가능합니다.
키의 이름을 변경합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| PUT | /keys/{keyTag}/name |
요청 헤더
Key Management Service API에서 공통으로 사용하는 헤더에 대한 정보는Key Management Service 요청 헤더에서 계정 인증 방식을 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
keyTag |
String | Required | 키 태그
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
keyName |
String | Required | 변경할 키 이름
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request PUT 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c*****4y5z6/name' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"keyName": "newKeyName"
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
code |
String | - | 성공 여부 |
data |
Object | - | 응답 결과 |
data.keyTag |
String | - | 키 태그 |
data.keyName |
String | - | 변경된 키 이름 |
응답 상태 코드
Key Management Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Key Management Service 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"code": "SUCCESS",
"data": {
"keyTag": "a1b2c*****4y5z6",
"keyName": "newKeyName"
}
}