All Products
Search
Document Center

Elastic Container Instance:DescribeCommitContainerTask

Last Updated:Apr 15, 2024

Queries the details of a CommitContainer task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
eci:DescribeCommitContainerTaskRead
  • All Resources
    *
  • eci:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
NextTokenstringNo

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****
MaxResultsintegerNo

The number of entries to return on each page.
Maximum value: 50.
Default value: 10.

20
ContainerGroupIdstringNo

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****
TaskStatusstringNo

The status of the task. Valid values:

  • Running
  • Succeeded
  • Failed
Running
TaskIdarrayNo

The ID of the task.

stringNo

The ID of the task.
You must enter the instance ID, the task ID, or both for the request.

t-2zej6nstkg744qc3****

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

5
NextTokenstring

The query token that is returned in this request.

AAAAAdDWBF2****
RequestIdstring

The ID of the request.

45D5B0AD-3B00-4A9B-9911-6D5303B06712
MaxResultsstring

The number of entries returned per page.

20
CommitTasksobject []

Details of the task.

TaskIdstring

The task ID.

t-2zej6nstkg744qc3****
TaskStatusstring

The state of the task. Valid values:

  • Running
  • Succeeded
  • Failed
Running
TaskProgressstring

The progress of the task in percentage.

50%
StatusMessagestring

The message about the state.

Commit container -xxxxxx
ContainerNamestring

The container name.

worker0
CommitPhaseInfosobject []

The information about the phase that the task arrives.

Phasestring

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
Statusstring

The state of the phase.

Success
Messagestring

The message about the phase.

Pull base image for container container-1 successfully
RecordTimestring

The record time of the phase.

2023-01-05T14:06:40.920005316+08:00
TaskCreationTimestring

The time when the task was started.

2023-03-06T08:22:40Z
TaskFinishedTimestring

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 timeSummary of changesOperation
2023-08-01The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-08-01The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.