カスタマーマスターキー (CMK) を作成します。

CMK で少量のデータ (最大6 KB) を暗号化することができます。 通常、CMK を使用して大量のデータの暗号化に使用できるデータキーを生成します。 詳細については、GenerateDataKey をご参照ください。

リクエストパラメーター

名前 データ型 必須 / 省略可能 説明
Origin String 省略可能 CMK のキーマテリアルのソース。

有効値：Aliyun_KMS 、 EXTERNAL 。

注 既定値：Aliyun_KMS 。 値は、大文字と小文字が区別されますのでご注意ください。
EXTERNAL を選択した場合、次の操作が必要になります。キーマテリアルのインポート
Description String 省略可能 CMK の説明。 長さ制約 : 最小 0 文字。 最大 8192 文字。
KeyUsage String 省略可能 CMK の使用目的。 既定値：ENCRYPT / DECRYPT。

レスポンスパラメーター

名前 データ型 説明
KeyMetadata KeyMetadata CMK に関連付けられたメタデータ。

KeyMetadata

名前 データ型 説明
CreationDate Timestamp CMK が作成された日時 (UTC 形式) 。
Description String CMK の説明
KeyId String CMK のグローバル一意識別子。
KeyState String CMK の状態。 詳細については、Impact of CMK states on API call をご参照ください。
KeyUsage String CMK を使用できる暗号化操作。 有効値：ENCRYPT / DECRYPT。
DeleteDate Timestamp KMS が CMK を削除する日時。
  • 値が null の場合は CMK が削除されないことを示します。
  • この値は、 KeyState が PendingDeletion の場合にのみ表示されます。
Creator String CMK の作成者。
Arn String CMK の Alibaba Cloud Resource Name (ARN) 。
Origin String CMK のキーマテリアルのソース。
MaterialExpireTime String インポートされたキーマテリアルの有効期限が切れる時刻。 値が null の場合、キーの期限は切れません。

例

リクエストの例

https://kms.cn-hangzhou.aliyuncs.com/?Action=CreateKey
&Description=<your key description>
&KeyUsage=ENCRYPT/DECRYPT
&Origin=<key origin, default Aliyun_KMS>
&<Common request parameters>

レスポンス例

JSON 形式 

//json response
{
        "KeyMetadata": {
                "creationDate": "2016-01-04T09:47:40Z",
                "Description": "key description example",
                "KeyId": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
                "KeyState": "Enabled",
                "KeyUsage": "ENCRYPT/DECRYPT",
                "DeleteDate": "",
                "Creator":"123456",
                "Arn":"acs:kms:cn-hangzhou:123456:key/08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
                "Origin":"Aliyun_KMS",
                "MaterialExpireTime":""
        },
        "RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

XML 形式 

//xml response
<KMS>
 <KeyMetadata>
        <CreationDate>2016-03-25T10:40:47Z</CreationDate>
        <Description>key description example</Description><!-- description-->
        <KeyId>08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****</KeyId>
        <KeyState>Enabled</KeyState>
        <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
        <DeleteDate> </ DeleteDate>
        <Creator>123456</Creator>
        <Arn>acs:kms:cn-hangzhou:123456:key/08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****</Arn>
        <Origin>Aliyun_KMS</Origin>
        <MaterialExpireTime></MaterialExpireTime>
 </KeyMetadata>
 <RequestId>6cb4bf6b-d9c9-4660-af5f-2328378e7257</RequestId>
</KMS>