DescribeCommitContainerTask - Elastic Container Instance

Queries the details of a CommitContainer task.

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:DescribeCommitContainerTask	get	CommitContainerTask `acs:eci:{#regionId}:{#accountId}:containergroup/`	eci:tag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
NextToken	string	No	The token that determines the start point of the query. Set the value to the value of NextToken that is returned from the last request.	AAAAAdDWBF2****
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	20
ContainerGroupId	string	No	The ID of the elastic container instance on which the CommitContainer task is executed. You must enter the instance ID, the task ID, or both for the request.	eci-2zelg8vwnlzdhf8hv****
TaskStatus	string	No	The status of the task. Valid values: Running Succeeded Failed	Running
TaskId	array	No	The ID of the task.
	string	No	The ID of the task. You must enter the instance ID, the task ID, or both for the request.	t-2zej6nstkg744qc3****

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	5
NextToken	string	The query token that is returned in this request.	AAAAAdDWBF2****
RequestId	string	The ID of the request.	45D5B0AD-3B00-4A9B-9911-6D5303B06712
MaxResults	string	The number of entries returned per page.	20
CommitTasks	array<object>	Details of the task.
CommitTask	object	The details of the task.
TaskId	string	The task ID.	t-2zej6nstkg744qc3****
TaskStatus	string	The state of the task. Valid values: Running Succeeded Failed	Running
TaskProgress	string	The progress of the task in percentage.	50%
StatusMessage	string	The message about the state.	Commit container -xxxxxx
ContainerName	string	The container name.	worker0
CommitPhaseInfos	array<object>	The information about the phase that the task arrives.
CommitPhaseInfo	object	Information about the phase that the task arrives.
Phase	string	The phase name. Valid values: PullBaseImage: Pull the original container image. CommitContainer: Commit the container to generate an image. PushCommittedImage: Push the image to Container Registry.	PullBaseImage
Status	string	The state of the phase.	Success
Message	string	The message about the phase.	Pull base image for container container-1 successfully
RecordTime	string	The record time of the phase.	2023-01-05T14:06:40.920005316+08:00
TaskCreationTime	string	The time when the task was started.	2023-03-06T08:22:40Z
TaskFinishedTime	string	The time when the task was complete.	2023-03-06T08:23:40Z

Examples

Sample success responses

JSONformat

{
  "TotalCount": 5,
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "45D5B0AD-3B00-4A9B-9911-6D5303B06712",
  "MaxResults": "20",
  "CommitTasks": [
    {
      "TaskId": "t-2zej6nstkg744qc3****",
      "TaskStatus": "Running",
      "TaskProgress": "50%",
      "StatusMessage": "Commit container -xxxxxx",
      "ContainerName": "worker0",
      "CommitPhaseInfos": [
        {
          "Phase": "PullBaseImage",
          "Status": "Success",
          "Message": "Pull base image for container container-1 successfully",
          "RecordTime": "2023-01-05T14:06:40.920005316+08:00"
        }
      ],
      "TaskCreationTime": "2023-03-06T08:22:40Z",
      "TaskFinishedTime": "2023-03-06T08:23:40Z"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-08-01	The response structure of the API has changed	View Change Details
2023-08-01	The response structure of the API has changed	View Change Details