DeleteServiceInstances - Platform For AI - Alibaba Cloud Documentation Center

Restarts specified instances of a service.

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

delete

*Service

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

None

Request syntax

DELETE /api/v2/services/{ClusterId}/{ServiceName}/instances HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The region where the service is located.	cn-shanghai
ServiceName	string	Yes	The name of the service. For more information, see ListServices.	foo

Request parameters

Parameter	Type	Required	Description	Example
InstanceList	string	No	The instances to restart. Separate multiple instance names with a comma (,). For more information, see ListServiceInstances.	foo-rdsbxxxx,foo-rdsaxxxx
SoftRestart	boolean	No	Specifies whether to restart only the container process without rebuilding the instance. The default value is false.	true
Container	string	No	The name of the container in which to restart the process. This parameter is valid only when `SoftRestart` is set to `true`.	worker0
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	The response message.	Instance(s) [foo-rdsb,foo-rdsa] for service [foo] in region [cn-shanghai] was deleted successfully

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "Message": "Instance(s) [foo-rdsb,foo-rdsa]  for service [foo] in region [cn-shanghai] was deleted successfully"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.