Queries the information of a ContextDB-X instance.
Operation description
The SQL audit and analysis feature of PolarDB-X 2.0 is free of charge. However, Simple Log Service charges fees for storage space, read traffic, number of requests, data transformation, and data shipping. For more information about the SQL audit feature, see Enable SQL audit and analysis.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. |
cn-hangzhou |
| DBInstanceName |
string |
Yes |
The instance name. |
pxc-******** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
Id of the request |
1A586DCB-39A6-4050-81CC-C7BD4CCDB49F |
| Data |
object |
The instance data. |
|
| Instance |
object |
The instance information. |
|
| InstanceId |
string |
pxc-spsil01pww4hfz-mem |
|
| RegionId |
string |
ap-southeast-1 |
|
| ZoneId |
string |
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-t4n4hf9xey7ea3lp4bwwx |
|
| VSwitchId |
string |
vsw-t4ny14pr37spmjsbv5dc2 |
|
| OpenSearchInstanceName |
string |
pxs-******** |
|
| ConnAddrs |
array<object> |
||
|
object |
|||
| NodeType |
string |
service |
|
| Type |
string |
VPC |
|
| VPCId |
string |
vpc-t4n4hf9xey7ea3lp4bwwx |
|
| VSwitchId |
string |
vsw-t4ny14pr37spmjsbv5dc2 |
|
| Port |
integer |
3306 |
|
| VpcInstanceId |
string |
pxc-spsil01pww4hfzjayd-cn-20251013180429 |
|
| ConnectionString |
string |
pxc-spsil01pww4hfz.polarx.singapore.rds.aliyuncs.com |
|
| ReplicaSets |
array<object> |
||
|
array<object> |
|||
| NodeType |
string |
service |
|
| InstanceId |
string |
pxc-hzrbqgiocrpu8a |
|
| ZoneId |
string |
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 |
|||
| NodeType |
string |
service |
|
| Type |
string |
RemoveHeader |
|
| VPCId |
string |
vpc-bp1550umsomy2mw24vhwl |
|
| VSwitchId |
string |
vsw-2zedp17pfss1133bvdizl |
|
| Port |
integer |
3306 |
|
| VpcInstanceId |
string |
vpc-8vbdw66evguopfcfvieoi |
|
| ConnectionString |
string |
pxc-hzrlz8e3khuaoz.polarx.rds.aliyuncs.com |
|
| DBInstanceName |
string |
pxc-hzr9qzafkeury3 |
|
| AccessDeniedDetail |
object |
The details of the access denial. |
|
| AuthAction |
string |
The authentication action. |
xxx |
| AuthPrincipalType |
string |
The authentication principal type. |
222 |
| AuthPrincipalOwnerId |
string |
The owner ID of the authentication principal. |
111 |
| AuthPrincipalDisplayName |
string |
The display name of the authentication principal. |
xxx |
| PolicyType |
string |
The policy type. |
PRIORITY |
| NoPermissionType |
string |
The type of missing permission. |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
The diagnostic information. |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
Examples
Success response
JSON format
{
"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=="
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.