ListDeliveryHistoryJobs - ActionTrail - Alibaba Cloud Documentation Center

Queries a list of data backfill tasks.

Operation description

This topic describes how to query the historical event delivery tasks created within your Alibaba Cloud account. In this example, a historical event delivery task whose ID is 16602 is returned. This task is used to deliver historical events for the trail named trail-name to Log Service.

Debugging

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

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
actiontrail:ListDeliveryHistoryJobs	List	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The number of historical event delivery tasks returned.	1
PageSize	integer	The number of entries per page.	20
RequestId	string	The ID of the request.	B190816C-6DCA-4DC5-9B8E-EE0367B57CFF
PageNumber	integer	The page number of the returned page.	1
DeliveryHistoryJobs	object []	The list of historical event delivery tasks.
TrailName	string	The name of the trail.	trail-name
EndTime	string	The time when the task ended.	2021-04-26T03:22:04Z
StartTime	string	The time when the task started.	2021-01-26T03:17:04Z
JobStatus	integer	The task status. Valid values: 0: The task is initializing. 1: The task is delivering historical events. 2: The task is complete. 3: The task fails.	2
HomeRegion	string	The home region of the trail.	cn-hangzhou
UpdatedTime	string	The time when the task was updated.	2021-04-26T03:20:08Z
JobId	long	The task ID.	16602
CreatedTime	string	The time when the task was created.	2021-04-26T03:17:04Z

Examples

Sample success responses

JSONformat

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

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.

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

Change history

Change time	Summary of changes	Operation

No change history