DescribeDBClusterAttribute API によるクラスター属性の表示 - AnalyticDB

この操作を使用すると、指定した 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:DescribeDBClusterAttribute

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-bp111m2cfrdl1****
RegionId	string	任意	クラスターのリージョン ID。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	応答の詳細情報。
RequestId	string	リクエスト ID。	2895BB82-B2C1-408E-AA73-DB8D59******
Items	object
DBCluster	array<object>	クラスター情報のリスト。
	array<object>	クラスターの詳細情報。
CreationTime	string	クラスターの作成時刻。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。時刻は協定世界時 (UTC) で表示されます。	2021-04-01T09:50:18Z
EnableSpark	boolean	Spark クラスターが作成されているかどうかを示します。有効な値は以下のとおりです。 true: Spark クラスターが作成されています。 false: Spark クラスターは作成されていません。	false
DtsJobId	string	DTS 同期タスクの ID。このパラメーターは、分析インスタンス for MySQL の場合のみ返されます。	dtsb1hp3790****
DBNodeCount	integer	ノードグループ数。	1
Expired	string	クラスターが期限切れかどうかを示します。有効な値は以下のとおりです。 true: クラスターは期限切れです。 false: クラスターは期限切れではありません。	false
MaintainTime	string	クラスターのメンテナンスウィンドウ。フォーマットは HH:mmZ-HH:mmZ です。たとえば、04:00Z-05:00Z はメンテナンスウィンドウが 04:00 から 05:00 までであることを意味します。説明メンテナンスウィンドウの詳細については、「メンテナンスウィンドウの設定」をご参照ください。	04:00Z-05:00Z
PayType	string	クラスターの課金方法。有効な値は以下のとおりです。 Postpaid: 従量課金。 Prepaid: サブスクリプション。	Postpaid
DiskType	string	クラスターのディスクタイプ。有効な値は以下のとおりです。 local_ssd: ローカル SSD。 cloud: 基本ディスク。 cloud_ssd: 標準 SSD。 cloud_efficiency: Ultra ディスク。 cloud_essd0: ESSD PL0。 cloud_essd: ESSD PL1。 cloud_essd2: ESSD PL2。 cloud_essd3: ESSD PL3。説明 ESSD の詳細については、「ESSD」をご参照ください。	cloud_essd
Tags	object
Tag	array<object>	タグ情報のリスト。
	object	タグの詳細情報。
Key	string	タグキー。説明クラスターにタグを作成するには、「TagResources」操作を呼び出します。	tag1
Value	string	タグ値。	test1
Mode	string	クラスターのモード。有効な値は以下のとおりです。 flexible: フレキシブルモード。 reserver: 予約モード。説明クラスターモードの詳細については、「エディション」をご参照ください。	flexible
Port	integer	クラスターのポート番号。	3306
LockMode	string	クラスターのロックモード。有効な値は以下のとおりです。 Unlock: クラスターはロックされていません。 ManualLock: クラスターは手動でロックされています。 LockByExpiration: クラスターは有効期限切れ後に自動的にロックされます。 LockByRestoration: クラスターはロールバック前に自動的にロックされます。 LockByDiskQuota: ストレージ容量が満杯になったため、クラスターが自動的にロックされます（データストレージ使用量が総ストレージの 90 % に達した場合）。	Unlock
EngineVersion	string	クラスターのデータベースエンジンバージョン。	3.1.1.9
EnableAirflow	boolean	Airflow クラスターが作成されているかどうかを示します。有効な値は以下のとおりです。 true: Airflow クラスターが作成されています。 false: Airflow クラスターは作成されていません。	true
ExecutorCount	string	フレキシブルモードのクラスターで使用される計算ノード数。	1
StorageResource	string	フレキシブルモードのクラスターで使用されるストレージリソースの仕様。これらのリソースはデータの読み取りおよび書き込みに使用されます。ストレージリソースを増加させることで、クラスターの読み書き性能を向上させることができます。	8Core32GB
DBClusterId	string	AnalyticDB for MySQL Data Warehouse Edition (V3.0) クラスターの ID。	am-bp111m2cfrdl1****
ConnectionString	string	クラスターの VPC エンドポイント。	am-bp111m2cfrdl1****.ads.aliyuncs.com
RdsInstanceId	string	ソース RDS インスタンスの ID。このパラメーターは、分析インスタンス for MySQL の場合のみ返されます。	rm-bp837jsdp2****
DBClusterType	string	クラスターのタイプ。有効な値は以下のとおりです。 Common: 通常のクラスター。 RDS_ANALYSIS: 分析インスタンス for MySQL。	Common
CommodityCode	string	プロダクトの課金方法。有効な値は以下のとおりです。 ads: 従量課金 ads_pre: サブスクリプション	ads
ExpireTime	string	クラスターの有効期限。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。時刻は協定世界時 (UTC) で表示されます。例： 2999-09-08T16:00:00Z。説明クラスターがサブスクリプションクラスターの場合、実際の有効期限が返されます。クラスターが従量課金クラスターの場合、固定値 2999-09-08T16:00:00Z が返されます。	2999-09-08T16:00:00Z
DBNodeStorage	integer	クラスターのストレージ容量。単位：GB。	300
DBNodeClass	string	ノードスペック。	E8
LockReason	string	クラスターがロックされた理由。説明このパラメーターは、クラスターがロックされている場合にのみ返されます。値は常に instance_expire です。	instance_expired
VPCId	string	仮想プライベートクラウド (VPC) の ID。	vpc-bp13h7uzhulpuxvnp****
ComputeResource	string	フレキシブルモードのクラスターで使用されるコンピューティングリソースの仕様。これらのリソースはデータ処理に使用されます。コンピューティングリソースを増加させることでクエリを高速化できます。クラスターの実際のパフォーマンスに基づいて、リソースをスケールできます。	8Core32GB
RegionId	string	クラスターのリージョン ID。	cn-hangzhou
ElasticIOResource	integer	弾力的 I/O リソースの数。	2
VSwitchId	string	vSwitch の ID。	vsw-bp1syh8vvw8yech7n****
DBVersion	string	データベースバージョン。サポートされるのは 3.0 のみです。	3.0
VPCCloudInstanceId	string	VPC インスタンス ID。	am-bp111m2cfrdl1****-controller
DBClusterStatus	string	クラスターのステータス。詳細については、「クラスターの状態」をご参照ください。	Running
ResourceGroupId	string	リソースグループ ID。	rg-acfmyiu4ekp****
DBClusterNetworkType	string	クラスターのネットワークタイプ。サポートされるのは VPC のみです。	vpc
DBClusterDescription	string	クラスターの説明。	adb_test
UserENIStatus	boolean	弾力的ネットワークインターフェイス (ENI) が有効かどうかを示します。有効な値は以下のとおりです。 true: 有効。 false: 無効。	true
ZoneId	string	クラスターのゾーン ID。	cn-hangzhou-h
Category	string	クラスターのエディション。有効な値は以下のとおりです。 BASIC: 予約モード向け Basic Edition CLUSTER: 予約モード向け Cluster Edition MIXED_STORAGE: フレキシブルモード向け Cluster Edition（新規）説明クラスターエディションの詳細については、「エディション」をご参照ください。	MIXED_STORAGE
Engine	string	クラスターのデータベースエンジン。値は固定で AnalyticDB です。	AnalyticDB
KmsId	string	ディスクデータを暗号化するために使用されるキーの ID。説明このパラメーターは、AnalyticDB for MySQL クラスターでディスク暗号化が有効になっている場合にのみ返されます。	e1935511-cf88-1123-a0f8-1be8d251****
InnerIp	string	パブリック IP アドレス。	10.1.XX.XX
InnerPort	string	パブリックポート番号。	3306
DiskPerformanceLevel	string	ディスクのパフォーマンスレベル。	PL1
ElasticIOResourceSize	string	単一の弾力的リソースノードの仕様。有効な値は以下のとおりです。 8Core64GB: 単一ノードの仕様が 8 コア 64 GB の場合、弾力的 I/O リソースグループの仕様は 24 コア 192 GB になります。 12Core96GB: 単一ノードの仕様が 12 コア 96 GB の場合、弾力的 I/O リソースグループの仕様は 36 コア 288 GB になります。	8Core64GB
DiskEncryption	boolean	ディスク暗号化が有効かどうかを示します。有効な値は以下のとおりです。 true: 有効。 false: 無効。	false
TaskInfo	object	タスク情報。
Name	string	タスク名。	analyticDBFlexibleScaleOut
Status	string	タスクステータス。有効な値は以下のとおりです。 NOT_RUN: 保留中。 RUNNING: 実行中。 SUCCEED: 成功。	RUNNING
Progress	string	タスクの進捗率。単位：%。	10
StepList	object
StepList	array<object>	タスクステップ。
	object	タスクステップ。
StepName	string	ステップ名。	ApplyResource
StepDesc	string	ステップの説明。	Apply resource
StepStatus	string	ステップステータス。有効な値は以下のとおりです。 NOT_RUN: 保留中。 RUNNING: 実行中。 SUCCEED: 成功。	SUCCEED
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
ProductVersion	string	プロダクトバージョン。有効な値は以下のとおりです。 BasicVersion: Basic Edition。 EnterpriseVersion: Enterprise Edition。	BasicVersion
SecondaryZoneId	string	セカンダリゾーンの ID。説明このパラメーターの値は、ZoneId パラメーターの値と同じであってはなりません。	cn-hangzhou-i
SecondaryVSwitchId	string	セカンダリ vSwitch の ID。説明このパラメーターの値は、VSwitchId パラメーターの値と同じであってはなりません。	vsw-0jlxwqt4531fsb3jdzx6h
ReservedNodeSize	string	予約ノードの仕様。単位：AnalyticDB Compute Unit (ACU)。	8ACU
ReservedNodeCount	integer	予約リソースノードの数。	3
ProductForm	string	プロダクトフォーム。有効な値は以下のとおりです。 LegacyForm: 従来のフォーム。 IntegrationForm: 統合フォーム。	IntegrationForm

例

成功レスポンス

JSONJSON

{
  "RequestId": "2895BB82-B2C1-408E-AA73-DB8D59******",
  "Items": {
    "DBCluster": [
      {
        "CreationTime": "2021-04-01T09:50:18Z",
        "EnableSpark": false,
        "DtsJobId": "dtsb1hp3790****",
        "DBNodeCount": 1,
        "Expired": "false",
        "MaintainTime": "04:00Z-05:00Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": 3306,
        "LockMode": "Unlock",
        "EngineVersion": "3.1.1.9",
        "EnableAirflow": true,
        "ExecutorCount": "1",
        "StorageResource": "8Core32GB",
        "DBClusterId": "am-bp111m2cfrdl1****",
        "ConnectionString": "am-bp111m2cfrdl1****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp837jsdp2****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "ComputeResource": "8Core32GB",
        "RegionId": "cn-hangzhou",
        "ElasticIOResource": 2,
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp111m2cfrdl1****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "UserENIStatus": true,
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "InnerIp": "10.1.XX.XX",
        "InnerPort": "3306",
        "DiskPerformanceLevel": "PL1",
        "ElasticIOResourceSize": "8Core64GB",
        "DiskEncryption": false,
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductVersion": "BasicVersion",
        "SecondaryZoneId": "cn-hangzhou-i",
        "SecondaryVSwitchId": "vsw-0jlxwqt4531fsb3jdzx6h",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 3,
        "ProductForm": "IntegrationForm"
      }
    ]
  }
}

エラーコード

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

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

変更履歴

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