Query data backfill tasks by calling ListDeliveryHistoryJobs - ActionTrail - Alibaba Cloud - ActionTrail

Queries the list of historical event delivery tasks.

Operation description

This topic provides an example on how to query the list of historical event delivery tasks. The response shows a delivery task with the ID 16602, which is used to deliver historical events of the trail trail-name to Simple Log Service (SLS).

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

actiontrail:ListDeliveryHistoryJobs

get

*HistoryDeliveryJob

acs:actiontrail:{#regionId}:{#accountId}:historydeliveryjob/*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page in a paged query. Valid values: 1 to 100. Default value: 20.	20
PageNumber	integer	No	The page number of the task list. Minimum value: 1. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
DeliveryHistoryJobs	array<object>	The list of historical event delivery tasks.
	object
CreatedTime	string	The time when the historical event delivery task was created. The time follows the ISO 8601 standard in the UTC time zone. Format: yyyy-MM-dd'T'HH:mm:ss'Z'.	2021-04-26T03:17:04Z
EndTime	string	The end of the time range of historical events covered by the delivery task. The time follows the ISO 8601 standard in the UTC time zone. Format: yyyy-MM-dd'T'HH:mm:ss'Z'.	2021-04-26T03:22:04Z
HomeRegion	string	The home region.	cn-hangzhou
JobId	integer	The task ID.	16602
JobStatus	integer	The task status. Valid values: 0: The task is being initialized. 1: The task is delivering events. 2: The task delivery is complete. 3: The task delivery failed.	2
StartTime	string	The start of the time range of historical events covered by the delivery task. The time follows the ISO 8601 standard in the UTC time zone. Format: yyyy-MM-dd'T'HH:mm:ss'Z'.	2021-01-26T03:17:04Z
TrailName	string	The trail name.	trail-name
UpdatedTime	string	The time when the historical event delivery task was last updated. The time follows the ISO 8601 standard in the UTC time zone. Format: yyyy-MM-dd'T'HH:mm:ss'Z'.	2021-04-26T03:20:08Z
PageNumber	integer	The page number of the task list.	1
PageSize	integer	The number of entries per page in a paged query.	20
RequestId	string	The request ID.	B190816C-6DCA-4DC5-9B8E-EE0367B57CFF
TotalCount	integer	The total number of tasks.	1

Examples

Success response

JSON format

{
  "DeliveryHistoryJobs": [
    {
      "CreatedTime": "2021-04-26T03:17:04Z",
      "EndTime": "2021-04-26T03:22:04Z",
      "HomeRegion": "cn-hangzhou",
      "JobId": 16602,
      "JobStatus": 2,
      "StartTime": "2021-01-26T03:17:04Z",
      "TrailName": "trail-name",
      "UpdatedTime": "2021-04-26T03:20:08Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "RequestId": "B190816C-6DCA-4DC5-9B8E-EE0367B57CFF",
  "TotalCount": 1
}

Error codes

HTTP status code	Error code	Error message	Description
503	ServiceUnavailable	The service is unavailable. Please try again later.	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.