查詢指定云數(shù)據(jù)庫ClickHouse集群的信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個(gè)操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
clickhouse:DescribeDBClusterAttribute | READ |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。您可以通過調(diào)用 DescribeDBClusters 接口查詢目標(biāo)地域下所有的集群信息,包括集群 ID。 | cc-bp108z124a8o7**** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"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"
},
"VpcCloudInstanceId": "vpc-bp10tr8k9qasioaty****",
"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",
"VpcIpAddr": "192.168.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"
}
},
"RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,請確認(rèn) DBClusterId 值是否正確。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-12-08 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2023-03-23 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2022-02-24 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |