ExecContainerCommand - Elastic Container Instance - Alibaba Cloud Documentation Center

Runs commands in a container.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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
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
ContainerGroupId	string	Yes	The ID of the elastic container instance.	eci-2zebxkiifulhl****
ContainerName	string	Yes	The name of the container.	nginx
Command	string	Yes	The commands to run in the container. You can specify up to 20 commands. Each command can be up to 256 characters in length. The strings must be in the JSON format. Example: `["/bin/sh", "-c", "ls -a"]`.	["/bin/sh", "-c", "ls -a"]
TTY	boolean	No	Specifies whether to enable interaction. Default value: false. If the Command parameter is set to `/bin/bash`, set this parameter to true.	false
Stdin	boolean	No	Specifies whether to read the commands from standard input (stdin). Default value: true.	true
Sync	boolean	No	Specifies whether to immediately run the command and synchronously return the result. Default value: false. If this parameter is set to true, TTY must be set to false. Command cannot be set to `/bin/bash`.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	28B583A8-313D-4383-7817-B5A9F7E0****
WebSocketUri	string	The WebSocket URL. You can use this URL to establish a WebSocket connection with the container.	wss://eci-cn-shanghai.aliyun.com/exec/?s=ktHPx****
HttpUrl	string	The HTTP URL. You can use this URL to enter the container within 30 seconds after this operation is called. For more information, see Use and integrate the Elastic Container Instance terminal.	https://eci.console.aliyun.com/terminal?param=X32a****
SyncResponse	string	The output of the command. This parameter is returned only if Sync is set to true.	Hello

Examples

Sample success responses

JSONformat

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

Error codes

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-12	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-10-12	The Error code has changed. The request parameters of the API has changed	View Change Details