DescribeDBClusterAttribute によるクラスター属性のクエリ - AnalyticDB

この操作では、特定のクラスターの詳細情報を取得します。

操作説明

このサービスのエンドポイント一覧については、「エンドポイント」をご参照ください。

今すぐお試しください

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

get

*DBClusterLakeVersion

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	Data Lakehouse Edition のクラスター ID。説明クラスター ID は、DescribeDBClusters 操作を呼び出して取得できます。	amv-wz9509beptiz****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	A5C433C2-001F-58E3-99F5-3274C14DF8BD
Items	object
DBCluster	array<object>	Data Lakehouse Edition のクラスター情報一覧。
	array<object>	クラスターの詳細情報。
CreationTime	string	クラスターの作成時刻。UTC 時間で、フォーマットは `yyyy-MM-ddThh:mm:ssZ` です。	2022-07-01T09:50:18Z
Expired	string	サブスクリプションクラスターが期限切れかどうかを示します。有効な値は以下のとおりです。 true：クラスターは期限切れです。 false：クラスターは期限切れではありません。説明クラスターが期限切れになると、一定期間後にロックされ、さらにはリリースされる場合があります。クラスターを更新してください。詳細については、「更新ポリシー」をご参照ください。このパラメーターは、従量課金クラスターでは返されません。	false
MaintainTime	string	クラスターのメンテナンスウィンドウ。UTC 時間で、フォーマットは `HH:mmZ-HH:mmZ` です。説明メンテナンスウィンドウの詳細については、「メンテナンスウィンドウの設定」をご参照ください。	04:00Z-05:00Z
PayType	string	クラスターの課金方法。有効な値は以下のとおりです。 Postpaid：従量課金。 Prepaid：サブスクリプション。	Prepaid
Tags	object
Tag	array<object>	タグの一覧。
	object
Key	string	タグキー。説明宛先クラスターにタグを作成するには、TagResources 操作を呼び出します。	tag1
Value	string	タグ値。	test1
Mode	string	クラスターモード。デフォルト値は flexible（エラスティッククラスター）です。	flexible
Port	integer	クラスターのポート番号。	3306
LockMode	string	クラスターのロックモード。有効な値は以下のとおりです。 Unlock：クラスターはロックされていません。 ManualLock：クラスターは手動でロックされています。 LockByExpiration：クラスターは有効期限切れにより自動的にロックされます。	ManualLock
EngineVersion	string	クラスターのデータベースエンジンバージョン。	3.1.16
StorageResource	string	予約済みストレージリソースの量。AnalyticDB Compute Unit（ACU）は 1 コアおよび 4 GB のメモリに相当します。ストレージリソースはデータの読み取りおよび書き込みに使用されます。ストレージリソースを増加させることで、クラスターの読み取りおよび書き込みパフォーマンスを向上させることができます。	24ACU
DBClusterId	string	Enterprise Edition、Basic Edition、または Data Lakehouse Edition のクラスター ID。 Data Lakehouse Edition のクラスター ID。	amv-wz9509beptiz****
ConnectionString	string	クラスターの VPC エンドポイント。	amv-wz9509beptiz****.ads.aliyuncs.com
DBClusterType	string	クラスターのタイプ。デフォルト値は Common（通常のクラスター）です。	Common
CommodityCode	string	クラスターの商品コード。有効な値は以下のとおりです。 ads：従量課金。 ads_pre：サブスクリプション。	ads_pre
ExpireTime	string	クラスターの有効期限。サブスクリプションクラスターの場合、有効期限が返されます。従量課金クラスターの場合、このパラメーターは空になります。	2022-10-01T09:50:18Z
LockReason	string	クラスターがロックされた理由。説明このパラメーターは、クラスターがロックされている場合のみ返されます。値は固定で instance_expire です。	instance_expire
VPCId	string	仮想プライベートクラウド（VPC）ID。	vpc-bp13h7uzhulpu****
ComputeResource	string	予約済みコンピューティングリソースの量。AnalyticDB Compute Unit（ACU）は 1 コアおよび 4 GB のメモリに相当します。コンピューティングリソースはデータ計算に使用されます。コンピューティングリソースを増加させることで、クエリの実行速度を向上させることができます。これらのリソースは、クラスターの実際のパフォーマンスに基づいて弾力的にスケール可能です。	16ACU
RegionId	string	クラスターのリージョン ID。	cn-hangzhou
VSwitchId	string	vSwitch ID。	vsw-uf629gydd54ld****
DBVersion	string	AnalyticDB for MySQL クラスターのバージョン。サポートされているのは 5.0 のみです。	5.0
DBClusterStatus	string	クラスターのステータス。有効な値は以下のとおりです。 Preparing：クラスターの準備中。 Creating：クラスターの作成中。 Running：クラスターの実行中。 Deleting：クラスターの削除中。 Restoring：バックアップからの復元中。 ClassChanging：クラスター仕様の変更中。 NetAddressCreating：ネットワーク接続の作成中。 NetAddressDeleting：ネットワーク接続の削除中。 NetAddressModifying：ネットワーク接続の変更中。	Running
ResourceGroupId	string	リソースグループ ID。	rg-acfmyiu4ekp****
DBClusterNetworkType	string	クラスターのネットワークタイプ。サポートされているのは VPC のみです。	VPC
DBClusterDescription	string	クラスターの説明。	adb_test
UserENIStatus	boolean	弾力的ネットワークインターフェース（ENI）が有効かどうかを示します。有効な値は以下のとおりです。 true：有効。 false：無効。	false
ZoneId	string	クラスターのゾーン ID。	cn-hangzhou-h
Engine	string	クラスターのデータベースエンジン。値は固定で AnalyticDB です。	AnalyticDB
ReservedACU	string	クラスター内で割り当て可能な残りの予約済みコンピューティングリソースの量。AnalyticDB Compute Unit（ACU）は 1 コアおよび 4 GB のメモリに相当します。	24ACU
ComputeResourceTotal	string	クラスター内のコンピューティングリソースの合計量。AnalyticDB Compute Unit（ACU）は 1 コアおよび 4 GB のメモリに相当します。	48ACU
StorageResourceTotal	string	クラスター内のストレージリソースの合計量。AnalyticDB Compute Unit（ACU）は 1 コアおよび 4 GB のメモリに相当します。	24ACU
SupportedFeatures	object	このパラメーターは予約済みです。
	string	このパラメーターは予約済みです。	预留参数，不涉及。
ProductForm	string	このパラメーターは予約済みです。	预留参数，不涉及。
ReservedNodeSize	string	このパラメーターは予約済みです。	预留参数，不涉及。
ReservedNodeCount	integer	このパラメーターは予約済みです。	预留参数，不涉及。
ClickhouseEngineEnabled	boolean	ClickHouse 広域テーブルエンジンが有効かどうかを示します。 true：ClickHouse 広域テーブルエンジンが有効です。 false：ClickHouse 広域テーブルエンジンは無効です。列挙値: true : true false : false	true
AINodeNumber	integer
ProductVersion	string	クラスターのエディション。有効な値は以下のとおりです。 BasicVersion：Basic Edition。 EnterpriseVersion：Enterprise Edition。	BasicVersion
KmsId	string	ディスクデータを暗号化するために使用されるキーの ID。説明このパラメーターは、AnalyticDB for MySQL クラスターのディスク暗号化が有効な場合にのみ返されます。	e1935511-cf88-1123-a0f8-1be8d251****
TaskInfo	object	タスク情報。
Name	string	タスクの名前。	ScaleUpDBCluster
Status	string	タスクのステータス。有効な値は以下のとおりです。 NOT_RUN：タスクは実行待ちです。 RUNNING：タスクは実行中です。 SUCCEED：タスクは完了しました。	RUNNING
Progress	string	タスクの進捗率（パーセント）。	10
StepList	object
StepList	array<object>	タスクのステップ一覧。
	object	ステップの詳細情報。
StepName	string	ステップの名前。	PrepareResources
StepDesc	string	ステップの説明。	Prepare resources
StepStatus	string	ステップのステータス。有効な値は以下のとおりです。 NOT_RUN：ステップは実行待ちです。 RUNNING：ステップは実行中です。 SUCCEED：ステップは完了しました。	RUNNING
StepProgress	string	ステップの進捗率（パーセント）。	50
StartTime	string	ステップの開始時刻。フォーマットは YYYY-MM-DDThh:mm:ssZ です。	2024-03-10T09:28:34Z
EndTime	string	ステップの終了時刻。フォーマットは YYYY-MM-DDThh:mm:ssZ です。	2024-03-10T10:28:34Z
UserENIVpcId	string	ENI が属する VPC の ID。	vpc-rj9hnedlfm645uj******
UserENIVSwitchOptions	string	ENI の vSwitch をカンマ区切りで指定したリスト。	vsw-rj9ixufmywqq98z****,vsw-rj95ij6wcz656v7****
UserENIZoneOptions	string	ENI のゾーンをカンマ区切りで指定したリスト。	cn-hangzhou-k,cn-hangzhou-h
SecondaryZoneId	string
SecondaryVSwitchId	string
DiskEncryption	boolean
ClickhouseEngineCacheSize	integer	ClickHouse 広域テーブルエンジンのキャッシュサイズ（GB）。値が -1 の場合は、広域テーブルエンジンが無効であることを示します。それ以外の数値はディスクキャッシュのサイズを示します。	100
AINodeSpec	string

例

成功レスポンス

JSONJSON

{
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD",
  "Items": {
    "DBCluster": [
      {
        "CreationTime": "2022-07-01T09:50:18Z",
        "Expired": "false",
        "MaintainTime": "04:00Z-05:00Z",
        "PayType": "Prepaid",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": 3306,
        "LockMode": "ManualLock",
        "EngineVersion": "3.1.16",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-wz9509beptiz****",
        "ConnectionString": "amv-wz9509beptiz****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-10-01T09:50:18Z",
        "LockReason": "instance_expire",
        "VPCId": "vpc-bp13h7uzhulpu****",
        "ComputeResource": "16ACU",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-uf629gydd54ld****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "UserENIStatus": false,
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "24ACU",
        "ComputeResourceTotal": "48ACU",
        "StorageResourceTotal": "24ACU",
        "SupportedFeatures": {
          "key": "预留参数，不涉及。"
        },
        "ProductForm": "预留参数，不涉及。",
        "ReservedNodeSize": "预留参数，不涉及。",
        "ReservedNodeCount": 0,
        "ClickhouseEngineEnabled": true,
        "AINodeNumber": 0,
        "ProductVersion": "BasicVersion",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "TaskInfo": {
          "Name": "ScaleUpDBCluster",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "PrepareResources",
                "StepDesc": "Prepare resources",
                "StepStatus": "RUNNING",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "UserENIVpcId": "vpc-rj9hnedlfm645uj******",
        "UserENIVSwitchOptions": "vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******",
        "UserENIZoneOptions": "cn-hangzhou-k,cn-hangzhou-h",
        "SecondaryZoneId": "",
        "SecondaryVSwitchId": "",
        "DiskEncryption": false,
        "ClickhouseEngineCacheSize": 100,
        "AINodeSpec": ""
      }
    ]
  }
}

エラーコード

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

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

変更履歴

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