Use UpdateInstance to modify instance configuration - OpenSearch

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}

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:UpdateInstance

update

*Instance

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

None

Request syntax

PUT /openapi/ha3/instances/{instanceId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID.	ha-cn-pl32rf0****

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.	{}
components	array<object>	No	The information about the instance specification.
	object	No	The request body.
code	string	No	The code of the specification, which must be consistent with the value that you specify on the buy page.	searcherdocsizesum
value	string	No	The value of the specification.	200
orderType	string	No	The type of the order. Valid values: UPGRADE and DOWNGRADE. UPGRADE upgrades the instance specifications. DOWNGRADE: downgrades the instance specifications.	UPGRAGE
description	string	No	The description of the instance.	instanceDescription

Response elements

Element	Type	Description	Example
	object	The response parameters.
result	object	The results returned.
description	string	The description of the instance	testinstance
resourceGroupId	string	The ID of the resource group.	ha-cn-pl32rf0****
expiredTime	string	The time when the instance expires	2019-01-06T16:00:00.0
commodityCode	string	The commodity code of the instance.	opensearch_ha3post_public_cn
status	string	The instance status.	READY
instanceId	string	The instance ID.	ha-cn-pl32rf0****
createTime	string	The time when the instance was created	2018-12-06T11:17:49.0
lockMode	string	The lock status	Unlock
chargeType	string	The billing method.	POSTPAY
updateTime	string	The time when the instance was last updated	2018-12-06T11:17:49.0
inDebt	boolean	Indicates whether an overdue payment is involved	false
requestId	string	The ID of the request	90D6B8F5-FE97-4509-9AAB-367836C51818

Examples

Success response

JSON format

{
  "result": {
    "description": "testinstance",
    "resourceGroupId": "ha-cn-pl32rf0****",
    "expiredTime": "2019-01-06T16:00:00.0",
    "commodityCode": "opensearch_ha3post_public_cn",
    "status": "READY",
    "instanceId": "ha-cn-pl32rf0****",
    "createTime": "2018-12-06T11:17:49.0",
    "lockMode": "Unlock",
    "chargeType": "POSTPAY",
    "updateTime": "2018-12-06T11:17:49.0",
    "inDebt": false
  },
  "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.