Migrate Key

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

全域キーを隔離キーに移行します。移行により、隔離リージョン内でのみ使用可能なリージョン隔離キーに変更され、全域キーは削除されます。

参考

同じ名前の隔離キーが存在する場合、移行できません。隔離キーの詳細は、Key Management Serviceキーの隔離をご参照ください。

リクエスト

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

メソッド	URI
POST	/keys/{keyTag}/migrate

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`targetRegion`	String	Required	移行対象リージョン `KR` \| `JPN` `KR`: 韓国リージョン `JPN`: 日本リージョン

参考

韓国リージョンと日本リージョンのみサポートしています。

リクエスト例

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

curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c*****4y5z6/migrate' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "targetRegion": "KR"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	String	-	成功したかどうか
`data`	Object	-	レスポンス結果
`data.keyTag`	String	-	キータグ
`data.targetRegion`	String	-	移行対象のリージョン

レスポンスステータスコード

Key Management Service APIで共通して使用されるレスポンスステータスコードの詳細は、Key Management Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "SUCCESS",
    "data": {
        "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
        "targetRegion": "KR"
    }
}