CreateInstance-阿里云帮助中心

Creates a Havenask instance.

Operation description

Method

POST

URI

/openapi/ha3/instances

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:CreateInstance

create

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/*

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 are `PREPAY` (subscription) and `POSTPAY` (pay-as-you-go). Only `PREPAY` is currently supported. If you select `PREPAY`, you must specify the `order` parameter and ensure that your account supports balance or credit payments. Otherwise, an `InvalidPayMethod` error is returned.	PREPAY
components	array<object>	No	The instance specifications.
	object	No	A component specification.
code	string	No	The specification code. It must match the sales parameter.	searcherdocsize
value	string	No	The value for this specification code.	200
order	object	No	The billing details for the subscription.
autoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: `true` and `false`.	true
duration	integer	No	The number of billing cycles. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, and 12.	29
pricingCycle	string	No	The unit of the billing cycle. Valid values: `Month` and `Year`.	Month
tags	array<object>	No
	object	No
key	string	No
value	string	No
resourceGroupId	string	No

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	D39EE0F1-D7EF-5F46-B781-6BF4185308B0
result	object	The result of the operation.
instanceId	string	The instance ID.	ha-cn-pl32rf0****

Examples

Successful response

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

Error response

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

For more information, see response structure.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.