All Products
Search
Document Center

Elastic Compute Service:DescribeAutoProvisioningGroupHistory

Last Updated:Sep 27, 2024

Queries the scheduling tasks of an auto provisioning group.

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
ecs:DescribeAutoProvisioningGroupHistoryget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the auto provisioning group.

cn-hangzhou
PageNumberintegerNo

The page number of the returned page. Pages start from page 1.

Default value: 1

1
PageSizeintegerNo

The number of entries returned per page. Maximum value: 100.

Default value: 10.

5
AutoProvisioningGroupIdstringYes

The ID of the auto provisioning group.

apg-bp67acfmxazb4p****
StartTimestringNo

The beginning of the time range of the queried data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2019-04-01T15:10:20Z
EndTimestringNo

The end of the time range of the queried data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2019-06-20T15:10:20Z

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

B48A12CD-1295-4A38-A8F0-0E92C937****
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The number of queried scheduling tasks in the auto provisioning group.

10
AutoProvisioningGroupHistoriesarray<object>

An array consisting of AutoProvisioningGroupHistory data.

AutoProvisioningGroupHistoryobject
Statusstring

The execution status of the single scheduling task. Valid values:

  • prepare: The scheduling task is being executed.
  • success: The scheduling task is executed.
  • failed: The scheduling task failed to be executed.
success
StartTimestring

The start time of executing the single scheduling task.

2019-04-01T15:10:20Z
TaskIdstring

The ID of the scheduling task.

apg-task-bp67acfmxazb4p****
LastEventTimestring

The execution time of the last instance creation performed by the single scheduling task.

2019-04-01T15:10:20Z
ActivityDetailsarray<object>

An array consisting of ActivityDetail data.

ActivityDetailobject
Statusstring

The execution status of instance creation performed by the single scheduling task. Valid values:

  • Successful: Instances are created.
  • Failed: Instances failed to be created.
  • InProgress: Instances are being created.
  • Warning: Some instances are created.
Successful
Detailstring

The execution details of instance creation performed by the single scheduling task.

New ECS instances "i-bp67acfmxazb4p****, i-bp67acfmxazb5p****" created.

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "B48A12CD-1295-4A38-A8F0-0E92C937****",
  "PageNumber": 1,
  "TotalCount": 10,
  "AutoProvisioningGroupHistories": {
    "AutoProvisioningGroupHistory": [
      {
        "Status": "success",
        "StartTime": "2019-04-01T15:10:20Z",
        "TaskId": "apg-task-bp67acfmxazb4p****",
        "LastEventTime": "2019-04-01T15:10:20Z",
        "ActivityDetails": {
          "ActivityDetail": [
            {
              "Status": "Successful",
              "Detail": "New ECS instances \"i-bp67acfmxazb4p****, i-bp67acfmxazb5p****\" created."
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe specified parameter "AutoProvisioningGroupId" should not be null.-
400MissingParamter.RegionIdThe regionId should not be null.The RegionId parameter is required.
400InvalidParameter.periodTimeThe format of startTime or endTime is invalid.-
403Forbidden.RAMUser not authorized to operate on the specified resource, or this API doesn't support RAM.-

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