查看目标地域下的湖仓版集群列表信息。
接口说明
当前服务的接入地址请参见服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| adb:DescribeDBClusters | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 说明
您可以调用 DescribeRegions 接口查看地域 ID。
| cn-hangzhou |
| DBClusterIds | string | 否 | 湖仓版集群 ID。 此参数不填写时，默认返回该地域中所有集群的信息。 | amv-bp1r053byu48p**** |
| DBClusterDescription | string | 否 | 集群描述。
| test |
| DBClusterStatus | string | 否 | 集群状态，取值说明：
| Running |
| PageSize | integer | 否 | 每页记录数，取值：
| 30 |
| PageNumber | integer | 否 | 页码，取值为大于 0 且不超过 Integer 数据类型的正整数。默认值为 1。 | 1 |
| ResourceGroupId | string | 否 | 资源组 ID。 此参数不填写时，默认返回集群中所有资源组信息。 | rg-4690g37929**** |
| Tag | array<object> | 否 | 集群的标签信息。 | |
| object | 否 | 集群标签信息。 | ||
| Key | string | 否 | 集群的标签键。 | tag1 |
| Value | string | 否 | 集群的标签值。 | test1 |
| ProductVersion | string | 否 | 产品版本：
说明
选填参数，不填时默认返回全部集群。
| BasicVersion |
| DBClusterVersion | string | 否 | 集群版本
| 5.0 |
返回参数
示例
正常返回示例
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": "MIXED_STORAGE",
"InnerPort": "3306",
"VPCCloudInstanceId": "am-bp163885f8q21****-controller",
"InnerIp": "10.1.xx.xx",
"DtsJobId": "dtsb1578j90XXXX",
"ElasticIOResource": 2,
"RdsInstanceId": "rm-bp11q28kvl688****",
"ExecutorCount": "1",
"DBNodeClass": "E8",
"DiskType": "cloud_essd",
"DBNodeStorage": 300,
"DBNodeCount": 2,
"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"
}
]
}
},
"ProductForm": "IntegrationForm",
"ProductVersion": "EnterpriseVersion",
"ReservedNodeSize": "8ACU",
"ReservedNodeCount": 1
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. | 系统内部错误，请稍后重试 |
| 503 | ServiceUnavailable | An error occurred while processing your request. | 系统暂时不可用，请稍后重试 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-28 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-05-09 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-27 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |