すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeAPSADBInstances

    ドキュメントセンター

    AnalyticDB:DescribeAPSADBInstances

    最終更新日:Mar 17, 2026

    AnalyticDB Pipeline Service (APS) のフェデレーテッド分析用に、AnalyticDB for MySQL クラスターのリストをクエリします。

    操作説明

    この操作を呼び出すことで、パフォーマンスメトリクスに基づいて、指定した期間におけるクラスターのパフォーマンスデータをクエリできます。収集粒度は 30 秒です。この操作では、SQL クエリ期間、スキャンされた行数、スキャンされたデータ量など、スロークエリに関する情報をクエリできます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    adb:DescribeAPSADBInstances

    none

    *DBClusterLakeVersion

    acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    必須

    ページ番号。

    1
    PageSize

    integer

    必須

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

    30
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーターです。

    RequestId

    string

    リクエスト ID。

    ******
    PageNumber

    string

    ページ番号。

    1
    PageSize

    string

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

    30
    TotalCount

    string

    返されるエントリの総数。

    100
    Items

    array<object>

    クエリされたクラスター。

    -

    object

    クエリされたクラスター。

    DBClusterId

    string

    AnalyticDB for MySQL Data Lakehouse Edition クラスターの ID。

    am-bp1********
    DBClusterDescription

    string

    クラスターの説明。

    adb_test
    ZoneId

    string

    クラスターのゾーン ID。

    cn-hangzhou-h
    ComputeResource

    string

    予約済みコンピューティングリソースの仕様。

    16ACU
    StorageResource

    integer

    予約済みストレージリソースの仕様。

    24ACU
    ReservedACU

    string

    クラスターで利用可能な残りの予約済みコンピューティングリソースの量。

    24ACU
    DBClusterStatus

    string

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

    Running
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値は次のとおりです。

    • true

    • false

    true
    Code

    string

    HTTP ステータスコードまたはエラーコード。

    0
    Message

    string

    返されたメッセージ。有効な値は次のとおりです。

    • リクエストが成功した場合、成功メッセージが返されます。

    • リクエストが失敗した場合、エラーメッセージが返されます。

    Success
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "******",
  "PageNumber": "1",
  "PageSize": "30",
  "TotalCount": "100",
  "Items": [
    {
      "DBClusterId": "am-bp1********",
      "DBClusterDescription": "adb_test",
      "ZoneId": "cn-hangzhou-h",
      "ComputeResource": "16ACU",
      "StorageResource": 0,
      "ReservedACU": "24ACU",
      "DBClusterStatus": "Running"
    }
  ],
  "Success": true,
  "Code": "0",
  "Message": "Success",
  "HttpStatusCode": 200
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidInput The specified parameter is invalid.

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

    変更履歴

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