CreateInstance - OpenSearch - Alibaba Cloud Documentation Center

Creates a Havenask instance.

Operation description

Method

POST

URI

/api/instances?dryRun=false

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
searchengine:CreateInstance	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/*	none	none

Request syntax

POST /openapi/ha3/instances HTTP/1.1

Request parameters

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.	""

Response parameters

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 responses

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.

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

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