查询PolarDBX Search实例列表
接口说明
该接口用于获取用户已配置的自定义终端节点（Endpoint）列表，便于管理和查看私有连接或 VPC 终端服务的设置。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
实例所属的地域 ID。 |
cn-hangzhou |
| DBInstanceName |
string |
否 |
实例名称。 |
pxc-spsil01pww4hfz |
| PageNumber |
integer |
否 |
页码。 |
1 |
| PageSize |
integer |
否 |
页面大小。 |
1 |
| MaxResults |
integer |
否 |
分页查询时每页行数。最大值为 100。默认值：当不设置值或设置的值小于 10 时，默认值为 10。当设置的值大于 100 时，默认值为 100。 |
1000 |
| NextToken |
string |
否 |
下一个查询开始 Token |
xxdds |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
A501A191-BD70-5E50-98A9-C2A486A82**** |
| Data |
object |
操作结果 |
|
| Instances |
array<object> |
集群 ID。 |
|
|
object |
集群 ID。 |
||
| AvailabilityZone |
string |
可用区。 |
t1222576965886205 |
| ChargeType |
string |
付费类型，返回值：
|
PostPaid |
| Cpu |
integer |
CPU 数量。 |
4000 |
| CreateTime |
string |
创建时间 |
2026-06-08T07:19:05.000+0000 |
| DataNodeCount |
integer |
数据节点数量。 |
3 |
| Description |
string |
实例描述 |
我的 Supabase 项目 |
| EngineVersion |
string |
引擎版本，默认 2.0。 |
8.0 |
| InstanceId |
string |
实例 ID。 |
pxc-shrdb7a2t8w3c1 |
| NetType |
string |
连接串网络类型，取值范围如下：
|
1 |
| RegionId |
string |
地域 ID |
cn-beijing |
| SpecDisplay |
string |
实例规格展示名称。 |
8 核 32 GB |
| Status |
string |
实例状态 |
RUNNING |
| MemoryGB |
integer |
设置的内存的大小，单位为 GB。 |
16 |
| StorageSizeGB |
integer |
单个数据节点的存储空间大小，单位为 GB。 |
500 |
| PageNumber |
integer |
页面下标。 |
1 |
| PageSize |
integer |
页面大小。 |
30 |
| TotalNumber |
integer |
总数。 |
130 |
| MaxResults |
integer |
分页查询时每页行数。最大值为 100。默认值：当不设置值或设置的值小于 10 时，默认值为 10。当设置的值大于 100 时，默认值为 100。 |
10 |
| NextToken |
string |
下一个查询开始 Token |
AAAAAV3MpHK1AP0pfERHZN5pu6kmMV9kamx92yNWehxph5Fw |
| AccessDeniedDetail |
object |
无权限访问详情 |
|
| AuthAction |
string |
鉴权动作 |
xxx |
| AuthPrincipalType |
string |
鉴权主体类型 |
222 |
| AuthPrincipalOwnerId |
string |
鉴权主体 OwnerId |
111 |
| AuthPrincipalDisplayName |
string |
鉴权主体名称 |
xxx |
| PolicyType |
string |
策略类型 |
PRIORITY |
| NoPermissionType |
string |
无权限类型 |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
诊断信息 |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
示例
正常返回示例
JSON格式
{
"RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
"Data": {
"Instances": [
{
"AvailabilityZone": "t1222576965886205",
"ChargeType": "PostPaid",
"Cpu": 4000,
"CreateTime": "2026-06-08T07:19:05.000+0000",
"DataNodeCount": 3,
"Description": "我的 Supabase 项目",
"EngineVersion": "8.0",
"InstanceId": "pxc-shrdb7a2t8w3c1",
"NetType": "1",
"RegionId": "cn-beijing",
"SpecDisplay": "8 核 32 GB",
"Status": "RUNNING",
"MemoryGB": 16,
"StorageSizeGB": 500
}
],
"PageNumber": 1,
"PageSize": 30,
"TotalNumber": 130,
"MaxResults": 10,
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kmMV9kamx92yNWehxph5Fw"
},
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。