调用DescribeDBClusterAttribute接口查看目标AnalyticDB MySQL版集群的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
adb:DescribeDBClusterAttribute | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | AnalyticDB MySQL 数仓版集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 数仓版集群的集群 ID。
| am-bp111m2cfrdl1**** |
RegionId | string | 否 | 集群所在的地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON
格式
{
"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"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-28 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-04-01 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-03-05 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-12-01 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-11-30 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |