DescribeClusterResourceUsage を呼び出してクラスターリソース使用量をクエリ - AnalyticDB for MySQL

AnalyticDB for MySQL クラスターのリソース使用量をクエリします。

操作説明

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

今すぐお試しください

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

get

*DBClusterLakeVersion

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID です。説明リージョン内のすべての AnalyticDB for MySQL クラスターの ID をクエリするには、DescribeDBClusters 操作を呼び出します。	amv-bp11q28kvl688****
StartTime	string	必須	クエリする時間範囲の開始時刻です。yyyy-MM-ddTHH:mm:ssZ 形式で ISO 8601 標準に従って指定します。時刻は協定世界時 (UTC) である必要があります。	2022-11-29T10:20Z
EndTime	string	必須	クエリする時間範囲の終了時刻です。yyyy-MM-ddTHH:mm:ssZ 形式で ISO 8601 標準に従って指定します。時刻は協定世界時 (UTC) である必要があります。	2022-08-22T01:06:00Z

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
RequestId	string	リクエスト ID です。	1AD222E9-E606-4A42-BF6D-8A4442913CEAW
Code	integer	HTTP ステータスコードです。	200
Data	object	クエリされたリソース使用量です。
DBClusterId	string	クラスター ID です。	amv-uf6dj23rt5zo9s9d
StartTime	string	クエリの開始時刻です。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で ISO 8601 標準に従い、協定世界時 (UTC) で表示されます。	2023-03-14T03:42:15Z
EndTime	string	クエリの終了時刻です。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で ISO 8601 標準に従い、協定世界時 (UTC) で表示されます。	2023-03-23T02:31Z
AcuInfo	array<object>	クラスターの AnalyticDB 計算ユニット (ACU) 使用量です。
	object
Name	string	リソース使用量メトリックです。有効な値は次のとおりです。 `TotalAcuNumber`：ACU の合計数。 `ReservedAcuNumber`：予約済みリソースの ACU 数。 `ReservedAcuUsageNumber`：使用されている予約済みリソースの ACU 数。	TotalAcuNumber
Values	array	特定の時点におけるメトリックの値です。
	string	特定の時点におけるメトリックの値です。	16.0

例

成功レスポンス

JSONJSON

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEAW",
  "Code": 200,
  "Data": {
    "DBClusterId": "amv-uf6dj23rt5zo9s9d",
    "StartTime": "2023-03-14T03:42:15Z",
    "EndTime": "2023-03-23T02:31Z",
    "AcuInfo": [
      {
        "Name": "TotalAcuNumber",
        "Values": [
          "16.0"
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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