All Products
Search
Document Center

ActionTrail:CreateDeliveryHistoryJob

Last Updated:Sep 30, 2024

Creates a data backfill task.

Operation description

Take note of the following limits:

  • You must have created and configured a single-account trail to deliver events to Log Service by calling the CreateTrail operation.
  • Only one historical event delivery task can be running at a time within an Alibaba Cloud account.

This topic shows you how to create a historical event delivery task for a sample trail named trail-name.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
actiontrail:CreateDeliveryHistoryJobcreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TrailNamestringYes

The name of the trail for which you want to create a historical event delivery task.

trail-name
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests.

The token can contain only ASCII characters and can be up to 64 characters in length.

For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-42665544****

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

9D356A34-D5A9-41CD-9915-837B7F9D8722
JobIdinteger

The ID of the historical event delivery task.

16602

Examples

Sample success responses

JSONformat

{
  "RequestId": "9D356A34-D5A9-41CD-9915-837B7F9D8722",
  "JobId": 16602
}

Error codes

HTTP status codeError codeError messageDescription
404TrailNotFoundExceptionThe 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 timeSummary of changesOperation
No change history