GetDeliveryHistoryJob - ActionTrail - Alibaba Cloud Documentation Center

Queries the details of a data backfill task.

Operation description

This topic describes how to query the details of a historical event delivery tasks created within your Alibaba Cloud account. In this example, the details of a historical event delivery task whose ID is 16602 are returned. The sample response shows that this task is used to deliver the historical events recorded by the trail named trail-name to Log Service and the task is complete.

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

Request parameters

Parameter	Type	Required	Description	Example
JobId	long	Yes	The ID of the historical event delivery task.	16602

Response parameters

Parameter	Type	Description	Example
	object
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
Status	object []	A list of task statuses in each region.
Status	integer	The task status in each region. Valid values: 0: The task is initializing. 1: The task is delivering historical events. 2: The task is complete. 3: The task fails.	2
Region	string	The ID of the region.	cn-hangzhou
CreatedTime	string	The time when the task was created.	2021-05-27T07:15:03Z
EndTime	string	The time when the task ended.	2021-05-27T07:20:03Z
RequestId	string	The ID of the request.	FAFEC427-A00D-5653-B837-D0FA52220D8C
StartTime	string	The time when the task started.	2021-02-26T07:15:03Z
TrailName	string	The name of the trail based on which the task delivers events.	trail-name
UpdatedTime	string	The time when the task was updated.	2021-05-27T07:28:47Z
JobId	long	The ID of the task.	16602
HomeRegion	string	The home region of the trail.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "JobStatus": 2,
  "Status": [
    {
      "Status": 2,
      "Region": "cn-hangzhou"
    }
  ],
  "CreatedTime": "2021-05-27T07:15:03Z",
  "EndTime": "2021-05-27T07:20:03Z",
  "RequestId": "FAFEC427-A00D-5653-B837-D0FA52220D8C",
  "StartTime": "2021-02-26T07:15:03Z",
  "TrailName": "trail-name",
  "UpdatedTime": "2021-05-27T07:28:47Z",
  "JobId": 16602,
  "HomeRegion": "cn-hangzhou"
}

Error codes

HTTP status code	Error code	Error message	Description
404	TrailNotFoundException	The specified Trail does not exist.	The specified Trail is not existed.

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

Change history

Change time	Summary of changes	Operation

No change history