すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeAgenticDBClusters

    ドキュメントセンター

    PolarDB:DescribeAgenticDBClusters

    最終更新日:Sep 24, 2026

    Agentic Database クラスターのリストを照会します。

    操作説明

    操作の説明

    • この操作は、RelativeDBClusterId パラメーターおよび KubeType パラメーターに基づいて、関連するモデルオペレーターのリストをフィルター処理して返すことをサポートしています。

    • 注意: リクエストで指定する RelativeDBClusterId が既存の PolarDB インスタンス ID と一致していることを確認してください。一致していない場合、データを正しく取得できません。

    今すぐお試しください

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

    list

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    DBClusterIds

    string

    任意

    クラスター ID。複数のクラスター ID はコンマ (,) で区切ります。

    pc-**************
    AgenticDbClusterIds

    string

    任意

    Agentic クラスター ID。複数のクラスター ID はコンマ (,) で区切ります。

    pagc-**************
    DBClusterDescription

    string

    任意

    クラスターの説明。あいまい一致がサポートされています。

    pc-****************
    DBClusterStatus

    string

    任意

    クラスターのステータス。

    Running
    PageSize

    integer

    任意

    ページサイズ。有効な値: 30、50、100。

    デフォルト値: 30。

    30
    PageNumber

    integer

    任意

    ページ番号。

    1
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-************
    Tag

    array<object>

    任意

    タグ。

    object

    任意

    タグ。

    Value

    string

    任意

    タグキーに対応するタグ値。

    testValueData
    Key

    string

    任意

    タグキー。タグを使用してクラスターをフィルター処理できます。最大 20 個のタグを指定できます。各タグペアの数値 n は一意であり、1 から始まる連続した整数である必要があります。Tag.n.Key パラメーターは Tag.n.Value パラメーターとペアになります。

    type
    MaxResults

    integer

    任意

    返されるエントリの最大数。デフォルト値: 10。

    10
    NextToken

    string

    任意

    ページネーショントークン。このパラメーターには、前の API 呼び出しで返された NextToken 値を設定します。次のクエリがない場合は、このパラメーターを指定しないでください。

    212db86sca4384811e0b5e8707e******

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    TotalRecordCount

    integer

    レコードの総数。

    1
    PageRecordCount

    integer

    現在のページのクラスター数。

    1
    RequestId

    string

    リクエスト ID。

    CDB3258F-B5DE-43C4-8935-CBA0CA******
    PageNumber

    integer

    ページ番号。

    1
    Items

    array<object>

    クラスターリスト。

    array<object>

    SSL 接続情報のフォーマット。

    DBClusterId

    string

    クラスター ID。

    pc-xxxxxx
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    ZoneId

    string

    ゾーン ID。

    cn-hangzhou-i
    DBClusterStatus

    string

    クラスターのステータス。

    Running
    CreateTime

    string

    クラスターが作成された時間。

    時間は ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2020-08-14T05:58:42Z
    DBClusterDescription

    string

    クラスターの説明。

    ocpx
    DBType

    string

    データベースエンジンのタイプ。

    MySQL
    DBVersion

    string

    データベースエンジンのバージョン。

    8.0
    Category

    string

    クラスターのエディション。有効な値:

    • 法線: Cluster Edition

    • Basic: シングルノードエディション

    • Archive: X-Engine エディション

    • NormalMultimaster: マルチマスタークラスター (データベース/テーブル)

    法線
    ServerlessType

    string

    サーバーレスタイプ。戻り値が AgileServerless の場合、クラスターがサーバーレスクラスターであることを示します。

    AgileServerless
    PayType

    string

    課金方法。有効な値:

    • Postpaid: 従量課金。

    • Prepaid: サブスクリプション。

    Postpaid
    StorageType

    string

    ストレージタイプ。有効な値:

    • essdpl0

    • essdpl1

    • essdpl2

    • essdpl3

    city_redundancy
    StorageUsed

    integer

    クラスターのストレージ使用量。単位: バイト。

    3009413120
    ScaleMin

    string

    最小値: 0～32 PCU。最小値は最大値以下である必要があります。単位: PCU。

    1
    ScaleMax

    string

    最大値: 1～32 PCU。単位: PCU。

    9
    VpcId

    string

    エンドポイントが存在する仮想非公開クラウド (VPC) の ID。

    vpc-****************
    VswitchId

    string

    vSwitch ID。

    vsw-**************
    Expired

    string

    クラスターが期限切れかどうかを示します。有効な値:

    • true

    • false

    説明

    このパラメーターは、課金方法が Prepaid (サブスクリプション) のクラスターに対してのみ返されます。

    false
    LockMode

    string

    クラスターのロックステータス。有効な値:

    • Unlock: 法線。

    • ManualLock: 手動でロック済み。

    • LockByExpiration: クラスターの期限切れにより自動的にロック済み。

    Unlock
    ExpireTime

    string

    クラスターの有効期限。

    説明

    具体的な値は、課金方法が Prepaid (サブスクリプション) のクラスターに対してのみ返されます。Postpaid (従量課金) のクラスターに対しては空の値が返されます。

    時間は ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2025-06-25T09:37:10Z
    Tags

    array<object>

    タグキー。タグを使用してクラスターをフィルター処理できます。最大 20 個のタグを指定できます。各タグペアの数値 n は一意であり、1 から始まる連続した整数である必要があります。Tag.n.Key パラメーターは Tag.n.Value パラメーターとペアになります。

    object

    タグキー。タグを使用してクラスターをフィルター処理できます。最大 20 個のタグを指定できます。各タグペアの数値 n は一意であり、1 から始まる連続した整数である必要があります。Tag.n.Key パラメーターは Tag.n.Value パラメーターとペアになります。

    Value

    string

    タグ値。

    testValueData
    Key

    string

    タグキー。

    MySQL
    AgenticDbClusterId

    string

    Agentic クラスター ID。

    pagc-**************
    AgenticDbClusterDescription

    string

    Agentic クラスターの説明。

    pagc-**************
    NextToken

    string

    ページネーショントークン。このパラメーターには、前の API 呼び出しで返された NextToken 値を設定します。次のクエリがない場合は、このパラメーターを指定しないでください。

    212db86sca4384811e0b5e8707e******
    MaxResults

    integer

    返されるエントリの最大数。デフォルト値: 10。

    10

    例

    成功レスポンス

    JSONJSON

    {
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "PageNumber": 1,
  "Items": [
    {
      "DBClusterId": "pc-xxxxxx",
      "RegionId": "cn-hangzhou",
      "ZoneId": "cn-hangzhou-i",
      "DBClusterStatus": "Running",
      "CreateTime": "2020-08-14T05:58:42Z",
      "DBClusterDescription": "ocpx",
      "DBType": "MySQL",
      "DBVersion": "8.0",
      "Category": "Normal",
      "ServerlessType": "AgileServerless",
      "PayType": "Postpaid",
      "StorageType": "city_redundancy",
      "StorageUsed": 3009413120,
      "ScaleMin": "1",
      "ScaleMax": "9",
      "VpcId": "vpc-****************",
      "VswitchId": "vsw-**************",
      "Expired": "false",
      "LockMode": "Unlock",
      "ExpireTime": "2025-06-25T09:37:10Z",
      "Tags": [
        {
          "Value": "testValueData",
          "Key": "MySQL"
        }
      ],
      "AgenticDbClusterId": "pagc-**************",
      "AgenticDbClusterDescription": "pagc-**************"
    }
  ],
  "NextToken": "212db86sca4384811e0b5e8707e******",
  "MaxResults": 10
}

    エラーコード

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

    変更履歴

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