API for Querying the Coordinator Running Status

Function

Queries the Coordinator running status.

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/coordinator_info

  • 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.

Request Parameters

None

Usage Example

Request example:

GET https://{ip}:{port}/v1/coordinator_info

Response example:

{
    "schedule_info": [
        {
            "id": 0,
            "allocated_slots": 10,
            "allocated_blocks": 10
        },
        {
            "id": 1,
            "allocated_slots": 10,
            "allocated_blocks": 10
        }
    ],
    "request_length_info": {
        "input_len": 100,
        "output_len": 100
    }
}

Output Description

Parameter

Type

Description

schedule_info

object[]

Mandatory.

Node scheduling information.

id

uint64_t

Mandatory.

Node ID.

allocated_slots

size_t

Mandatory.

Number of allocated slots.

allocated_blocks

size_t

Mandatory.

Number of allocated blocks.

request_length_info

-

Mandatory.

Average input and output length of a request.

input_len

size_t

Mandatory.

Average input length of a request.

output_len

size_t

Mandatory.

Average output length of a request.