Creates a PolarDBX Search instance.
Operation description
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region in which the instance resides. |
cn-hangzhou |
| PayType |
string |
Yes |
The billing method of the instance.
|
PREPAY |
| ZoneId |
string |
Yes |
The zone of the instance. |
cn-beijing-h |
| Zone2 |
string |
No |
The second zone. This parameter is required when TopologyType is set to 3azones. The value cannot be the same as other zones. |
cn-hangzhou-i |
| Zone3 |
string |
No |
The third zone. This parameter is required when TopologyType is set to 3azones. The value cannot be the same as other zones. |
cn-hangzhou-j |
| TopologyType |
string |
No |
The topology type. Valid values:
|
3azones |
| VPCId |
string |
Yes |
VPC ID。 |
vpc-***** |
| VSwitchId |
string |
Yes |
The vSwitch ID. |
vsw-********* |
| EngineVersion |
string |
No |
The PolarDBX Search DPI engine version. The value is fixed to 3.0. If this parameter is not specified, the default value 3.0 is used. |
3.0 |
| DBNodeClass |
string |
Yes |
The node specifications code of PolarDBX Search data nodes. Available specifications depend on the region and sales configuration. Use a PolarDBX Search specification code that is available for purchase in the current region. |
opensearch.sn2ne.large.1 |
| NodeCount |
integer |
Yes |
The number of PolarDBX Search data nodes. The value must be a positive integer and a multiple of the number of selected zones. |
3 |
| InstanceSpec |
string |
No |
A compatible parameter that does not take effect. Use DBNodeClass to specify the PolarDBX Search data node specifications. |
opensearch.sn2ne.large.1 |
| StorageType |
string |
No |
The storage type. Default value: cloud_auto. |
cloud_auto |
| StorageSpace |
integer |
No |
The storage space per node, in GB. The value must be a positive integer. |
20 |
| DBInstanceDescription |
string |
No |
The description of the instance. |
TestInstance |
| ClientToken |
string |
No |
The client token used to ensure the idempotence of the request. Use a different value for each creation request. |
FEA5DC20-6D8A-5979-97AA-FC57546ADC20 |
| ResourceGroupId |
string |
No |
The resource group ID. This parameter can be left empty. This parameter is not supported. |
rg-xxxxx |
| Period |
string |
No |
The billing cycle. Valid values for subscription: Year and Month. Default value for pay-as-you-go: Hour. |
Month |
| UsedTime |
integer |
No |
The subscription duration. Specify the number of months or years for prepaid instances. Note
When Period is set to Year, valid values for this parameter are 1, 2, and 3. |
1 |
| AutoRenew |
boolean |
No |
Specifies whether to enable auto-renewal. Default value: true.
|
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
C457B28E-9CAB-4B77-B5C6-5D71B7870B6E |
| Data |
object |
The operation result. |
|
| DBInstanceName |
string |
The instance name. |
pxsp-********* |
| OrderId |
string |
The order ID. |
265325896860727 |
| AccessDeniedDetail |
object |
The details of the access denial. |
|
| AuthAction |
string |
The authentication action. |
xxx |
| AuthPrincipalType |
string |
The type of the authentication principal. |
222 |
| AuthPrincipalOwnerId |
string |
The ID of the Alibaba Cloud account to which the authentication principal belongs. |
111 |
| AuthPrincipalDisplayName |
string |
The display name of the authentication principal. |
xxx |
| PolicyType |
string |
The policy type. |
PRIORITY |
| NoPermissionType |
string |
NoPermissionType |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
The encoded diagnostic message. |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
Examples
Success response
JSON format
{
"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=="
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.