Restarts the instances of a service.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| eas:DeleteServiceInstances | delete | *Service acs:eas:{#regionId}:{#accountId}:service/{#ServiceName} |
| none |
Request syntax
DELETE /api/v2/services/{ClusterId}/{ServiceName}/instances HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClusterId | string | Yes | The ID of the region where the service is deployed. | cn-shanghai |
| ServiceName | string | Yes | The service name. For more information about how to query the service name, see ListServices . | foo |
| InstanceList | string | Yes | The instances that you want to restart. Separate multiple instance names with commas (,). For more information about how to query the instance name, see ListServiceInstances . | foo-rdsbxxxx,foo-rdsaxxxx |
| SoftRestart | boolean | No | Specifies whether to restart only the container process without recreating the instance. Default value: false. Valid values: true and false. | true |
| Container | string | No | The name of the container whose process needs to be restarted. This parameter takes effect only if the SoftRestart parameter is set to true. | worker0 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "40325405-579C-4D82****",
"Message": "Instance(s) [foo-rdsb,foo-rdsa] for service [foo] in region [cn-shanghai] was deleted successfully"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-04 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-06-06 | The request parameters of the API has changed | View Change Details |