Update Key Name

Classic/VPC環境で利用できます。

キーの名前を変更します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
PUT	/keys/{keyTag}/name

リクエストヘッダ

Key Management Service APIで共通して使用されるヘッダの詳細は、Key Management Serviceのリクエストヘッダでアカウント認証方式をご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`keyTag`	String	Required	キータグキー名から派生したキーの固有 ID Get Key Listを参照 REST APIで暗号化または復号化をリクエストする際に使用キータグは機密情報として扱われない

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`keyName`	String	Required	変更後のキー名英数字、記号の「-」、「_」を組み合わせて3~15文字以内で入力先頭文字は英字にして、ユーザーのキーストア内の他のキー名と重複不可

リクエスト例

リクエストのサンプルコードは次の通りです。

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"
    }
}