查询ContextDB-X实例信息
接口说明
PolarDB-X 2.0 SQL 审计与分析功能本身免费使用，但日志服务会对存储空间、读取流量、请求数量、数据加工、数据投递等进行收费，更多关于 SQL 审计功能的详情，请参见开启 SQL 审计与分析。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
| DBInstanceName |
string |
是 |
实例名称。 |
pxc-******** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
Id of the request |
1A586DCB-39A6-4050-81CC-C7BD4CCDB49F |
| Data |
object |
实例数据 |
|
| Instance |
object |
实例信息 |
|
| InstanceId |
string |
实例 ID |
pxc-spsil01pww4hfz-mem |
| RegionId |
string |
地域 ID |
ap-southeast-1 |
| ZoneId |
string |
可用区 ID |
ap-southeast-1a |
| ClassCode |
string |
实例规格 |
mysql.x2.large.2c |
| NodeCount |
integer |
节点数量 |
1 |
| CreateTime |
string |
创建时间。 |
2026-02-17T02:00:20Z |
| Status |
string |
实例状态 |
Running |
| StorageType |
string |
存储类型 |
local_ssd |
| VPCId |
string |
VPC ID |
vpc-t4n4hf9xey7ea3lp4bwwx |
| VSwitchId |
string |
交换机 ID |
vsw-t4ny14pr37spmjsbv5dc2 |
| OpenSearchInstanceName |
string |
PolarDBX Search 实例名 |
pxs-******** |
| ConnAddrs |
array<object> |
连接地址列表 |
|
|
object |
连接地址列表 |
||
| NodeType |
string |
目标节点类型：service 或 dashboard |
service |
| Type |
string |
连接地址类型 |
VPC |
| VPCId |
string |
VPC ID |
vpc-t4n4hf9xey7ea3lp4bwwx |
| VSwitchId |
string |
交换机 ID |
vsw-t4ny14pr37spmjsbv5dc2 |
| Port |
integer |
端口 |
3306 |
| VpcInstanceId |
string |
VPC 实例 ID |
pxc-spsil01pww4hfzjayd-cn-20251013180429 |
| ConnectionString |
string |
连接地址 |
pxc-spsil01pww4hfz.polarx.singapore.rds.aliyuncs.com |
| ReplicaSets |
array<object> |
副本集节点的 vpc 实例 ID。 说明
当实例的网络类型为专有网络时，返回该参数。 |
|
|
array<object> |
节点的连接地址。 |
||
| NodeType |
string |
目标节点类型：service 或 dashboard |
service |
| InstanceId |
string |
实例 ID |
pxc-hzrbqgiocrpu8a |
| ZoneId |
string |
可用区 ID。 |
cn-beijing-i |
| ClassCode |
string |
实例规格 |
pg.x2.13large.2c |
| NodeCount |
integer |
节点数量 |
1 |
| CreateTime |
string |
创建时间。 |
2026-07-28T02:01:13Z |
| Status |
string |
节点状态：
|
enabled |
| StorageType |
string |
存储类型 |
cloud_essd |
| ConnAddrs |
array<object> |
连接地址类型 |
|
|
object |
交换机 ID |
||
| NodeType |
string |
目标节点类型：service 或 dashboard |
service |
| Type |
string |
实例类型：
|
RemoveHeader |
| VPCId |
string |
VPC ID |
vpc-bp1550umsomy2mw24vhwl |
| VSwitchId |
string |
交换机 ID |
vsw-2zedp17pfss1133bvdizl |
| Port |
integer |
端口 |
3306 |
| VpcInstanceId |
string |
VPC 实例 ID |
vpc-8vbdw66evguopfcfvieoi |
| ConnectionString |
string |
连接地址。 |
pxc-hzrlz8e3khuaoz.polarx.rds.aliyuncs.com |
| DBInstanceName |
string |
数据库实例名称。 |
pxc-hzr9qzafkeury3 |
| 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": "1A586DCB-39A6-4050-81CC-C7BD4CCDB49F",
"Data": {
"Instance": {
"InstanceId": "pxc-spsil01pww4hfz-mem",
"RegionId": "ap-southeast-1",
"ZoneId": "ap-southeast-1a",
"ClassCode": "mysql.x2.large.2c",
"NodeCount": 1,
"CreateTime": "2026-02-17T02:00:20Z",
"Status": "Running",
"StorageType": "local_ssd",
"VPCId": "vpc-t4n4hf9xey7ea3lp4bwwx",
"VSwitchId": "vsw-t4ny14pr37spmjsbv5dc2",
"OpenSearchInstanceName": "pxs-********",
"ConnAddrs": [
{
"NodeType": "service",
"Type": "VPC",
"VPCId": "vpc-t4n4hf9xey7ea3lp4bwwx",
"VSwitchId": "vsw-t4ny14pr37spmjsbv5dc2",
"Port": 3306,
"VpcInstanceId": "pxc-spsil01pww4hfzjayd-cn-20251013180429",
"ConnectionString": "pxc-spsil01pww4hfz.polarx.singapore.rds.aliyuncs.com"
}
],
"ReplicaSets": [
{
"NodeType": "service",
"InstanceId": "pxc-hzrbqgiocrpu8a",
"ZoneId": "cn-beijing-i",
"ClassCode": "pg.x2.13large.2c",
"NodeCount": 1,
"CreateTime": "2026-07-28T02:01:13Z",
"Status": "enabled",
"StorageType": "cloud_essd",
"ConnAddrs": [
{
"NodeType": "service",
"Type": "RemoveHeader",
"VPCId": "vpc-bp1550umsomy2mw24vhwl",
"VSwitchId": "vsw-2zedp17pfss1133bvdizl",
"Port": 3306,
"VpcInstanceId": "vpc-8vbdw66evguopfcfvieoi",
"ConnectionString": "pxc-hzrlz8e3khuaoz.polarx.rds.aliyuncs.com"
}
]
}
],
"DBInstanceName": "pxc-hzr9qzafkeury3"
}
},
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。