UpdateServiceInstance - Platform For AI - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing of Elastic Algorithm Service (EAS).

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

eas:UpdateServiceInstance

update

*Service

acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}

None

Request syntax

PUT /api/v2/services/{ClusterId}/{ServiceName}/instances/{InstanceName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The region of the service.	cn-shanghai
ServiceName	string	Yes	The name of the service. For more information, see ListServices.	foo
InstanceName	string	Yes	The name of the service instance. For more information, see ListServiceInstances.	foo-69xxxx4f4-5w9r9

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
Hibernate	boolean	No	Note This parameter is for an invitational preview. It is not generally available.	0
Isolate	boolean	No	Specifies whether to isolate the instance. Valid values: true: The instance is isolated and does not receive traffic. false: The instance is not isolated and receives traffic.	true
Detach	boolean	No	Specifies whether to fence the service instance. After an instance is fenced, it is no longer managed by the VPC controller and a new instance is created. The fenced instance is reserved for troubleshooting or debugging. Note: You cannot unfence an instance. Valid values: true: Fences the instance.	true
IsReplica	boolean	No	Specifies whether the instance is a replica.	false

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	40325405-579C-4D82****
Message	string	A message that indicates a successful operation.	instance xxxx isolation updated to true。

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "Message": "instance xxxx isolation updated to true。"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.