动态状态采集接口

接口功能

采集动态状态。

接口格式

操作类型:GET

URLhttps://{ip}:{port}/v1/status

  • {ip}字段优先读取环境变量值MIES_CONTAINER_MANAGEMENT_IP;如果没有该环境变量,则取配置文件的“managementIpAddress”参数;如果配置文件中没有“managementIpAddress”参数,则取配置文件的“ipAddress”参数。
  • {port}字段优先读取配置文件的“managementPort”参数;如果配置文件中没有“managementPort”参数,则取配置文件的“port”参数。

请求参数

使用样例

请求样例:

GET https://{ip}:{port}/v1/status
响应样例:
{
    "service": {
        "roleStatus": "RoleUnknown",
        "currentRole": "prefill"
    },
    "resource": {
        "availSlotsNum": 200,
        "availBlockNum": 1024
    },
    "peers": ["1.2.3.4", "5.6.7.8"]
}

输出说明

参数

是否必选

类型

描述

service

必选

结构体

service相关属性。

resource

必选

结构体

当前剩余资源情况。

peers

可选

字符串数组

数组成员为IP地址,表示已经成功建连的P实例。

  • PD混部场景,或PD分离场景下的P实例不需要返回该字段。
  • PD分离场景下的D实例需要返回该字段。
  • D实例每成功连接一个P后,就向这里增加一个成员。在目标P没有发生变化的情况下,如果跟某个P发生了pull kv失败且不可恢复的情况,就把该P从这里删掉。

service.roleStatus

必选

字符串

表示当前服务的身份切换状态,可选值包括:

  • RoleUnknown
  • RoleSwitching
  • RoleReady

如果是PD混部场景,该状态永远是RoleReady。

service.currentRole

必选

字符串

当前实例的身份,可选值包括:

  • prefill
  • decode
  • none

如果是PD混部场景,该值永远是none。

在PD分离场景下,如果roleStatus进入RoleReady状态,则该值为prefill或decode,如果roleStatus不是RoleReady状态,该值为none。

resource.availSlotsNum

必选

整型

可用的slot数量。

resource.availBlockNum

必选

整型

可用的block数量。