使用DescribeDBClusterAttribute查询集群详细信息-云原生数据仓库AnalyticDB-阿里云

查看指定集群的详细信息。

接口说明

当前服务的接入地址请参见服务接入点。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeDBClusterAttribute	get	*DBClusterLakeVersion `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	企业版、基础版或湖仓版的集群 ID。说明调用 DescribeDBClusters 接口可以查询集群 ID。	amv-wz9509beptiz****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	A5C433C2-001F-58E3-99F5-3274C14DF8BD
Items	array<object>	企业版、基础版集群信息列表。
DBCluster	object	集群详情。
CreationTime	string	集群创建时间。UTC 时间，格式为`yyyy-MM-ddThh:mm:ssZ`。	2022-07-01T09:50:18Z
Expired	string	包年包月集群是否过期。取值说明： true：已过期。 false：未过期。说明如果集群已过期，在一定时间内集群会被锁定甚至释放。建议您进行续费操作，详情请参见续费说明。按量付费集群不返回此参数。	false
MaintainTime	string	集群的可维护时间。UTC 时间，格式为`HH:mmZ-HH:mmZ`。说明更多关于可维护时间段的信息，请参见设置可维护时间段。	04:00Z-05:00Z
PayType	string	集群付费类型，取值说明： Postpaid：按量付费。 Prepaid：包年包月。	Prepaid
Tags	array<object>	标签列表。
Tag	object
Key	string	标签键。说明您可以调用 TagResources 接口为目标集群创建标签。	tag1
Value	string	标签值。	test1
Mode	string	集群模式。默认返回 flexible，表示弹性模式集群。	flexible
Port	integer	集群端口号。	3306
LockMode	string	集群的锁定模式，取值说明： Unlock：未锁定。 ManualLock：手动触发锁定。 LockByExpiration：集群到期自动锁定。	ManualLock
EngineVersion	string	集群引擎版本。	3.1.16
StorageResource	string	存储预留资源规格。1 ACU 约等于 1 核 4 GB。存储资源用于数据读写，增加该资源能提高集群读写能力。	24ACU
DBClusterId	string	企业版、基础版或湖仓版的集群 ID。 <props="intl">湖仓版集群 ID。</prop	amv-wz9509beptiz****
ConnectionString	string	集群的公网连接地址。	amv-wz9509beptiz****.ads.aliyuncs.com
DBClusterType	string	集群类型。默认返回 Common，表示常规集群。	Common
CommodityCode	string	商品付费类型，取值说明： ads：按量付费商品。 ads_pre：包年包月商品。	ads_pre
ExpireTime	string	集群到期时间。若集群付费类型为包年包月，则返回实际到期时间。若集群付费类型为按量付费，则返回为空。	2022-10-01T09:50:18Z
LockReason	string	集群锁定原因。说明仅当集群被锁定时会返回该参数，固定为instance_expire。	instance_expire
VPCId	string	专有网络（VPC）ID。	vpc-bp13h7uzhulpu****
ComputeResource	string	计算预留资源规格。1 ACU 约等于 1 核 4 GB。计算资源用于数据计算，增加计算资源能加快查询速度，可以根据集群实际性能按需弹性扩缩。	16ACU
RegionId	string	集群所在的地域 ID。	cn-hangzhou
VSwitchId	string	交换机 ID。	vsw-uf629gydd54ld****
DBVersion	string	AnalyticDB MySQL 集群的版本，当前仅支持5.0版本。	5.0
DBClusterStatus	string	集群状态。取值说明： Preparing：准备中 Creating：创建中 Running：运行中 Deleting：删除中 Restoring：备份恢复中 ClassChanging：变配中 NetAddressCreating：创建网络中 NetAddressDeleting：删除网络中 NetAddressModifying：修改网络中	Running
ResourceGroupId	string	资源组 ID。	rg-acfmyiu4ekp****
DBClusterNetworkType	string	集群网络类型。仅支持 VPC（专有网络）类型。	VPC
DBClusterDescription	string	集群的描述信息。	adb_test
UserENIStatus	boolean	是否已启用 ENI（Elastic Network Interface，弹性网卡）网络，取值说明： true：已启用。 false：未启用。	false
ZoneId	string	集群所在的可用区 ID。	cn-hangzhou-h
Engine	string	集群引擎，固定为 AnalyticDB。	AnalyticDB
ReservedACU	string	集群剩余可分配计算预留资源。1 ACU 约等于 1 核 4 GB。	24ACU
ComputeResourceTotal	string	集群计算总资源量。1 ACU 约等于 1 核 4 GB。	48ACU
StorageResourceTotal	string	集群存储总资源量。1 ACU 约等于 1 核 4 GB。	24ACU
SupportedFeatures	object	预留参数，不涉及。
	string	预留参数，不涉及。	预留参数，不涉及。
ProductForm	string	预留参数，不涉及。	预留参数，不涉及。
ReservedNodeSize	string	预留参数，不涉及。	预留参数，不涉及。
ReservedNodeCount	integer	预留参数，不涉及。	预留参数，不涉及。
ClickhouseEngineEnabled	boolean	ClickHouse 宽表引擎是否开启。 true: 已开启 Clickhouse 宽表引擎。 false: 未开启 Clickhouse 宽表引擎。	true
ProductVersion	string	产品版本。取值为： BasicVersion：基础版。 EnterpriseVersion：企业版。	BasicVersion
KmsId	string	用于加密云盘数据的密钥 ID。说明仅当 AnalyticDB MySQL 集群开启云盘加密时才会返回该参数。	e1935511-cf88-1123-a0f8-1be8d251****
TaskInfo	object	任务信息。
Name	string	任务名称。	ScaleUpDBCluster
Status	string	任务状态，取值为： NOT_RUN：等待运行。 RUNNING：运行中。 SUCCEED：已结束。	RUNNING
Progress	string	任务进度，单位：%。	10
StepList	array<object>	任务步骤。
StepList	object	任务步骤。
StepName	string	步骤名称。	PrepareResources
StepDesc	string	步骤描述。	Prepare resources
StepStatus	string	步骤状态，取值为： NOT_RUN：等待运行。 RUNNING：运行中。 SUCCEED：已结束。	RUNNING
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
UserENIVpcId	string	ENI 的 VPC 信息。	vpc-rj9hnedlfm645uj******
UserENIVSwitchOptions	string	ENI 交换机列表。多个交换机中间用英文逗号（,）分隔。	vsw-rj9ixufmywqq98z****,vsw-rj95ij6wcz656v7****
UserENIZoneOptions	string	ENI 可用区信息。多个可用区之间用英文逗号（,）分隔。	cn-hangzhou-k,cn-hangzhou-h
ClickhouseEngineCacheSize	integer	ClickHouse 宽表引擎的缓存大小，单位：GB。若返回-1，则表示未开启宽表引擎。若返回具体数字，则表示云盘缓存空间大小。	100

示例

正常返回示例

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,
        "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,
        "AINodeNumber": 0,
        "ProductVersion": "BasicVersion",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "TaskInfo": {
          "Name": "ScaleUpDBCluster",
          "Status": "RUNNING",
          "Progress": 10,
          "StepList": {
            "StepList": [
              {
                "StepName": "PrepareResources",
                "StepDesc": "Prepare resources",
                "StepStatus": "RUNNING",
                "StepProgress": 50,
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "UserENIVpcId": "vpc-rj9hnedlfm645uj******",
        "UserENIVSwitchOptions": "vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******",
        "UserENIZoneOptions": "cn-hangzhou-k,cn-hangzhou-h",
        "SecondaryZoneId": "",
        "SecondaryVSwitchId": "",
        "DiskEncryption": true,
        "ClickhouseEngineCacheSize": 100,
        "AINodeSpec": ""
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-25	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
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 返回结构发生变更	查看变更详情