すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeUserEncryptionKeyList

    ドキュメントセンター

    PolarDB:DescribeUserEncryptionKeyList

    最終更新日:Sep 24, 2026

    KMS キーのリストを照会します。

    今すぐお試しください

    この 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

    任意

    ページサイズ。

    列挙値:

    • 10 :

      1 ページあたり 10 エントリ。

    • 30 :

      1 ページあたり 30 エントリ。

    • 50 :

      1 ページあたり 50 エントリ。

    • 100 :

      1 ページあたり 100 エントリ。

    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

    ページサイズ。

    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. このユーザーには RDS からの権限が付与されていません。
    403 UnsupportedKmsService.NotEnabled KMS service is not enabled. KMS サービスが有効になっていません。
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 操作に失敗しました。指定されたクラスターインスタンス ID が存在しません。
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 指定された DBClusterId が現在のレコードに存在しません。
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定された DBClusterId がレコードに存在しません。

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

    変更履歴

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