查询Agentic Database集群列表
接口说明
请求说明
该接口支持根据
RelativeDBClusterId和KubeType参数来过滤并返回相关的模型算子列表。注意：在请求时确保提供的
RelativeDBClusterId与实际存在的 PolarDB 数据库实例 ID 相匹配，否则将无法正确获取数据。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
| DBClusterIds |
string |
否 |
集群 ID。多个集群 ID 间用英文逗号（,）隔开。 |
pc-************** |
| AgenticDbClusterIds |
string |
否 |
Agentic 集群 ID。多个集群 ID 间用英文逗号（,）隔开。 |
pagc-************** |
| DBClusterDescription |
string |
否 |
集群描述，可模糊查询。 |
pc-**************** |
| DBClusterStatus |
string |
否 |
集群状态。 |
Running |
| PageSize |
integer |
否 |
每页记录数，取值为 30、50 或 100。 默认值为 30。 |
30 |
| PageNumber |
integer |
否 |
当前页数 |
1 |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-************ |
| Tag |
array<object> |
否 |
标签列表。 |
|
|
object |
否 |
标签列表 |
||
| Value |
string |
否 |
标签键对应的标签值。 |
testValueData |
| Key |
string |
否 |
标签键，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。Tag.n.Key 对应的值为 Tag.n.Value。 |
type |
| MaxResults |
integer |
否 |
本次读取的最大数据量，默认值为 10。 |
10 |
| NextToken |
string |
否 |
查询凭证（token），取值为上一次 api 调用返回的 nexttoken 参数值。如果没有下一个查询，请不传。 |
212db86sca4384811e0b5e8707e****** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| TotalRecordCount |
integer |
总记录数。 |
1 |
| PageRecordCount |
integer |
本页集群数量。 |
1 |
| RequestId |
string |
请求 ID。 |
CDB3258F-B5DE-43C4-8935-CBA0CA****** |
| PageNumber |
integer |
页数。 |
1 |
| Items |
array<object> |
集群列表。 |
|
|
array<object> |
SSL 链路信息列表。 |
||
| DBClusterId |
string |
集群 ID。 |
pc-xxxxxx |
| RegionId |
string |
地域 ID。 |
cn-hangzhou |
| ZoneId |
string |
可用区 ID。 |
cn-hangzhou-i |
| DBClusterStatus |
string |
集群状态。 |
Running |
| CreateTime |
string |
集群创建时间。 |
2020-08-14T05:58:42Z |
| DBClusterDescription |
string |
集群描述。 |
ocpx |
| DBType |
string |
数据库引擎类型。 |
MySQL |
| DBVersion |
string |
数据库版本。 |
8.0 |
| Category |
string |
集群系列，目前支持如下系列：
|
Normal |
| ServerlessType |
string |
Serverless 类型。返回 AgileServerless 表示当前集群是 Serverless 集群。 |
AgileServerless |
| PayType |
string |
付费类型。取值范围：
|
Postpaid |
| StorageType |
string |
存储类型取值如下：
|
city_redundancy |
| StorageUsed |
integer |
集群已经使用的存储用量，单位为 Byte。 |
3009413120 |
| ScaleMin |
string |
最小值:0~32 PCU，且最小值 <= 最大值。单位：PCU。 |
1 |
| ScaleMax |
string |
最大值:1~32 PCU。单位：PCU。 |
9 |
| VpcId |
string |
访问端点所在的专有网络 ID。 |
vpc-**************** |
| VswitchId |
string |
虚拟交换机 ID。 |
vsw-************** |
| Expired |
string |
集群是否到期。取值范围：
说明
仅付费方式为 Prepaid（包年包月）的集群支持返该参数。 |
false |
| LockMode |
string |
集群的锁定状态，取值范围如下：
|
Unlock |
| ExpireTime |
string |
集群到期时间。 说明
仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。 |
2025-06-25T09:37:10Z |
| Tags |
array<object> |
标签键，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。Tag.n.Key 对应的值为 Tag.n.Value。 |
|
|
object |
标签键，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。Tag.n.Key 对应的值为 Tag.n.Value。 |
||
| Value |
string |
标签值。 |
testValueData |
| Key |
string |
标签键。 |
MySQL |
| AgenticDbClusterId |
string |
Agentic 集群 ID。 |
pagc-************** |
| AgenticDbClusterDescription |
string |
Agentic 集群描述。 |
pagc-************** |
| NextToken |
string |
查询凭证（token），取值为上一次 api 调用返回的 nexttoken 参数值。如果没有下一个查询，请不传。 |
212db86sca4384811e0b5e8707e****** |
| MaxResults |
integer |
本次读取的最大数据量，默认值为 10。 |
10 |
示例
正常返回示例
JSON格式
{
"TotalRecordCount": 1,
"PageRecordCount": 1,
"RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
"PageNumber": 1,
"Items": [
{
"DBClusterId": "pc-xxxxxx",
"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-i",
"DBClusterStatus": "Running",
"CreateTime": "2020-08-14T05:58:42Z",
"DBClusterDescription": "ocpx",
"DBType": "MySQL",
"DBVersion": "8.0",
"Category": "Normal",
"ServerlessType": "AgileServerless",
"PayType": "Postpaid",
"StorageType": "city_redundancy",
"StorageUsed": 3009413120,
"ScaleMin": "1",
"ScaleMax": "9",
"VpcId": "vpc-****************",
"VswitchId": "vsw-**************",
"Expired": "false",
"LockMode": "Unlock",
"ExpireTime": "2025-06-25T09:37:10Z",
"Tags": [
{
"Value": "testValueData",
"Key": "MySQL"
}
],
"AgenticDbClusterId": "pagc-**************",
"AgenticDbClusterDescription": "pagc-**************"
}
],
"NextToken": "212db86sca4384811e0b5e8707e******",
"MaxResults": 10
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。