开通PolarDBX Search公网访问
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。 |
cn-shanghai |
| DBInstanceName |
string |
是 |
实例 ID。 |
pxc-******** |
| NodeType |
string |
否 |
目标节点类型：
|
search |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
1A586DCB-39A6-4050-81CC-C7BD4CCDB49F |
| Host |
string |
上传需要的 host |
https://sddp-datamask.oss-cn-zhangjiakou.aliyuncs.com |
| Port |
integer |
公网地址端口。 |
3306 |
| Message |
string |
接口额外返回信息，成功返回 success，错误返回对应错误码。 |
***** |
| AccessDeniedDetail |
object |
无权限访问详情 |
|
| AuthAction |
string |
鉴权动作 |
xxx |
| AuthPrincipalType |
string |
鉴权主体类型 |
222 |
| AuthPrincipalOwnerId |
string |
说明如上。 |
111 |
| AuthPrincipalDisplayName |
string |
鉴权主体名称 |
xxx |
| PolicyType |
string |
策略类型 |
PRIORITY |
| NoPermissionType |
string |
无权限类型 |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
编码诊断信息。 |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
示例
正常返回示例
JSON格式
{
"RequestId": "1A586DCB-39A6-4050-81CC-C7BD4CCDB49F",
"Host": "https://sddp-datamask.oss-cn-zhangjiakou.aliyuncs.com",
"Port": 3306,
"Message": "*****",
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。