查詢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
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。