ExecContainerCommand - Elastic Container Instance - Alibaba Cloud Documentation Center

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

update

*containergroup

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

eci:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
ContainerGroupId	string	Yes	The instance ID, which is the container group ID.	eci-2zebxkiifulhl****
ContainerName	string	Yes	The name of the container.	nginx
Command	string	Yes	The commands to execute in the container. You can specify up to 20 commands. Each command can be up to 256 characters long. To execute multiple commands, pass the string in JSON format. For example, `["/bin/sh", "-c", "ls -a"]`.	["/bin/sh", "-c", "ls -a"]
TTY	boolean	No	Specifies whether to enable interaction. The default value is false. If you set Command to `/bin/bash`, set this parameter to true.	false
Stdin	boolean	No	Specifies whether to enable standard input. The default value is true.	true
Sync	boolean	No	Specifies whether to execute the command immediately and return the result synchronously. The default value is false. If you set this parameter to true, you must set TTY to false. This means Command cannot be `/bin/bash`.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	28B583A8-313D-4383-7817-B5A9F7E0****
WebSocketUri	string	The WebSocket URL. Use this URL to connect to the container.	wss://eci-cn-shanghai.aliyun.com/exec/?s=ktHPx****
HttpUrl	string	The HTTP URL. Access this URL within 30 seconds to enter the container. For more information, see Use and integrate ECI Terminal.	https://eci.console.alibabacloud.com/terminal?param=X32a****
SyncResponse	string	The result returned for the command. This parameter is returned when Sync is set to true.	Hello

Examples

Success response

JSON format

{
  "RequestId": "28B583A8-313D-4383-7817-B5A9F7E0****",
  "WebSocketUri": "wss://eci-cn-shanghai.aliyun.com/exec/?s=ktHPx****",
  "HttpUrl": "https://eci.console.alibabacloud.com/terminal?param=X32a****",
  "SyncResponse": "Hello"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.ValueExceeded	%s
400	IncorrectStatus	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.