AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

DescribeDBClusterAttribute - 查询集群的详细属性

更新时间：
复制为 MD 格式
我的收藏

调用DescribeDBClusterAttribute接口查看目标AnalyticDB MySQL版集群的详细信息。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

adb:DescribeDBClusterAttribute

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

 无 无

请求参数

名称

类型

必填

描述

示例值
DBClusterId

string

是

AnalyticDB MySQL 数仓版集群 ID。

说明

您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 数仓版集群的集群 ID。

am-bp111m2cfrdl1****
RegionId

string

否

集群所在的地域 ID。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

列表详情。

RequestId

string

请求 ID。

2895BB82-B2C1-408E-AA73-DB8D59******
Items

object

DBCluster

array<object>

集群信息列表。

array<object>

列表详情。

CreationTime

string

集群创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2021-04-01T09:50:18Z
EnableSpark

boolean

是否创建了 Spark 集群。取值说明：

  • true：已创建。

  • false：未创建。

false
DtsJobId

string

DTS 同步任务 ID。仅 MySQL 分析实例会返回该参数。更多详情，请参见 MySQL 分析实例简介。

dtsb1hp3790****
DBNodeCount

integer

节点组个数。

1
Expired

string

集群是否过期。取值说明：

  • true：已过期。

  • false：未过期。

false
MaintainTime

string

集群的可维护时间段，格式为HH:mmZ- HH:mmZ，例如：04:00Z-05:00Z，表示可维护时间段为 4 点至 5 点。

说明

更多关于可维护时间段的信息，请参见设置可维护时间段。

04:00Z-05:00Z
PayType

string

集群付费类型，取值说明：

  • Postpaid：按量付费（即后付费）。

  • Prepaid：包年包月（即预付费）。

Postpaid
DiskType

string

集群的磁盘类型，取值说明：

  • local_ssd：本地磁盘。

  • cloud：普通云盘。

  • cloud_ssd：SSD 云盘。

  • cloud_efficiency：高效云盘。

  • cloud_essd0：PL0 等级的 ESSD 云盘。

  • cloud_essd：PL1 等级的 ESSD 云盘。

  • cloud_essd2：PL2 等级的 ESSD 云盘。

  • cloud_essd3：PL3 等级的 ESSD 云盘。

说明

更多关于 ESSD 云盘的详情，请参见 ESSD 云盘规格。

cloud_essd
Tags

object

Tag

array<object>

标签信息列表。

object

列表详情。

Key

string

标签键。

说明

您可以调用 TagResources 接口为目标集群创建标签。

tag1
Value

string

标签值。

test1
Mode

string

集群模式，取值说明：

  • flexible：弹性模式。

  • reserver：预留模式。

说明

更多关于集群模式的介绍，请参见产品系列。

flexible
Port

integer

集群端口号。

3306
LockMode

string

集群的锁定模式，取值说明：

  • Unlock：正常（即未锁定）。

  • ManualLock：手动触发锁定。

  • LockByExpiration：集群过期自动锁定。

  • LockByRestoration：集群回滚前自动锁定。

  • LockByDiskQuota：集群中空间满（即数据占用的存储空间已到达上限水位的 90%）自动锁定。

Unlock
EngineVersion

string

集群引擎版本。

3.1.1.9
EnableAirflow

boolean

是否创建了 Airflow 集群。取值说明：

  • true：已创建。

  • false：未创建。

true
ExecutorCount

string

弹性模式下集群使用的计算节点数量。

1
StorageResource

string

弹性模式用的存储资源规格，用于数据读写，增加该资源能提高集群读写能力。

8Core32GB
DBClusterId

string

AnalyticDB MySQL 数仓版集群 ID。

am-bp111m2cfrdl1****
ConnectionString

string

集群的 VPC 连接地址。

am-bp111m2cfrdl1****.ads.aliyuncs.com
RdsInstanceId

string

同步源 RDS 实例 ID。仅 MySQL 分析实例会返回该参数。更多详情，请参见 MySQL 分析实例简介。

rm-bp837jsdp2****
DBClusterType

string

集群类型。取值说明：

Common
CommodityCode

string

商品付费类型，取值说明：

  • ads：按量付费商品。

  • ads_pre：包年包月商品。

ads
ExpireTime

string

集群到期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间），例如2999-09-08T16:00:00Z。

说明

  • 若目标集群付费模式为包年包月，则返回实际到期时间。

  • 若目标集群付费模式为按量付费，则返回固定值2999-09-08T16:00:00Z。

2999-09-08T16:00:00Z
DBNodeStorage

integer

集群的存储空间，单位：GB。

300
DBNodeClass

string

节点规格。

E8
LockReason

string

集群锁定原因。

说明

仅当集群被锁定时会返回该参数，固定为instance_expire。

instance_expired
VPCId

string

专有网络（VPC）ID。

vpc-bp13h7uzhulpuxvnp****
ComputeResource

string

弹性模式下使用的计算资源规格，用于数据计算。增加计算资源能加快查询速度，可以根据集群实际性能按需弹性扩缩。

8Core32GB
RegionId

string

集群所在的地域 ID。

cn-hangzhou
ElasticIOResource

integer

弹性 IO 资源的数量。

2
VSwitchId

string

交换机 ID。

vsw-bp1syh8vvw8yech7n****
DBVersion

string

数据库版本，当前仅支持3.0版本。

3.0
VPCCloudInstanceId

string

VPC 实例 ID。

am-bp111m2cfrdl1****-controller
DBClusterStatus

string

集群状态。更多详情，请参见集群状态表。

Running
ResourceGroupId

string

资源组 ID。

rg-acfmyiu4ekp****
DBClusterNetworkType

string

集群网络类型。仅支持 VPC（专有网络）类型。

vpc
DBClusterDescription

string

集群的描述信息。

adb_test
UserENIStatus

boolean

是否已启用 ENI（Elastic Network Interface，弹性网卡）网络，取值说明：

  • true：已启用。

  • false：未启用。

true
ZoneId

string

集群所在的可用区 ID。

cn-hangzhou-h
Category

string

产品系列，取值说明：

  • BASIC：预留模式基础版

  • CLUSTER：预留模式集群版

  • MIXED_STORAGE：弹性模式集群版（新版）

说明

更多关于集群系列的介绍，请参见产品系列。

MIXED_STORAGE
Engine

string

集群引擎，固定为 AnalyticDB。

AnalyticDB
KmsId

string

用于加密云盘数据的密钥 ID。

说明

仅当 AnalyticDB MySQL 集群开启云盘加密时才会返回该参数。

e1935511-cf88-1123-a0f8-1be8d251****
InnerIp

string

公网 IP。

10.1.XX.XX
InnerPort

string

公网端口号。

3306
DiskPerformanceLevel

string

云盘等级。

PL1
ElasticIOResourceSize

string

弹性资源单节点规格。取值说明：

  • 8Core64GB：单节点规格为 8Core64GB 时，一组弹性 IO 资源的规格为 24Core192 GB。

  • 12Core96GB：单节点规格为 12Core96GB 时，一组弹性 IO 资源的规格为 36Core288 GB。

8Core64GB
DiskEncryption

boolean

是否开启云盘加密。取值：

  • true：是。

  • false：否。

false
TaskInfo

object

任务信息。

Name

string

任务名称。

analyticDBFlexibleScaleOut
Status

string

任务状态，取值为：

  • NOT_RUN：等待运行。

  • RUNNING：运行中。

  • SUCCEED：已结束。

RUNNING
Progress

string

任务进度，单位：%。

10
StepList

object

StepList

array<object>

任务步骤。

object

任务步骤。

StepName

string

步骤名称。

ApplyResource
StepDesc

string

步骤描述。

Apply resource
StepStatus

string

步骤状态，取值为：

  • NOT_RUN：等待运行。

  • RUNNING：运行中。

  • SUCCEED：已结束。

SUCCEED
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
ProductVersion

string

产品版本。取值为：

  • BasicVersion：基础版。

  • EnterpriseVersion：企业版。

BasicVersion
SecondaryZoneId

string

备可用区 ID。

说明

本参数和 ZoneId 参数传入的值不能相同。

cn-hangzhou-i
SecondaryVSwitchId

string

备虚拟交换机 ID。

说明

本参数和 VSwitchId 参数传入的值不能相同。

vsw-0jlxwqt4531fsb3jdzx6h
ReservedNodeSize

string

预留节点规格，单位为 ACU。

8ACU
ReservedNodeCount

integer

预留资源节点数。

3
ProductForm

string

产品形态枚举：

  • LegacyForm: 传统形态。

  • IntegrationForm：融合形态。

IntegrationForm

示例

正常返回示例

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",
        "SecondaryZoneId": "cn-hangzhou-i",
        "SecondaryVSwitchId": "vsw-0jlxwqt4531fsb3jdzx6h",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 3,
        "ProductForm": "IntegrationForm"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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

变更历史

更多信息，参考变更详情。

上一篇：DescribeDBClusterStatus - 查看集群的运行状态下一篇：DescribeAutoRenewAttribute - 查询包年包月集群自动续费状态