文档

DescribeDBClusters - 查询集群列表

更新时间:

查看目标地域下的AnalyticDB MySQL湖仓版(3.0)集群列表信息。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

地域 ID。

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

AnalyticDB MySQL 湖仓版(3.0)集群 ID。

此参数不填写时,默认返回该地域中所有集群的信息。

amv-bp1r053byu48p****
DBClusterDescriptionstring

集群描述。

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

集群状态,取值说明:

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

每页记录数,取值:

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

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

1
ResourceGroupIdstring

资源组 ID。 此参数不填写时,默认返回集群中所有资源组信息。

rg-4690g37929****
Tagobject []

集群的标签信息。

Keystring

集群的标签键。

tag1
Valuestring

集群的标签值。

test1

返回参数

名称类型描述示例值
object
TotalCountinteger

总记录数。

1
PageSizeinteger

每页记录数。

30
RequestIdstring

请求 ID。

A5EDBA27-AF3E-5966-9503-FD1557E19167
PageNumberinteger

页码。

1
Itemsobject []

列表详情。

Expiredstring

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

  • true:已过期。
  • false:未过期。
说明
  • 如果集群已过期,在一定时间内集群会被锁定甚至释放。建议您进行续费操作,详情请参见续费说明
    • 按量付费集群不返回此参数。
    false
    CreateTimestring

    集群创建时间。UTC 时间,格式为yyyy-mm-ddThh:mm:ssZ

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

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

    • Postpaid:按量付费。
    • Prepaid:包年包月。
    Prepaid
    Modestring

    集群模式。默认返回 flexible,表示弹性模式集群。

    flexible
    Portstring

    集群端口号。

    3306
    LockModestring

    集群的锁定状态,取值说明:

    • Unlock:未锁定。
    • ManualLock:手动触发锁定。
    • LockByExpiration:集群过期自动锁定。
    Unlock
    StorageResourcestring

    存储预留资源规格。1 ACU 约等于 1 核 4 GB。存储资源用于数据读写,增加该资源能提高集群读写能力。

    24ACU
    DBClusterIdstring

    AnalyticDB MySQL 湖仓版(3.0)集群 ID。

    amv-bp163885f8q21****
    ConnectionStringstring

    集群的公网连接地址。

    amv-bp163885f8q21****.ads.aliyuncs.com
    DBClusterTypestring

    集群类型。默认返回 Common,表示常规集群。

    Common
    CommodityCodestring

    商品付费类型,取值说明:

    • ads:按量付费商品。
    • ads_pre:包年包月商品。
    ads_pre
    ExpireTimestring

    集群到期时间,UTC 时间,格式为yyyy-MM-ddTHH:mm:ssZ

    说明
  • 若集群付费类型为包年包月,则返回实际到期时间。
    • 若集群付费类型为按量付费,则返回为空。
    2022-07-01T09:50:18Z
    LockReasonstring

    集群锁定原因。

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

    专有网络(VPC)ID。

    vpc-bp13h7uzhulpuxvnp****
    RegionIdstring

    集群所在的地域 ID。

    cn-hangzhou
    ComputeResourcestring

    计算预留资源规格。1 ACU 约等于 1 核 4 GB。计算资源用于数据计算,增加计算资源能加快查询速度,可以根据集群实际性能按需弹性扩缩。

    16ACU
    VSwitchIdstring

    交换机 ID。

    vsw-bp1syh8vvw8yech7n****
    DBVersionstring

    AnalyticDB MySQL 湖仓版数据库版本,当前仅支持5.0版本。

    5.0
    DBClusterStatusstring

    集群状态,取值说明:

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

    资源组 ID。

    rg-acfmyiu4ekp****
    DBClusterNetworkTypestring

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

    VPC
    DBClusterDescriptionstring

    集群的描述信息。

    adb_test
    ZoneIdstring

    集群所在的可用区 ID。

    cn-hangzhou-h
    Enginestring

    集群引擎,固定为 AnalyticDB

    AnalyticDB
    ReservedACUstring

    集群剩余可分配计算预留资源。1 ACU 约等于 1 核 4 GB。

    32ACU
    Tagsobject []

    标签列表。

    Keystring

    标签键。

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

    标签值。

    test1

    示例

    正常返回示例

    JSON格式

    {
      "TotalCount": 1,
      "PageSize": 30,
      "RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
      "PageNumber": 1,
      "Items": {
        "DBCluster": [
          {
            "Expired": "false",
            "CreateTime": "2022-04-01T09:50:18Z",
            "PayType": "Prepaid",
            "Mode": "flexible",
            "Port": "3306",
            "LockMode": "Unlock",
            "StorageResource": "24ACU",
            "DBClusterId": "amv-bp163885f8q21****",
            "ConnectionString": "amv-bp163885f8q21****.ads.aliyuncs.com",
            "DBClusterType": "Common",
            "CommodityCode": "ads_pre",
            "ExpireTime": "2022-07-01T09:50:18Z",
            "LockReason": "instance_expired",
            "VPCId": "vpc-bp13h7uzhulpuxvnp****",
            "RegionId": "cn-hangzhou",
            "ComputeResource": "16ACU",
            "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
            "DBVersion": "5.0",
            "DBClusterStatus": "Running",
            "ResourceGroupId": "rg-acfmyiu4ekp****",
            "DBClusterNetworkType": "VPC",
            "DBClusterDescription": "adb_test",
            "ZoneId": "cn-hangzhou-h",
            "Engine": "AnalyticDB",
            "ReservedACU": "32ACU",
            "Tags": {
              "Tag": [
                {
                  "Key": "tag1",
                  "Value": "test1"
                }
              ]
            },
            "Category": "",
            "InnerPort": "",
            "VPCCloudInstanceId": "",
            "InnerIp": "",
            "DtsJobId": "",
            "ElasticIOResource": 0,
            "RdsInstanceId": "",
            "ExecutorCount": "",
            "DBNodeClass": "",
            "DiskType": "",
            "DBNodeStorage": 0,
            "DBNodeCount": 0,
            "TaskInfo": {
              "Name": "",
              "Status": "",
              "Progress": "",
              "StepList": {
                "StepList": [
                  {
                    "StepName": "",
                    "StepDesc": "",
                    "StepStatus": "",
                    "StepProgress": "",
                    "StartTime": "",
                    "EndTime": ""
                  }
                ]
              }
            },
            "ProductForm": "",
            "ProductVersion": "",
            "ReservedNodeSize": "",
            "ReservedNodeCount": 0
          }
        ]
      }
    }

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2024-05-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
      删除错误码:503
    入参OpenAPI 入参发生变更
      新增入参:ProductVersion
      新增入参:DBClusterVersion
    出参OpenAPI 返回结构发生变更
    2023-07-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
      删除错误码:503
    入参OpenAPI 入参发生变更
      新增入参:Tag
    出参OpenAPI 返回结构发生变更
    • 本页导读 (1)