创建 PolarDBX Search 实例
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
实例所在地域。 |
cn-hangzhou |
| PayType |
string |
是 |
实例付费类型。
|
PREPAY |
| ZoneId |
string |
是 |
实例可用区。 |
cn-beijing-h |
| Zone2 |
string |
否 |
第二可用区。TopologyType 为 3azones 时必填，且不能与其他可用区重复。 |
cn-hangzhou-i |
| Zone3 |
string |
否 |
第三可用区。TopologyType 为 3azones 时必填，且不能与其他可用区重复。 |
cn-hangzhou-j |
| TopologyType |
string |
否 |
拓扑类型：
|
3azones |
| VPCId |
string |
是 |
VPC ID。 |
vpc-***** |
| VSwitchId |
string |
是 |
虚拟交换机 ID。 |
vsw-********* |
| EngineVersion |
string |
否 |
PolarDBX Search 引擎版本。当前固定为 3.0；不传时使用 3.0。 |
3.0 |
| DBNodeClass |
string |
是 |
PolarDBX Search 数据节点规格代码。可用规格取决于地域和售卖配置，请使用当前地域可购买的 PolarDBX Search 规格代码。 |
opensearch.sn2ne.large.1 |
| NodeCount |
integer |
是 |
PolarDBX Search 数据节点数量。必须为正整数，并且是所选可用区数量的整数倍。 |
3 |
| InstanceSpec |
string |
否 |
兼容参数，当前不生效。请通过 DBNodeClass 指定 PolarDBX Search 数据节点规格。 |
opensearch.sn2ne.large.1 |
| StorageType |
string |
否 |
存储类型。默认值为 cloud_auto。 |
cloud_auto |
| StorageSpace |
integer |
否 |
单节点存储空间，单位为 GB。必须为正整数。 |
20 |
| DBInstanceDescription |
string |
否 |
实例备注描述。 |
测试实例 |
| ClientToken |
string |
否 |
幂等请求串，保持每次创建不同即可。 |
FEA5DC20-6D8A-5979-97AA-FC57546ADC20 |
| ResourceGroupId |
string |
否 |
可以为空，资源组 ID，暂时不支持。 |
rg-xxxxx |
| Period |
string |
否 |
收费周期，包年包月只能选 Year、Month， 按量付费默认选择 Hour。 |
Month |
| UsedTime |
integer |
否 |
预付费时，可以选择买几个月或者几年。 说明
Period 设置为 Year 时，该参数支持的取值为 1、2、3。 |
1 |
| AutoRenew |
boolean |
否 |
是否自动续费，默认为 true。
|
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 id。 |
C457B28E-9CAB-4B77-B5C6-5D71B7870B6E |
| Data |
object |
操作结果 |
|
| DBInstanceName |
string |
实例名称 |
pxsp-********* |
| OrderId |
string |
订单 ID |
265325896860727 |
| AccessDeniedDetail |
object |
无权限访问详情 |
|
| AuthAction |
string |
鉴权动作 |
xxx |
| AuthPrincipalType |
string |
说明如上。 |
222 |
| AuthPrincipalOwnerId |
string |
鉴权主体的主账号 ID。 |
111 |
| AuthPrincipalDisplayName |
string |
鉴权主体名称 |
xxx |
| PolicyType |
string |
策略类型 |
PRIORITY |
| NoPermissionType |
string |
NoPermissionType |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
编码诊断信息。 |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
示例
正常返回示例
JSON格式
{
"RequestId": "C457B28E-9CAB-4B77-B5C6-5D71B7870B6E",
"Data": {
"DBInstanceName": "pxsp-*********",
"OrderId": "265325896860727"
},
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。