Queries the created historical event delivery tasks.

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListDeliveryHistoryJobs

The operation that you want to perform. Set the value to ListDeliveryHistoryJobs.

PageSize Integer No 20

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 20.

PageNumber Integer No 1

The number of the page to return.

Pages start from page 1.

Default value: 1.

Response parameters

Parameter Type Example Description
TotalCount Integer 1

The number of historical event delivery tasks returned.

PageSize Integer 20

The number of entries returned per page.

RequestId String B190816C-6DCA-4DC5-9B8E-EE0367B57CFF

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

DeliveryHistoryJobs Array of DeliveryHistoryJob

The information about the historical event delivery task.

TrailName String trail-name

The name of the trail.

EndTime String 2021-04-26T03:22:04Z

The time when the task ended.

StartTime String 2021-01-26T03:17:04Z

The time when the task started.

JobStatus Integer 2

The status of the task. Valid values:

  • 0: The task is initializing.
  • 1: The task is delivering historical events.
  • 2: The delivery of historical events is complete.
  • 3: The task fails.
HomeRegion String cn-hangzhou

The home region of the trail.

UpdatedTime String 2021-04-26T03:20:08Z

The time when the task was updated.

JobId Long 16602

The ID of the task.

CreatedTime String 2021-04-26T03:17:04Z

The time when the task was created.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDeliveryHistoryJobs
&PageSize=20
&PageNumber=1
&<Common request parameters>

Sample success responses

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code Error code Error message Description
503 ServiceUnavailable The service is unavailable. Please try again later. The error message returned because the service is unavailable. Try again later.

For a list of error codes, visit the API Error Center.