DescribeUserEncryptionKeyList による KMS キーリストの取得 - PolarDB

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeUserEncryptionKeyList

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageSize	integer	任意	1 ページあたりのエントリ数。	30
PageNumber	integer	任意	ページ番号。	1
DBClusterId	string	任意	クラスター ID。説明 DescribeDBClusters 操作を呼び出して、ターゲットリージョン内のすべてのクラスター (クラスター ID を含む) に関する情報をクエリします。	pc-************
RegionId	string	任意	リージョン ID。説明 DescribeRegions 操作を呼び出して、宛先アカウントで利用可能なリージョン (リージョン ID を含む) に関する情報をクエリします。	cn-hangzhou
TDERegion	string	任意	TDE (透過的データ暗号化) キーのリージョン。	cn-beijing

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	A7E6A8FD-C50B-46B2-BA85-D8B8D3******
KeyList	array	クラスターキーのリスト。
	string	キーのリスト。	0275bd3f-fdbb-4d8c-846b-71b211******
TotalRecordCount	integer	エントリの総数。	1
PageRecordCount	integer	現在のページのエントリ数。	1
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	30
DBClusterId	string	クラスター ID。	pc-************

例

成功レスポンス

JSONJSON

{
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "KeyList": [
    "0275bd3f-fdbb-4d8c-846b-71b211******"
  ],
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "DBClusterId": "pc-************"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ByokRoleArnNotFound	The roleArn can't be null.
401	ByokNotAuthorizedToRds	This user is not Authorized Rds.
403	UnsupportedKmsService.NotEnabled	KMS service is not enabled.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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