DescribeDBClusterAttribute を使用してクラスターの詳細をクエリ - ApsaraDB for ClickHouse - Alibaba Cloud - ApsaraDB for ClickHouse

特定の ApsaraDB for ClickHouse クラスターの詳細を取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

clickhouse:DescribeDBClusterAttribute

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。DescribeDBClusters 操作を呼び出して、リージョン内のすべてのクラスターの詳細 (ID を含む) を照会できます。	cc-bp108z124a8o7****

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
DBCluster	object	クラスターの詳細。
VpcId	string	VPC ID。	vpc-bp10tr8k9qasioaty****
SupportBackup	integer	クラスターがデータバックアップをサポートしているかどうか。有効値： `1`：サポートされています。 `2`：サポートされていません。	1
SupportOss	integer	クラスターがホットデータとコールドデータの階層化ストレージをサポートしているかどうか。有効値： `1`：サポートされています。 `2`：サポートされていません。	1
EncryptionType	string	暗号化タイプ。有効値： `CloudDisk`：ディスク暗号化。 `off`：暗号化は無効です。	CloudDisk
DBNodeCount	integer	クラスター内のノード数。単一レプリカの場合、値の範囲は 1～48 です。デュアルレプリカの場合、値の範囲は 1～24 です。	1
MaintainTime	string	クラスターのメンテナンスウィンドウ。時刻は `HH:mmZ-HH:mmZ` 形式で、協定世界時 (UTC) です。たとえば、`00:00Z-01:00Z` は、メンテナンスウィンドウが 00:00 から 01:00 (UTC) までであることを示します。これは北京時間 (UTC+8) の 08:00 から 09:00 に相当します。	00:00Z-01:00Z
CreateTime	string	クラスターの作成時刻。`yyyy-MM-ddTHH:mm:ssZ` 形式 (UTC) です。	2021-12-13T11:33:11Z
PayType	string	課金方法。有効値： `Postpaid`：従量課金。 `Prepaid`：サブスクリプション。	Prepaid
Tags	object	クラスターのタグ。
Tag	array<object>	タグのリスト。
	object	タグオブジェクト。
Key	string	タグのキー。	department
Value	string	タグの値。	it
PublicConnectionString	string	パブリックエンドポイント。	cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com
StorageType	string	ストレージタイプ。有効値： `CloudESSD`：ESSD PL1 ディスク。 `CloudESSD_PL2`：ESSD PL2 ディスク。 `CloudESSD_PL3`：ESSD PL3 ディスク。 `CloudEfficiency`：ウルトラディスク。	CloudESSD
Port	integer	HTTP ポート。	8123
LockMode	string	クラスターのロックモード。有効値： `Unlock`：クラスターはロックされていません。 `ManualLock`：クラスターは手動でロックされています。 `LockByExpiration`：クラスターは有効期限が切れると自動的にロックされます。 `LockByRestoration`：クラスターはロールバック前に自動的にロックされます。 `LockByDiskQuota`：ストレージがいっぱいのため、クラスターは自動的にロックされます。	Unlock
Bid	string	サイト ID。有効値： `26842`：中国サイト (aliyun.com)。 `26888`：国際サイト (alibabacloud.com)。	26842
EngineVersion	string	エンジンバージョン。	21.8.10.19
IsExpired	string	クラスターの有効期限が切れているかどうか。有効値： `true`：クラスターは期限切れです。 `false`：クラスターは期限切れではありません。	false
ScaleOutStatus	object	データ移行のステータス。
Progress	string	データ移行の進捗状況 (パーセンテージ)。説明このパラメーターは、クラスターが `SCALING_OUT` 状態の場合にのみ返されます。	0
Ratio	string	データ移行の進捗状況。「移行されたデータ量/合計データ量」として表示されます。説明このパラメーターは、クラスターが `SCALING_OUT` 状態の場合にのみ返されます。	0MB/60469MB
LbKind	string	ロードバランサーのタイプ。	clb
DBClusterId	string	クラスター ID。	cc-bp108z124a8o7****
ConnectionString	string	VPC エンドポイント。	cc-bp1qx68m06981****.ads.rds.aliyuncs.com
EncryptionKey	string	Key Management Service (KMS) のキー ID。説明 `EncryptionType` が `off` に設定されている場合、このパラメーターは空です。	685f416f-87c9-4554-8d3a-75b6ce25****
DBClusterType	string	クラスタータイプ。有効値： `Common`：標準クラスター。 `Readonly`：読み取り専用クラスター。 `Guard`：ディザスタリカバリクラスター。	Common
CommodityCode	string	商品コード。	clickhouse_go_public_cn
ExpireTime	string	クラスターの有効期限。`yyyy-MM-ddTHH:mm:ssZ` 形式 (UTC) です。説明このパラメーターは、従量課金クラスターの場合は空です。	2022-11-11T16:00:00Z
DBNodeStorage	integer	ノードあたりのストレージ容量 (GB)。値の範囲は 100～32000 です。説明値は 100 の倍数である必要があります。	100
DBNodeClass	string	クラスターノードのインスタンスタイプ。単一レプリカの有効値： `S4-NEW` `S8` `S16` `S32` `S64` `S104` デュアルレプリカの有効値： `C4-NEW` `C8` `C16` `C32` `C64` `C104`	C8
AliUid	string	Alibaba Cloud アカウント ID。	140692647406****
LockReason	string	クラスターがロックされた理由。説明 `LockMode` が `Unlock` に設定されている場合、このパラメーターは空です。	DISK_FULL
RegionId	string	リージョン ID。	cn-hangzhou
PublicPort	string	パブリック TCP ポート。	3306
VSwitchId	string	vSwitch ID。	vsw-bp1n874li1t5y57wi****
DBClusterStatus	string	クラスターのステータス。有効値： `Preparing`：クラスターは準備中です。 `Creating`：クラスターは作成中です。 `Running`：クラスターは実行中です。 `Deleting`：クラスターは削除中です。 `SCALING_OUT`：クラスターはスケールアウト中です。	Running
DBClusterNetworkType	string	ネットワークタイプ。VPC のみがサポートされています。	vpc
DBClusterDescription	string	クラスターの説明。	cc-bp108z124a8o7****
ZoneId	string	ゾーン ID。	cn-hangzhou-h
Category	string	クラスターのエディション。有効値： `Basic`：単一レプリカ。 `HighAvailability`：デュアルレプリカ。	HighAvailability
Engine	string	データベースエンジン。	ClickHouse
SupportMysqlPort	boolean	MySQL ポートがサポートされているかどうか。有効値： `true`：サポートされています。 `false`：サポートされていません。	false
SupportHttpsPort	boolean	HTTPS ポートがサポートされているかどうか。有効値： `true`：サポートされています。 `false`：サポートされていません。	false
ControlVersion	string	バックエンド管理システムのバージョン。有効値： `v1` `v2`	v1
PublicIpAddr	string	パブリックエンドポイントの IP アドレス。	121.40.xx.xx
EngineMinorVersion	string	エンジンの現在のマイナーバージョン。	1.6.0
EngineLatestMinorVersion	string	クラスターをアップグレードできる最新のマイナーバージョン。	1.34.0
MaintainAutoType	boolean	アップグレード方法。値が `false` の場合、手動でアップグレードを実行する必要があることを示します。	false
ExtStorageType	string	拡張ストレージタイプ。有効値： `CloudESSD`：ESSD PL1 ディスク。 `CloudESSD_PL2`：ESSD PL2 ディスク。 `CloudESSD_PL3`：ESSD PL3 ディスク。 `CloudEfficiency`：ウルトラディスク。	CloudESSD
ExtStorageSize	integer	拡張ストレージ容量 (GB)。	500
ResourceGroupId	string	リソースグループ ID。	rg-acfmyf65je6****
ZookeeperClass	string	ZooKeeper ノードの仕様。	4 Core 8 GB
AppointmentRestartTime	string	スケジュールされた再起動時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式で、協定世界時 (UTC) です。	2023-11-06T12:00:00Z
ZoneIdVswitchMap	object	マルチゾーンクラスターのゾーン ID と vSwitch ID のマップ。	cn-shanghai-f: vsw-zm0n42d5vvuo****
AvailableUpgradeMajorVersion	object	クラスターをアップグレードできる利用可能なメジャーバージョンとその最新のマイナーバージョン。	{"MajorVersion":"MinorVersion"}
AppointmentRestartNodeTime	string	特定のノードを再起動するスケジュール時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式で、協定世界時 (UTC) です。	2023-11-06T12:00:00Z
AppointmentRestartNodeList	string	再起動がスケジュールされているノードのリスト。	ck-k1a976p3n******--clickhouse-s-0-r-0,ck-k1a976p3n****-**-clickhouse-s-0-r-1
AppointmentElectZookeeperTime	string	プライマリ/セカンダリスイッチオーバーのスケジュール時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式で、協定世界時 (UTC) です。	2023-11-06T12:00:00Z
AppointmentElectZookeeperDisableWrite	boolean	プライマリ/セカンダリスイッチオーバー中に書き込み操作を停止するかどうかを指定します。有効値： `true`：スイッチオーバー中、インスタンスへの書き込み操作は停止されます。 `false`：スイッチオーバー中、インスタンスへの書き込み操作は停止されません。	true
VpcIpAddr	string	VPC エンドポイントの IP アドレス。	192.168.xx.xx
VpcCloudInstanceId	string	VPC ID。	vpc-bp10tr8k9qasioaty****
WebUIStatus	string		active
WebUISnatStatus	string		active
RequestId	string	リクエスト ID。	05321590-BB65-4720-8CB6-8218E041CDD0

例

成功レスポンス

JSONJSON

{
  "DBCluster": {
    "VpcId": "vpc-bp10tr8k9qasioaty****",
    "SupportBackup": 1,
    "SupportOss": 1,
    "EncryptionType": "CloudDisk",
    "DBNodeCount": 1,
    "MaintainTime": "00:00Z-01:00Z",
    "CreateTime": "2021-12-13T11:33:11Z",
    "PayType": "Prepaid",
    "Tags": {
      "Tag": [
        {
          "Key": "department",
          "Value": "it"
        }
      ]
    },
    "PublicConnectionString": "cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com",
    "StorageType": "CloudESSD",
    "Port": 8123,
    "LockMode": "Unlock",
    "Bid": "26842",
    "EngineVersion": "21.8.10.19",
    "IsExpired": "false",
    "ScaleOutStatus": {
      "Progress": "0",
      "Ratio": "0MB/60469MB"
    },
    "LbKind": "clb",
    "DBClusterId": "cc-bp108z124a8o7****",
    "ConnectionString": "cc-bp1qx68m06981****.ads.rds.aliyuncs.com",
    "EncryptionKey": "685f416f-87c9-4554-8d3a-75b6ce25****",
    "DBClusterType": "Common",
    "CommodityCode": "clickhouse_go_public_cn",
    "ExpireTime": "2022-11-11T16:00:00Z",
    "DBNodeStorage": 100,
    "DBNodeClass": "C8",
    "AliUid": "140692647406****",
    "LockReason": "DISK_FULL",
    "RegionId": "cn-hangzhou",
    "PublicPort": "3306",
    "VSwitchId": "vsw-bp1n874li1t5y57wi****",
    "DBClusterStatus": "Running",
    "DBClusterNetworkType": "vpc",
    "DBClusterDescription": "cc-bp108z124a8o7****",
    "ZoneId": "cn-hangzhou-h",
    "Category": "HighAvailability",
    "Engine": "ClickHouse",
    "SupportMysqlPort": false,
    "SupportHttpsPort": false,
    "ControlVersion": "v1",
    "PublicIpAddr": "121.40.xx.xx",
    "EngineMinorVersion": "1.6.0",
    "EngineLatestMinorVersion": "1.34.0",
    "MaintainAutoType": false,
    "ExtStorageType": "CloudESSD",
    "ExtStorageSize": 500,
    "ResourceGroupId": "rg-acfmyf65je6****",
    "ZookeeperClass": "4 Core 8 GB",
    "AppointmentRestartTime": "2023-11-06T12:00:00Z",
    "ZoneIdVswitchMap": {
      "test": "test",
      "test2": 1
    },
    "AvailableUpgradeMajorVersion": {
      "MajorVersion": "MinorVersion"
    },
    "AppointmentRestartNodeTime": "2023-11-06T12:00:00Z",
    "AppointmentRestartNodeList": "ck-k1a976p3n********-****-clickhouse-s-0-r-0,ck-k1a976p3n********-****-clickhouse-s-0-r-1",
    "AppointmentElectZookeeperTime": "2023-11-06T12:00:00Z",
    "AppointmentElectZookeeperDisableWrite": true,
    "VpcIpAddr": "192.168.xx.xx",
    "VpcCloudInstanceId": "vpc-bp10tr8k9qasioaty****",
    "WebUIStatus": "active",
    "WebUISnatStatus": "active"
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}

エラーコード

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

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

変更履歴

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