ListKeys - - Alibaba Cloud ドキュメントセンター

操作説明

この API を呼び出すために RAM ユーザーまたは RAM ロールに必要なアクセスポリシーの詳細については、「リソースアクセス管理」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号です。有効な値: 0 より大きい値。デフォルト値: 1。	1
PageSize	integer	任意	各ページに返すエントリの数です。有効な値: 1 から 100。デフォルト値: 10。	10
Filters	string	任意	マスターキーのフィルターです。フィルターは 0 から 10 個のキーと値のペアで構成されます。 Key 説明: フィルターするプロパティです。タイプ: 文字列。 Values 説明: フィルター後に含まれる値です。タイプ: 文字列配列。長さ: 0 から 10。有効な値: `Key` が `KeyState` に設定されている場合、キーの状態を指定します。 `Value` の有効な値は `Enabled`、`Disabled`、`PendingDeletion`、`PendingImport` です。 `Key` が `KeySpec` に設定されている場合、キーのタイプを指定します。 `Value` の有効な値は、`Aliyun_AES_256`、`Aliyun_SM4`、`RSA_2048`、`EC_P256`、`EC_P256K`、`EC_SM2`、`Aliyun_SM4` です。注: `EC_SM2` および `Aliyun_SM4` タイプのキーは、マネージド HSM をサポートし、国家商業暗号管理局 (OSCCA) のコンプライアンス評価に合格したリージョンでのみ作成できます。サポートされているリージョンの詳細については、「サポートされているリージョン」をご参照ください。これらのキータイプをサポートしていないリージョンで `EC_SM2` または `Aliyun_SM4` を指定した場合、パラメーターは無視されます。 `Key` が `KeyUsage` に設定されている場合、キーの用途を指定します。 `Value` の有効な値は `ENCRYPT/DECRYPT` (データの暗号化と復号用) と `SIGN/VERIFY` (デジタル署名の生成と検証用) です。 `Key` が `ProtectionLevel` に設定されている場合、キーの保護レベルを指定します。 `Value` の有効な値は `SOFTWARE` と `HSM` です。注: HSM 保護レベルは特定のリージョンでのみサポートされています。サポートされているリージョンの詳細については、「サポートされているリージョン」をご参照ください。サポートされていないリージョンで `HSM` を指定した場合、パラメーターは無視されます。 `Key` が `CreatorType` に設定されている場合、作成者のタイプを指定します。 `Value` の有効な値は `User` (ユーザーが作成したマスターキーを返す) と `Service` (他の Alibaba Cloud サービスがお客様の承認に基づいて自動的に作成したマスターキーを返す) です。 `Key` が `DKMSInstanceId` に設定されている場合、KMS インスタンスの ID を指定します。必要に応じて `Value` を設定します。 `Key` が `keyId` に設定されている場合、キー ID を指定します。必要に応じて `Value` を設定します。 `Key` が `AliasName` に設定されている場合、キーのエイリアスを指定します。必要に応じて `Value` を設定します。 `Key` が `Creator` に設定されている場合、キーの作成者を指定します。必要に応じて `Value` を設定します。 `Key` が `TagKey` に設定されている場合、キータグのキーを指定します。必要に応じて `Value` を設定します。 `Key` が `TagValue` に設定されている場合、キータグの値を指定します。必要に応じて `Value` を設定します。 `Filters` 内の異なるキー間の論理関係は `AND` です。同じキーの複数の値間の論理関係は `OR` です。たとえば、 `[ {"Key":"KeyState", "Values":["Enabled","Disabled"]}, {"Key":"KeyState", "Values":["PendingDeletion"]}, {"Key":"KeySpec", "Values":["Aliyun_AES_256"]} ]` と入力した場合、セマンティクスは次のようになります。 `(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_256)`.	[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]

レスポンスフィールド

パラメーター	型	説明	例
	object
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりに返されるエントリの数。	10
RequestId	string	リクエスト ID。Alibaba Cloud によって生成されるグローバルに一意な識別子 (GUID) です。リクエスト ID を使用して問題のトラブルシューティングを行うことができます。	8252db58-2036-408c-a3d5-56e656dc2551
TotalCount	integer	マスターキーの総数。	3
Keys	object
Key	array<object>	マスターキー。
	object	マスターキー。
KeyId	string	マスターキーのグローバルに一意な識別子。	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
KeyArn	string	マスターキーの Alibaba Cloud リソースネーム (ARN)。	acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。