查看指定集群的详细信息。
接口说明
当前服务的接入地址请参见服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
adb:DescribeDBClusterAttribute | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 企业版、基础版或湖仓版的集群 ID。 说明
调用 DescribeDBClusters 接口可以查询集群 ID。
| amv-wz9509beptiz**** |
返回参数
示例
正常返回示例
JSON
格式
{
"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,
"ClickhouseEngineCacheSize": 100,
"ProductVersion": "BasicVersion",
"KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
"TaskInfo": {
"Name": "",
"Status": "",
"Progress": "",
"StepList": {
"StepList": [
{
"StepName": "",
"StepDesc": "",
"StepStatus": "",
"StepProgress": "",
"StartTime": "",
"EndTime": ""
}
]
}
}
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-13 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-28 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-23 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-09 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-09-26 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-07-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-09-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |