创建ContextDB-X
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
实例所在地域 id。>您可以调用 describeregions 接口查看 polardb-x 支持的地域详情，包括地域 id。 |
cn-hangzhou |
| DBInstanceName |
string |
是 |
实例名称 |
pxc-******** |
| OpenSearchInstanceName |
string |
是 |
PolarDBX Search 实例名称 |
pxs-******** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
A501A191-BD70-5E50-98A9-C2A486A82**** |
| Data |
object |
返回结果。 |
|
| TaskId |
integer |
任务 ID。 |
2209883 |
| ContextDBInstanceName |
string |
上下文服务实例名 |
pxt-********* |
| ServiceReplicaSetName |
string |
上下文服务 service 实例名 |
pxt-*********-s |
| DashboardReplicaSetName |
string |
上下文服务 dashboard 实例名 |
pxt-*********-d |
| ContextDBAdminKey |
string |
上下文服务管理员密钥 |
ctx-admin-*** |
| OpenSearchInstanceName |
string |
PolarDBX Search 实例名 |
pxs-********* |
| DBInstanceName |
string |
实例 Id |
pxc-********* |
| AccessDeniedDetail |
object |
访问被拒绝的详细原因。 |
|
| AuthAction |
string |
说明如上。 |
xxx |
| AuthPrincipalType |
string |
鉴权主体类型 |
222 |
| AuthPrincipalOwnerId |
string |
鉴权主体 OwnerId |
111 |
| AuthPrincipalDisplayName |
string |
鉴权主体名称 |
xxx |
| PolicyType |
string |
策略类型 |
PRIORITY |
| NoPermissionType |
string |
NoPermissionType |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
编码诊断信息。 |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
示例
正常返回示例
JSON格式
{
"RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
"Data": {
"TaskId": 2209883,
"ContextDBInstanceName": "pxt-*********",
"ServiceReplicaSetName": "pxt-*********-s",
"DashboardReplicaSetName": "pxt-*********-d",
"ContextDBAdminKey": "ctx-admin-***",
"OpenSearchInstanceName": "pxs-*********",
"DBInstanceName": "pxc-*********"
},
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。