Querying the Task Status

Function

Query the task status.

Precautions

None

Calling Method

GET

URI

/meter/v1/{domain_id}/query-jobs/{job_id}

Path parameters

Query parameters

None

Request

• Request header parameters

  For details, see the header description in the sample request.

• Request body parameters

  None

• Sample request

  GET /meter/v1/{domain_id}/query-jobs/{job_id} HTTP/1.1
  Host: example.com
  Content-Type: application/json
  Accept: application/json
  X-Auth-Token: xxx

Response

• Response parameters
  • Response status code: 200. QueryJobVo is returned.

    Table 2 QueryJobVo object attributes

    Parameter	Mandatory	Type	Value Range	Description
    id	Yes	string	None	Task ID
    status	Yes	string	None	Task status (success, failure, running, or pending)
    progress	Yes	int32	None	Task progress: 0-100%

• Sample response

  HTTP/1.1 200 OK
  Date:Tue,18 Jul 2023 09:58:01 GMT
  Server: example.com
  Content-Type: application/json;charset=UTF8
  {
      "id": "xxx",
      "status": "success",
      "progress": 100
  }

Status Codes

Operation Severity

Minor