文档

DescribeDBClusters - 查询实例列表

更新时间:

查询AnalyticDB MySQL实例列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeDBClustersRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看可用地域的地域 ID。
cn-hangzhou
DBClusterIdsstring

集群 ID。

说明 您可以输入上述地域中任意的集群 ID。
am-bp1r053byu48p****
DBClusterDescriptionstring

集群描述。

  • 不能以http://或者https://开头。
  • 长度为 2~256 个字符。
test
DBClusterStatusstring

集群状态,取值说明:

  • Preparing:准备中
  • Creating:创建中
  • Restoring:备份恢复中
  • Running:运行中
  • Deleting:删除中
  • ClassChanging:变配中
  • NetAddressCreating:创建网络中
  • NetAddressDeleting:删除网络中
Running
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

页码,取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1

1
ResourceGroupIdstring

资源组 ID。

rg-4690g37929XXXX
Tagobject []

标签信息列表。

Keystring

标签键,可以根据标签过滤集群列表。最多 20 对标签,各个标签对的数字 n 必须不同,且必须是从 1 开始的连续整数。Tag.N.Key对应的值为Tag.N.Value

说明 最多支持 64 个字符,不能以aliyunacs:http://或者https://开头。
tag1
Valuestring

标签值,可以根据标签过滤集群列表。最多 20 对标签,各个标签对的数字 n 必须不同,且必须是从 1 开始的连续整数。Tag.N.Key对应的值为Tag.N.Value

说明 最多支持 64 个字符,不能以aliyunacs:http://或者https://开头。
test1
DBVersionstring

集群版本,固定取值为3.0

3.0

返回参数

名称类型描述示例值
object

列表详情。

TotalCountinteger

总记录数。

1
PageSizeinteger

每页记录数。

30
RequestIdstring

请求 ID。

D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumberinteger

页码。

1
Itemsobject []

集群信息列表。

DtsJobIdstring

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

dtsb1578j90XXXX
DBNodeCountlong

节点组个数。

1
Expiredstring

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

  • true:已过期。
  • false:未过期。
false
CreateTimestring

集群创建时间,UTC 时间,格式为yyyy-MM-ddTHH:mm:ssZ,例如2021-04-01T09:50:18Z

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

集群付费类型,取值说明:

  • Postpaid:按量付费(即后付费)。
  • Prepaid:包年包月(即预付费)。
Postpaid
DiskTypestring

集群的磁盘类型,取值说明:

  • 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
Tagsobject []

标签信息列表。

Keystring

标签键。

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

标签值。

test1
Modestring

集群模式,取值说明:

  • flexible:弹性模式。
  • reserver:预留模式。
说明
  • 更多关于集群模式的介绍,请参见产品系列
  • flexible
    Portstring

    集群端口号,默认为 3306。

    3306
    LockModestring

    集群的锁定模式,取值说明:

    • Unlock:正常(即未锁定)。
    • ManualLock:手动触发锁定。
    • LockByExpiration:集群过期自动锁定。
    • LockByRestoration:集群回滚前自动锁定。
    • LockByDiskQuota:集群中空间满(即数据占用的存储空间已到达上限水位的 90%)自动锁定。
    Unlock
    StorageResourcestring

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

    8Core32GB
    ExecutorCountstring

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

    1
    DBClusterIdstring

    集群 ID。

    am-bp163885f8q21****
    ConnectionStringstring

    集群的公网连接地址。

    am-bp163885f8q21****.ads.aliyuncs.com
    RdsInstanceIdstring

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

    rm-bp11q28kvl688****
    DBClusterTypestring

    集群类型,取值说明:

    Common
    CommodityCodestring

    商品 code,固定为 ads

    ads
    ExpireTimestring

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

    说明
  • 若目标集群付费模式为包年包月,则返回实际到期时间。
  • 若目标集群付费模式为按量付费,则返回固定值2999-09-08T16:00:00Z
  • 2999-09-08T16:00:00Z
    DBNodeStoragelong

    集群的存储空间,单位:GB。

    300
    DBNodeClassstring

    节点规格。

    E8
    LockReasonstring

    集群锁定原因。

    说明 仅当集群被锁定时会返回该参数,固定为instance_expire
    instance_expired
    VPCIdstring

    专有网络(VPC)ID。

    vpc-bp13h7uzhulpuxvnpXXXX
    RegionIdstring

    集群所在的地域 ID。

    cn-hangzhou
    ComputeResourcestring

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

    8Core32GB
    ElasticIOResourceinteger

    弹性 IO 资源(Elastic IO Unit,简称 EIU),更多详情,请参见 EIU 详解

    说明 仅弹性模式集群会返回该参数。
    0
    VSwitchIdstring

    交换机 ID。

    vsw-bp1syh8vvw8yech7nXXXX
    DBVersionstring

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

    3.0
    VPCCloudInstanceIdstring

    VPC 实例 ID。

    am-bp163885f8q21****-controller
    DBClusterStatusstring

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

    Running
    ResourceGroupIdstring

    资源组 ID。

    rg-acfmyiu4ekp****
    DBClusterNetworkTypestring

    集群网络类型。仅支持 VPC(专有网络)类型。

    vpc
    DBClusterDescriptionstring

    集群的描述信息。

    adb_test
    ZoneIdstring

    集群所在的可用区 ID。

    cn-hangzhou-h
    Categorystring

    产品系列,取值说明:

    • BASIC:预留模式基础版
    • CLUSTER:预留模式集群版
    • MIXED_STORAGE:弹性模式集群版(新版)
    说明 更多关于集群系列的介绍,请参见产品系列
    MIXED_STORAGE
    Enginestring

    集群引擎,固定为 AnalyticDB

    AnalyticDB
    InnerIpstring

    公网 IP。

    10.1.xx.xx
    InnerPortstring

    端口号。

    3306
    TaskInfoobject

    任务进度信息。

    Namestring

    任务名称。

    analyticDBFlexibleScaleOut
    Statusstring

    任务状态,取值为:

    • NOT_RUN:等待运行。
    • RUNNING:运行中。
    • SUCCEED:已结束。
    RUNNING
    Progressstring

    任务进度,单位:%。

    10
    StepListobject []

    任务步骤。

    StepNamestring

    步骤名称。

    ApplyResource
    StepDescstring

    步骤描述。

    Apply resource
    StepStatusstring

    步骤状态,取值为:

    • NOT_RUN:等待运行。
    • RUNNING:运行中。
    • SUCCEED:已结束。
    SUCCEED
    StepProgressstring

    步骤进度,单位:%。

    50
    StartTimestring

    步骤开始时间,格式为 YYYY-MM-DDThh:mm:ssZ。

    2024-03-10T09:28:34Z
    EndTimestring

    步骤结束时间,格式为 YYYY-MM-DDThh:mm:ssZ。

    2024-03-10T10:28:34Z

    示例

    正常返回示例

    JSON格式

    {
      "TotalCount": 1,
      "PageSize": 30,
      "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
      "PageNumber": 1,
      "Items": {
        "DBCluster": [
          {
            "DtsJobId": "dtsb1578j90XXXX",
            "DBNodeCount": 1,
            "Expired": "false",
            "CreateTime": "2021-04-01T09:50:18Z",
            "PayType": "Postpaid",
            "DiskType": "cloud_essd",
            "Tags": {
              "Tag": [
                {
                  "Key": "tag1",
                  "Value": "test1"
                }
              ]
            },
            "Mode": "flexible",
            "Port": "3306",
            "LockMode": "Unlock",
            "StorageResource": "8Core32GB",
            "ExecutorCount": "1",
            "DBClusterId": "am-bp163885f8q21****",
            "ConnectionString": "am-bp163885f8q21****.ads.aliyuncs.com",
            "RdsInstanceId": "rm-bp11q28kvl688****",
            "DBClusterType": "Common",
            "CommodityCode": "ads",
            "ExpireTime": "2999-09-08T16:00:00Z",
            "DBNodeStorage": 300,
            "DBNodeClass": "E8",
            "LockReason": "instance_expired",
            "VPCId": "vpc-bp13h7uzhulpuxvnpXXXX",
            "RegionId": "cn-hangzhou",
            "ComputeResource": "8Core32GB",
            "ElasticIOResource": 0,
            "VSwitchId": "vsw-bp1syh8vvw8yech7nXXXX",
            "DBVersion": "3.0",
            "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
            "DBClusterStatus": "Running",
            "ResourceGroupId": "rg-acfmyiu4ekp****",
            "DBClusterNetworkType": "vpc",
            "DBClusterDescription": "adb_test",
            "ZoneId": "cn-hangzhou-h",
            "Category": "MIXED_STORAGE",
            "Engine": "AnalyticDB",
            "InnerIp": "10.1.xx.xx",
            "InnerPort": "3306",
            "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": ""
          }
        ]
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    500InternalErrorAn error occurred while processing your request.系统内部错误,请稍后重试
    503ServiceUnavailableAn error occurred while processing your request.系统暂时不可用,请稍后重试

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

    变更历史

    变更时间变更内容概要操作
    2024-05-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
      删除错误码:503
    出参OpenAPI 返回结构发生变更
    2024-04-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
      删除错误码:503
    出参OpenAPI 返回结构发生变更
    • 本页导读 (1)