RestartContainerGroup - Elastic Container Instance - Alibaba Cloud Documentation Center

Operation description

You can restart only ECI instances that are in the Pending or Running state. You cannot restart instances that have completed their run.
You cannot restart ECI instances that were created before 15:00:00 on March 7, 2019.
During the restart process, the status of the ECI instance changes to Restarting.

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

eci:RestartContainerGroup

update

*containergroup

acs:eci:{#regionId}:{#accountId}:containergroup/{#containergroupId}

eci:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
RegionId	string	Yes	The ID of the region.	cn-hangzhou
ContainerGroupId	string	Yes	The ID of the ECI instance. This is also the ID of the container group.	eci-2zelg8vwnlzdhf8hv****
ClientToken	string	No	A client token to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The token can contain only ASCII characters and must be no more than 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	45D5B0AD-3B00-4A9B-9911-6D5303B06712

Examples

Success response

JSON format

{
  "RequestId": "45D5B0AD-3B00-4A9B-9911-6D5303B06712"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus	%s
400	InvalidParameter	%s
403	InvalidAction	The specified action is invalid	Invalid operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.