DescribeCommitContainerTask - Elastic Container Instance

The DescribeCommitContainerTask operation queries the details of a CommitContainer task.

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

get

*CommitContainerTask

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

eci:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
RegionId	string	Yes	The region ID.	cn-hangzhou
NextToken	string	No	The query credential. Set the value to the NextToken value returned in the last API call.	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 ECI instance on which the CommitContainer task is performed. You must specify this parameter or TaskId.	eci-2zelg8vwnlzdhf8hv****
TaskStatus	string	No	The status of the task. Valid values: Running Succeeded Failed Valid values: Succeeded : Succeeded Failed : Failed Running : Running	Running
TaskId	array	No	The task ID.
	string	No	The task ID. You must specify this parameter or ContainerGroupId.	t-2zej6nstkg744qc3****

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries that match the query conditions.	5
NextToken	string	The query credential returned in this call.	AAAAAdDWBF2****
RequestId	string	The request ID.	45D5B0AD-3B00-4A9B-9911-6D5303B06712
MaxResults	string	The number of entries displayed on each page.	20
CommitTasks	array<object>	The details of the tasks.
	array<object>	The details of the task.
TaskId	string	The task ID.	t-2zej6nstkg744qc3****
TaskStatus	string	The status of the task. Valid values: Running Succeeded Failed	Running
TaskProgress	string	The progress of the task in percentage.	50%
StatusMessage	string	The status message.	Commit container -xxxxxx
ContainerName	string	The container name.	worker0
CommitPhaseInfos	array<object>	The information about the task phases.
	object	The information about the task phase.
Phase	string	The name of the phase. Valid values: PullBaseImage: Pulls the original container image. CommitContainer: Commits the container to generate an image. PushCommittedImage: Pushes the image to ACR.	PullBaseImage
Status	string	The status of the phase.	Success
Message	string	The information about the phase.	Pull base image for container container-1 successfully
RecordTime	string	The time of the phase.	2023-01-05T14:06:40.920005316+08:00
TaskCreationTime	string	The time when the task started.	2023-03-06T08:22:40Z
TaskFinishedTime	string	The time when the task was complete.	2023-03-06T08:23:40Z

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.