DescribeDBResourcePool API によるリソースグループ情報のクエリ - AnalyticDB

AnalyticDB for MySQL クラスターのリソースグループに関する情報を照会します。この操作は、AnalyticDB for MySQL Data Warehouse Edition（V3.0）クラスターのうち、Cluster Edition のエラスティックモードで実行されているものに対してのみ呼び出すことができます。

操作説明

この操作は、32 コア以上のエラスティッククラスターにのみ適用されます。

今すぐお試しください

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

get

DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	AnalyticDB for MySQL Data Warehouse Edition（V3.0）クラスターの ID です。説明特定のリージョン内にあるすべての AnalyticDB for MySQL Data Warehouse Edition（V3.0）クラスターの ID を照会するには、「DescribeDBClusters」操作を呼び出してください。	am-bp11q28kvl688****
PoolName	string	任意	リソースグループの名前です。	USER_DEFAULT

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PoolsInfo	array<object>	リソースグループの詳細情報です。
	object
QueryType	string	SQL 文の実行モードです。 batch interactive 説明詳細については、「クエリ実行モード」をご参照ください。	default_type
UpdateTime	string	リソースグループが更新された時刻です。	2022-03-09 16:57:35.241
PoolName	string	リソースグループの名前です。	USER_DEFAULT
CreateTime	string	リソースグループが作成された時刻です。	2022-03-09 16:57:35.241
PoolUsers	string	リソースグループに関連付けられたデータベースアカウントです。	testb,testc
NodeNum	integer	ノード数です。説明各ノードは 16 コアおよび 64 GB のメモリを消費します。	2
DBClusterId	string	AnalyticDB for MySQL Data Warehouse Edition（V3.0）クラスターの ID です。	am-bp11q28kvl688****

例

成功レスポンス

JSONJSON

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PoolsInfo": [
    {
      "QueryType": "default_type",
      "UpdateTime": "2022-03-09 16:57:35.241",
      "PoolName": "USER_DEFAULT",
      "CreateTime": "2022-03-09 16:57:35.241",
      "PoolUsers": "testb,testc",
      "NodeNum": 2
    }
  ],
  "DBClusterId": "am-bp11q28kvl688****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

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

変更履歴

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