API for Querying Node Request Status

Function

Queries the request status of a node.

This API does not need to be called by users. It is a communication API between the Coordinator and Controller.

Format

Operation type: GET

URL: https://{ip}:{port}/v1/instances/tasks?{key}={value}&{key}={value}

  • Preferably set {ip} to {manage_ip} in Starting Coordinator. If the parameter is not configured, set {ip} to the value of the manage_ip parameter in the ms_coordinator.json configuration file.
  • Preferably set {port} to {manage_port} in Starting Coordinator. If the parameter is not configured, set {port} to the value of the manage_port parameter in the ms_coordinator.json configuration file.
  • The ${key} field can only be set to "id".
  • ${value} indicates the node ID.
  • Use ampersands (&) to separate multiple {key}={value}s.

Request Parameters

None

Usage Example

Request example:

GET https://{ip}:{port}/v1/instances/tasks?id=1&id=2&id=3

Response example:

{
    "tasks": [0,0,0]
}

Output Description

Parameter

Type

Description

tasks

uint64_t[]

Number of remaining tasks on each query node.