UpdateInstance - Tablestore - Alibaba Cloud Documentation Center

Updates instance information.

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

ots:UpdateInstance

update

*Instance

acs:ots:{#regionId}:{#accountId}:Instance/{#instanceName}

None

Request syntax

POST /v2/openapi/updateinstance HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
InstanceName	string	Yes	The name of the instance whose information you want to update.	instance-test
AliasName	string	No	The alias of the instance.	instance-test
InstanceDescription	string	No	The description of the instance.	the test instance
Network	string	No	(Deprecated) The network type of the instance. Valid values: NORMAL and VPC_CONSOLE. Default value: NORMAL.	VPC
NetworkTypeACL	array	No	The new types of the network from which access is allowed. By default, all types of networks are allowed. Valid values: INTERNET: the Internet VPC: VPCs CLASSIC: the classic network
	string	No	The new type of the network from which access is allowed. Valid values: INTERNET : the Internet VPC : VPCs CLASSIC : the classic network	INTERNET
NetworkSourceACL	array	No	The new sources of the network from which access is allowed. By default, all sources of networks are allowed. Valid value: TRUST_PROXY: the console
	string	No	The new source of the network from which access is allowed. Valid values: TRUST_PROXY : the console	TRUST_PROXY

Response elements

Element	Type	Description	Example
	object	The returned struct.
RequestId	string	The request ID, which can be used to troubleshoot issues.	3104C83E-6E82-57FB-BB88-8C64CCFDEF89

Examples

Success response

JSON format

{
  "RequestId": "3104C83E-6E82-57FB-BB88-8C64CCFDEF89"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.