Help Center/ Data Replication Service/ API Reference/ APIs V5.0/ Workload Replay/ Querying the Report File Export Status of a Workload Replay Task
Updated on 2026-09-07 GMT+08:00
View PDF
Share

Querying the Report File Export Status of a Workload Replay Task

Function

Querying the Report File Export Status of a Workload Replay Task

Authorization Information

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

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v5/{project_id}/jobs/{job_id}/sql-export-status

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

For details about how to obtain the task ID, see Obtaining a Task ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

file_type

Yes

String

Type of the SQL file to export. Values:

  • abnormal_sql: abnormal SQL statement list

  • abnormal_sql_detail: abnormal SQL statement details

  • slow_sql: slow SQL statement list

  • slow_sql_detail: slow SQL statement details

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Auth-Token

Yes

String

User token obtained from IAM. It is a response to the API for obtaining a user token. After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

Enumerated values:

  • en-us

  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

export_status

String

Export status. Values:

  • EXPORTING: The export is in progress.

  • EXPORT_COMPLETE: The export is complete.

  • EXPORT_COMMON_FAILED: The export failed.

job_id

String

Task ID.

file_type

String

Type of the exported SQL file. The value can be:

  • abnormal_sql: abnormal SQL statement list

  • error_sql_detail: abnormal SQL statement details

  • slow_sql: slow SQL statement list

  • slow_sql_detail: slow SQL statement details

failed_reason

String

Failure cause.

total_count

Long

Total amount of the exported data.

current_count

Long

Amount of data that has been processed.

progress_percentage

Integer

Task progress, in percentage.

uploaded_file_names

Array of strings

Name of the file that has been uploaded to OBS.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the export status of the abnormal SQL list file of a workload replay task

https://{endpoint}/v5/246765b9f59445c3919fce121ea801f4/jobs/70e22c43-79e0-426a-8c97-0054efdjb60a/sql-export-status?file_type=abnormalSql

Example Response

Status code: 200

OK

{
  "export_status" : "EXPORT_COMPLETE",
  "job_id" : "70e22c43-79e0-426a-8c97-0054efdjb60a",
  "file_type" : "abnormal_sql",
  "total_count" : 44,
  "current_count" : 44,
  "progress_percentage" : 100,
  "uploaded_file_names" : [ "70e22c43-79e0-426a-8c97-0054efdjb60a_abnormalSql_1.zip" ]
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10020000",
  "error_msg" : "Incorrect parameter type."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Workload Replay