查询PolarDBX Search节点列表
接口说明
该接口用于获取用户账号下可用于实例专有网络（VPC）列表，以便在创建或管理数据库实例时选择合适的网络环境。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
实例所属地域 ID。 |
cn-hangzhou |
| DBInstanceName |
string |
是 |
PolarDB-X 实例名称。 |
pxc-htri0****r4k9p |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
AE4F6C34-065F-45AA-B5DC-4B8D816F6305 |
| Data |
object |
数据结构体。 |
|
| Result |
array<object> |
查询结果对象体。 |
|
|
object |
查询结果对象体。 |
||
| CpuCores |
integer |
节点 CPU 核数。 |
1 |
| CpuPercent |
string |
CPU 使用率（%）。 |
35.6 |
| DiskUsedPercent |
string |
节点磁盘空间使用率。 |
42.5 |
| Health |
string |
未修复的基线检查总数。 |
GREEN |
| HeapPercent |
string |
节点 JVM 堆内存使用率。 |
38.2 |
| Host |
string |
发起该会话主机的 IP 地址和端口。 |
100.115.107.0/24 |
| HostName |
string |
节点实例运行所在主机的名称。您可以登录主机使用 |
hb2h-ali-oceanbase-public-online-013 |
| LoadOneM |
string |
节点最近 1 分钟的系统平均负载。 |
1.25 |
| NodeType |
string |
查询节点类型
|
dn |
| Port |
integer |
端口 |
3306 |
| ZoneId |
string |
可用区 ID。 |
cn-beijing-i |
| DiskSizeGB |
integer |
节点磁盘总容量，单位为 GB。 |
500 |
| MemoryGB |
integer |
已使用的内存数量。 |
16 |
| 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": "AE4F6C34-065F-45AA-B5DC-4B8D816F6305",
"Data": {
"Result": [
{
"CpuCores": 1,
"CpuPercent": "35.6",
"DiskUsedPercent": "42.5",
"Health": "GREEN",
"HeapPercent": "38.2",
"Host": "100.115.107.0/24",
"HostName": "hb2h-ali-oceanbase-public-online-013",
"LoadOneM": "1.25",
"NodeType": "dn",
"Port": 3306,
"ZoneId": "cn-beijing-i",
"DiskSizeGB": 500,
"MemoryGB": 16
}
]
},
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。