DescribeClusterResourceDetail を使用したクラスターリソース使用量のクエリ - AnalyticDB for MySQL

AnalyticDB for MySQL クラスターのリソース使用量に関する情報を照会します。

操作説明

AnalyticDB for MySQL のエンドポイントについては、「エンドポイント」をご参照ください。

今すぐお試しください

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

get

*DBClusterLakeVersion

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。説明リージョン内のすべての AnalyticDB for MySQL クラスターに関する情報 (クラスター ID を含む) を照会するには、DescribeDBClusters 操作を呼び出します。	am-bp1jj9xqft1po****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Code	integer	HTTP ステータスコード。	200
Data	object	照会されたリソース使用量。
DBClusterId	string	クラスター ID。	amv-adbxxxxx
ComputeResource	string	予約済み計算リソースの量。単位: AnalyticDB 計算ユニット (ACU)。有効な値: 0 ～ 4096。値は 16 ACU 単位で指定する必要があります。各 ACU は 1 コアと 4 GB メモリに相当します。	16ACU
FreeComputeResource	string	アイドル状態の予約済み計算リソースの量。単位: ACU。有効な値: 0 ～ 4096。値は 16 ACU 単位で指定する必要があります。各 ACU は 1 コアと 4 GB メモリに相当します。	0ACU
StorageResource	string	予約済みストレージリソースの量。単位: ACU。有効な値: 0 ～ 2064。値は 24 ACU 単位で指定する必要があります。各 ACU は 1 コアと 4 GB メモリに相当します。	24ACU
ResourceGroupList	array<object>	リソースグループ。
	object
PoolId	integer	リソースグループ ID。	17
PoolName	string	リソースグループの名前。	testadb
PoolType	string	リソースグループのタイプ。	interactive
MinComputeResource	string	予約済み計算リソースの最小量。	16ACU
MaxComputeResource	string	予約済み計算リソースの最大量。	128ACU
PoolUsers	string	リソースグループのユーザー。	user1
Status	string	リソースグループのステータス。有効な値: running deleting scaling	running
ClusterSizeResource	string	予約済みパラメーター。	0
MinClusterCount	integer	予約済みパラメーター。	0
MaxClusterCount	integer	予約済みパラメーター。	0
RunningClusterCount	integer	予約済みパラメーター。	0
ClusterMode	string	予約済みパラメーター。	0
EnableSpot	boolean	リソースグループでプリエンプティブインスタンス機能が有効化されているかどうかを示します。プリエンプティブインスタンス機能が有効化されている場合、リソースは低い単位価格で課金されますが、解放される可能性があります。有効な値: true false True の値はジョブリソースグループに対してのみ返されます。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Code": 200,
  "Data": {
    "DBClusterId": "amv-adbxxxxx",
    "ComputeResource": "16ACU",
    "FreeComputeResource": "0ACU",
    "StorageResource": "24ACU",
    "ResourceGroupList": [
      {
        "PoolId": 17,
        "PoolName": "testadb",
        "PoolType": "interactive",
        "MinComputeResource": "16ACU",
        "MaxComputeResource": "128ACU",
        "PoolUsers": "user1",
        "Status": "running",
        "ClusterSizeResource": "0",
        "MinClusterCount": 0,
        "MaxClusterCount": 0,
        "RunningClusterCount": 0,
        "ClusterMode": "0",
        "EnableSpot": true
      }
    ]
  }
}

エラーコード

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

変更履歴

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