DescribeDBClusterSpaceSummary API リファレンス - AnalyticDB

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:DescribeDBClusterSpaceSummary

get

DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	AnalyticDB for MySQL Data Lakehouse Edition クラスターの ID。	amv-wz9v5sa7mm79z4l2
RegionId	string	必須	リージョン ID。説明最新のリージョンリストを照会するには、DescribeRegions 操作を呼び出します。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Data	object	照会されたストレージの概要情報。
TotalSize	string	総データサイズ。単位: バイト。説明計算式: 総データサイズ = ホットデータサイズ + コールドデータサイズ。	8388608
HotData	object	ホットデータ。
TotalSize	integer	ホットデータサイズ。単位: バイト。説明計算式: ホットデータサイズ = テーブルレコードのデータサイズ + 通常インデックスのデータサイズ + 主キーインデックスのデータサイズ + その他のデータサイズ。	4194304
DataSize	integer	テーブルレコードのデータサイズ。単位: バイト。	1048576
IndexSize	integer	通常インデックスのデータサイズ。単位: バイト。	1048576
PrimaryKeyIndexSize	integer	主キーインデックスのデータサイズ。単位: バイト。	1048576
OtherSize	integer	その他のデータサイズ。単位: バイト。	1048576
ColdData	object	コールドデータ。
TotalSize	integer	コールドデータサイズ。単位: バイト。説明計算式: コールドデータサイズ = テーブルレコードのデータサイズ + 通常インデックスのデータサイズ + 主キーインデックスのデータサイズ + その他のデータサイズ。	4194304
DataSize	integer	テーブルレコードのデータサイズ。単位: バイト。	1048576
IndexSize	integer	通常インデックスのデータサイズ。単位: バイト。	1048576
PrimaryKeyIndexSize	integer	主キーインデックスのデータサイズ。単位: バイト。	1048576
OtherSize	integer	その他のデータサイズ。単位: バイト。	1048576
DataGrowth	object	データ増加量。
DayGrowth	integer	過去 1 日間のデータ増加量。単位: バイト。説明計算式: 過去 1 日間のデータ増加量 = 現在のデータサイズ - 1 日前のデータサイズ。	1048576
WeekGrowth	integer	過去 7 日間の日次データ増加量。単位: バイト。説明計算式: 過去 7 日間の日次データ増加量 = (現在のデータサイズ - 7 日前のデータサイズ) / 7。	1048576

例

成功レスポンス

JSONJSON

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Data": {
    "TotalSize": "8388608",
    "HotData": {
      "TotalSize": 4194304,
      "DataSize": 1048576,
      "IndexSize": 1048576,
      "PrimaryKeyIndexSize": 1048576,
      "OtherSize": 1048576
    },
    "ColdData": {
      "TotalSize": 4194304,
      "DataSize": 1048576,
      "IndexSize": 1048576,
      "PrimaryKeyIndexSize": 1048576,
      "OtherSize": 1048576
    },
    "DataGrowth": {
      "DayGrowth": 1048576,
      "WeekGrowth": 1048576
    }
  }
}

エラーコード

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

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

変更履歴

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