CreateInstance - OpenSearch - Alibaba Cloud Documentation Center

Creates a Havenask instance.

Operation description

POST

/api/instances?dryRun=false

There is currently no authorization information disclosed in the API.

POST /openapi/ha3/instances

Parameter	Type	Required	Description	Example
body	object	No	The request body.
chargeType	string	No	The billing method of the instance. Valid values: PREPAY: subscription. If you set this parameter to PREPAY, make sure that your Alibaba Cloud account supports balance payment or credit card payment. Otherwise, the system returns the InvalidPayMethod error message. If you set this parameter to PREPAY, you must also specify paymentInfo. POSTPAY: pay-as-you-go. This billing method is not supported.	""
components	array<object>	No	The information about the instance specification.
	object	No
code	string	No	The code of the specification, which must be consistent with the value that you specify on the buy page.	""
value	string	No	The value of the specification.	""
order	object	No	The billing information.
autoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true and false.	true
duration	long	No	The billing duration. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, and 12.	29
pricingCycle	string	No	The unit of the billing duration. Valid values: Month and Year.	""

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request	D39EE0F1-D7EF-5F46-B781-6BF4185308B0
result	object	The results returned.
instanceId	string	The instance ID.	ha-cn-2r42ppr7901

Sample success responses

{
	"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
  "result": {
      "instanceId": "deeprec-cn-xxxxxx1"
    }
}

Sample error responses

{
	"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
  "code": "InternalServerError",
  "message":"internal server error"
}

For more information, see Response structure.

Sample success responses

JSONformat

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
  "result": {
    "instanceId": "ha-cn-2r42ppr7901"
  }
}

For a list of error codes, visit the Service error codes.

Change time	Summary of changes	Operation
2024-06-28	The internal configuration of the API is changed, but the call is not affected	View Change Details