Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Data Processing/ Obtaining the Data Processing Rule Update Result for a Specified Task
Updated on 2024-03-27 GMT+08:00

Obtaining the Data Processing Rule Update Result for a Specified Task

Function

This API is used to obtain the data processing rule update result for a specified task.

URI

GET /v5/{project_id}/jobs/{job_id}/data-processing-rules/result

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

query_id

Yes

String

ID of the data processing rule update request

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

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.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header.

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Query result ID.

job_id

String

Task ID.

status

String

Query status.

Enumerated values:

  • pending
  • failed
  • success

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

Example Request

Obtaining the data processing rule update result for a specified task

GET https://{endPoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/data-processing-rules/result?query_id=009bb221-2794-4767-91e6-6ed7f79792b4

Example Response

Status code: 200

OK

{
  "id" : "009bb221-2794-4767-91e6-6ed7f79792b4",
  "job_id": "177738d1-4eee-4fcb-a4e1-09aea79jb20i",
  "status" : "success"
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job ID."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.