Queries the details of a historical event delivery task.

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

Request parameters

Parameter Type Required Example Description
Action String Yes GetDeliveryHistoryJob

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

JobId Long Yes 16602

The ID of the historical event delivery task.

Response parameters

Parameter Type Example Description
JobStatus Integer 2

The overall status of the historical event delivery task. Valid values:

  • 0: The task is initializing.
  • 1: The task is delivering historical events.
  • 2: The task is complete.
  • 3: The task fails.
Status Array of Status

The status of the task in each region.

Status Integer 2

The status of the task in the current region. Valid values:

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

The ID of the region.

CreatedTime String 2021-05-27T07:15:03Z

The time when the task was created.

EndTime String 2021-05-27T07:20:03Z

The time when the task ended.

RequestId String FAFEC427-A00D-5653-B837-D0FA52220D8C

The ID of the request.

StartTime String 2021-02-26T07:15:03Z

The time when the task started.

TrailName String trail-name

The name of the trail based on which the task delivers events.

UpdatedTime String 2021-05-27T07:28:47Z

The time when the task was updated.

JobId Long 16602

The ID of the task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetDeliveryHistoryJob
&JobId=16602
&<Common request parameters>

Sample success responses

JSON format

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

{
  "JobStatus" : 2,
  "Status" : [ {
    "Status" : 2,
    "Region" : "cn-hangzhou"
  }, {
    "Status" : 2,
    "Region" : "cn-beijing"
  }, {
    "Status" : 2,
    "Region" : "cn-chengdu"
  }, {
    "Status" : 2,
    "Region" : "cn-guangzhou"
  }, {
    "Status" : 2,
    "Region" : "cn-heyuan"
  }, {
    "Status" : 2,
    "Region" : "cn-hongkong"
  }, {
    "Status" : 2,
    "Region" : "cn-huhehaote"
  }, {
    "Status" : 2,
    "Region" : "cn-qingdao"
  }, {
    "Status" : 2,
    "Region" : "cn-shanghai"
  }, {
    "Status" : 2,
    "Region" : "cn-shenzhen"
  }, {
    "Status" : 2,
    "Region" : "cn-zhangjiakou"
  }, {
    "Status" : 2,
    "Region" : "ap-southeast-1"
  }, {
    "Status" : 2,
    "Region" : "ap-southeast-2"
  }, {
    "Status" : 2,
    "Region" : "ap-southeast-3"
  }, {
    "Status" : 2,
    "Region" : "ap-southeast-5"
  }, {
    "Status" : 2,
    "Region" : "ap-northeast-1"
  }, {
    "Status" : 2,
    "Region" : "ap-south-1"
  }, {
    "Status" : 2,
    "Region" : "eu-central-1"
  }, {
    "Status" : 2,
    "Region" : "eu-west-1"
  }, {
    "Status" : 2,
    "Region" : "us-east-1"
  }, {
    "Status" : 2,
    "Region" : "us-west-1"
  }, {
    "Status" : 2,
    "Region" : "me-east-1"
  }, {
    "Status" : 2,
    "Region" : "cn-nanjing"
  }, {
    "Status" : 0,
    "Region" : "cn-wulanchabu"
  } ],
  "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
}

Error codes

HTTP status code Error code Error message Description
404 TrailNotFoundException The specified Trail does not exist. The error message returned because the specified trail does not exist.

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