Use GetDeliveryHistoryJob to query details of a historical event delivery task - ActionTrail - Alibaba Cloud - ActionTrail

Queries the details of a historical event delivery task.

Operation description

This topic provides an example on how to query the details of a historical event delivery task whose ID is 16602. The response shows that the task delivers historical events of the trail trail-name to Simple Log Service (SLS) and that the task is complete.

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:GetDeliveryHistoryJob

get

*HistoryDeliveryJob

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

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	integer	Yes	The task ID.	16602

Response elements

Element	Type	Description	Example
	object
CreatedTime	string	The time when the historical event delivery task was created. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format. The time is displayed in UTC.	2021-05-27T07:15:03Z
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 yyyy-MM-dd'T'HH:mm:ss'Z' format. The time is displayed in UTC.	2021-05-27T07:20:03Z
HomeRegion	string	The home region of the trail.	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 is complete. 3: The task failed.	2
RequestId	string	The request ID.	FAFEC427-A00D-5653-B837-D0FA52220D8C
StartTime	string	The beginning of the time range of historical events covered by the delivery task. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format. The time is displayed in UTC.	2021-02-26T07:15:03Z
Status	array<object>	The task status list for each region.
	object
Region	string	The region to which the task delivers events.	cn-hangzhou
Status	integer	The task status for each region. Valid values: 0: The task is being initialized. 1: The task is delivering events. 2: The task is complete. 3: The task failed.	2
TrailName	string	The name of the trail associated with the task.	trail-name
UpdatedTime	string	The time when the historical event delivery task was last updated. The time follows the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ss'Z' format. The time is displayed in UTC.	2021-05-27T07:28:47Z

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.