Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Intelligent O&M/ Creating a Task for Exporting Historical Transactions
Updated on 2025-11-26 GMT+08:00

Creating a Task for Exporting Historical Transactions

Function

After Collect Historical Transactions is enabled, this API is used to create a task to export historical transaction data within a specified time range at a time.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: Required)

    Condition Key

    Alias

    Dependency

    das::showCloudDBAInfo

    read

    -

    -

    -

    -

URI

POST /v3/{project_id}/transaction/{instance_id}/create-export-task

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

The value can contain 32 characters, including only letters and digits.

Default value:

N/A

instance_id

Yes

String

Explanation:

Unique ID of an instance

Constraints:

N/A

Values:

The value can contain 32 characters, including only letters and digits.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

bucket_name

Yes

String

Explanation:

OBS bucket name

Constraints:

Maximum length: 63 characters

Values:

N/A

Default value:

N/A

start_at

Yes

Long

Explanation:

Start time

Constraints:

Unix timestamp, in milliseconds

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

end_at

Yes

Long

Explanation:

End time

Constraints:

Unix timestamp, in milliseconds

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

file_path

No

String

Explanation:

OBS file directory

Constraints:

Maximum length: 1024 characters

Values:

N/A

Default value:

N/A

time_zone

No

String

Explanation:

Time zone

Constraints:

Maximum length: 64 characters

Values:

Any valid time zone definition, for example, UTC or GMT

Default value:

N/A

order

No

String

Explanation:

Sorting field

Constraints:

N/A

Values:

  • collectTime: collection time
  • occurrenceTime: occurrence time
  • lastSec: transaction duration
  • waitLockStructCount: number of held locks
  • holdLockStructCount: number of waiting locks

Default value:

N/A

order_by

No

String

Explanation:

Sorting rule

Constraints:

N/A

Values:

  • asc: The query results are displayed in ascending order.
  • desc: The query results are displayed in the descending order.

Default value:

N/A

last_sec_min

No

Long

Explanation:

Minimum duration

Constraints:

N/A

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

last_sec_max

No

Long

Explanation:

Maximum duration

Constraints:

N/A

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

task_id

Long

Explanation:

Export task ID

Values:

[0,2^31-1]

Example Request

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/transaction/da304cd5bbb944de828759bc7be3d3fein01/create-export-task 
 
{ 
  "bucket_name" : "obs-test", 
  "file_path" : "", 
  "time_zone" : "GMT+8", 
  "start_at" : 1757729655062, 
  "end_at" : 1758334455062, 
  "order" : "collectTime", 
  "order_by" : "asc", 
  "last_sec_min" : 0, 
  "last_sec_max" : 3600 
}

Example Response

Status code: 200

Successful request

{ 
  "task_id" : 1 
}

Status Codes

Status Code

Description

200

Successful request

400

Client error

500

Server error

Error Codes

See Error Codes.