現在のリージョンの現在のAlibaba Cloudアカウントのすべてのカスタマーマスターキー (CMK) を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 ListKeys

実行する操作です。 値をListKeysに設定します。

PageNumber Integer いいえ、できません。 1

返されるページ数。

ページは 1 ページ目から始まります。

デフォルト値:1

PageSize Integer いいえ、できません。 10

各ページで返されるエントリ数。

Valid values: 1 to 100.

既定値:1

フィルター String 任意 [{"Key":"KeyState", "Values":["Enabled", "Disabled"]}]

CMKフィルター。 フィルタは、1つ以上のキーと値のペアで構成されます。 最大10個のキーと値のペアを指定できます。

  • キー
    • 説明: フィルタリングするプロパティ。
    • タイプ: string。
    • 設定可能な値は以下のとおりです。
      • KeyState: CMKのステータス。
      • KeySpec: CMKのタイプ。
      • KeyUsage: CMKの使用法。
      • ProtectionLevel: 保護レベル。
      • CreatorType: 作成者のタイプ。
    • 説明: フィルタリング後に含まれる値。
    • 形式: string配列。
    • 長さ: 0〜10。
    • 設定可能な値は以下のとおりです。
      • KeyがKeyStateに設定されている場合、値はEnabled、Disabled、PendingDeletion、またはPendingImportになります。
      • KeyがKeySpecに設定されている場合、値はAliyun_AES_256、Aliyun_SM4、RSA_2048、EC_P256、EC_P256K、またはEC_SM2です。

        注: EC_SM2またはAliyun_SM4タイプのCMKは、State Cryptography Administration (SCA) 認定のマネージドHSMが存在するリージョンでのみ作成できます。 リージョンの詳細については、「サポートされているリージョン」をご参照ください。 リージョンがEC_SM2またはAliyun_SM4をサポートしていない場合、2つの値が指定されている場合は無視されます。

      • KeyがKeyUsageに設定されている場合、値はENCRYPT/DECRYPTまたはSIGN/VERIFYになります。 ENCRYPT/DECRYPTは、CMKがデータの暗号化と復号化に使用されることを示します。 SIGN/VERIFYは、CMKを使用してデジタル署名を生成および検証することを示します。
      • KeyがProtectionLevelに設定されている場合、値はSOFTWARE (ソフトウェア) またはHSM (ハードウェア) になります。

        ProtectionLevelを特定のリージョンでのみHSMに設定できます。 リージョンの詳細については、「サポートされているリージョン」をご参照ください。 リージョンが値HSMをサポートしていない場合、値が指定されている場合、値は無視されます。

      • KeyがCreatorTypeに設定されている場合、値はUserまたはServiceになります。 ユーザーは、現在のアカウントによって作成されたCMKが照会されることを示します。 サービスは、現在のアカウントによって承認された他のクラウドサービスによって自動的に作成されたCMKが照会されることを示します。

異なるキー間の論理関係はANDであり、同じキー内の複数の項目間の論理関係はORである。 例:

[ {"Key":"KeyState", "Values":["Enabled", "Disabled"]}, {"Key":"KeyState", "Values":["Pending"]}, {" Key ":" KeySpec "," Values ":[" Aliyun_AES_256 "]}] 。 この例では、セマンティクスは、(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_ 256) である。

レスポンスパラメーター

パラメーター データ型 説明
PageNumber Integer 1

返されたページ数。

PageSize Integer 10

1 ページあたりで返されるエントリ数。

RequestId String 8252db58-2036-408c-a3d5-56e656dc2551

リクエストのID。問題の特定とトラブルシューティングに使用されます。

TotalCount Integer 3

CMKの総数。

Keys キーの配列

現在のリージョンの現在のAlibaba CloudアカウントのCMKで構成される配列。

キー
KeyId String 08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4 ****

CMKのID。 IDはグローバルに一意である必要があります。

KeyArn String acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81 ****

CMK の Alibaba Cloud Resource Name (ARN) 。

リクエストの例

http(s)://[Endpoint]/?Action=ListKeys
&PageNumber=1
&PageSize=10
&Filters=[{"Key":"KeyState", "Values":["Enabled", "Disabled"]}]
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListKeysResponse>
    <ページ番号> 1 </ PAGENUMBER>
    <のPageSize> 10 </がPageSize>
    <RequestId>8252db58-2036-408c-a3d5-56e656dc2551</RequestId>
    <TotalCount>3</TotalCount>
    <キー>
        <KeyId>08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****</KeyId>
        <KeyArn>acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81 ****</KeyArn>
    </キー>
</ListKeysResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNumber" : 1,
  "PageSize" : 10,
  "RequestId" : "8252db58-2036-408c-a3d5-56e656dc2551" 、
  "TotalCount" : 3、
  "キー" : [ {
    "KeyId" : "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4 ****" 、
    "KeyArn" : "acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81 ****"
  } ]
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。