Automate ECS Application Restarts via RestartApplication API - EDAS - Alibaba Cloud - Enterprise Distributed Application Service

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.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

edas:ManageApplication

none

*Application

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

None

Request syntax

POST /pop/v5/changeorder/co_restart HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID. Call the ListApplication operation to obtain the application ID. For more information, see ListApplication.	c627c157-560d*******
EccInfo	string	No	The ID of the elastic compute container (ECC) that corresponds to the ECS instance on which to restart the application. Call the QueryApplicationStatus operation to obtain the ECC ID. For more information, see QueryApplicationStatus. Separate multiple ECC IDs with commas (,). If you leave this parameter empty, the application will be restarted on all the ECS instances deployed with the application.	006c0ea5-5f8d-4398-af1e-**********

Response elements

Element	Type	Description	Example
	object	The response body.
ChangeOrderId	string	The change order ID. Call the GetChangeOrderInfo operation to query the restart progress. For more information, see GetChangeOrderInfo.	a9557bac-ddd7-*********************
Code	integer	The HTTP status code.	200
Message	string	The additional information.	success
RequestId	string	The request ID.	D16979DC-4D42-****************

Examples

Success response

JSON format

{
  "ChangeOrderId": "a9557bac-ddd7-*********************",
  "Code": 200,
  "Message": "success",
  "RequestId": "D16979DC-4D42-****************"
}

Error codes

See Error CodesError Codes for a complete list.

Release notes

See Release NotesRelease Notes for a complete list.