更新时间:2025-07-25 GMT+08:00
分享

服务器概览

功能介绍

该 API 用于查询服务器概览、服务器开机状态和服务器运行状态

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/physicalservers/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID

约束限制

不涉及

取值范围

账号的项目ID

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

server_status

ServerStatus object

参数解释

服务器运行状态响应对象

约束限制

不涉及

server_power_status

ServerPowerStatus object

参数解释

服务器电源状态对象

约束限制

不涉及

表4 ServerStatus

参数

参数类型

描述

total

ServerState object

参数解释

服务器运行状态所有对象

约束限制

不涉及

ok

Map<String,ServerState>

参数解释

服务器运行OK状态所有对象

约束限制

不涉及

warning

Array of ServerState objects

参数解释

服务器运行Warning状态所有对象

约束限制

不涉及

critical

Array of ServerState objects

参数解释

服务器运行Critical状态所有对象

约束限制

不涉及

health

Array of ServerState objects

参数解释

服务器运行Health状态所有对象

约束限制

不涉及

unhealth

Array of ServerState objects

参数解释

服务器运行UnHealth状态所有对象

约束限制

不涉及

isolation

Array of ServerState objects

参数解释

服务器运行Isolation状态所有对象

约束限制

不涉及

表5 ServerState

参数

参数类型

描述

count

Integer

参数解释

数量

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

dc_stats

Map<String,String>

参数解释

数据中心名称对应数量映射

约束限制

不涉及

表6 ServerPowerStatus

参数

参数类型

描述

on

Integer

参数解释

开机状态的数量

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

off

Integer

参数解释

关机状态的数量

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

unknown

Integer

参数解释

未知状态的数量

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:429

表9 响应Body参数

参数

参数类型

描述

-

String

-

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

error_msg

String

参数解释

错误描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求示例

服务器概览

GET https://{endpoint}/v1/{project_id}/physicalservers/status

响应示例

状态码:200

{
  "server_status" : {
    "total" : {
      "count" : 1758,
      "dc_stats" : {
        "BBB" : 599,
        "DC-062501" : 1,
        "DC-Room" : 1,
        "EquipmentRoom_001" : 16,
        "EquipmentRoom_0707" : 501,
        "EquipmentRoom_0707_new" : 2,
        "EquipmentRoom_CloudDC_pytest" : 2,
        "Equipment_room001" : 2,
        "Room_001" : 2,
        "Room_002" : 1,
        "Room_room_003" : 3,
        "chennantest001" : 1,
        "chntest001" : 5,
        "chntest002" : 1,
        "irack_dc_TEST" : 26,
        "pref_donot_operation_dc_1" : 56,
        "pref_room_1003" : 1,
        "pref_room_1883" : 1,
        "pref_room_1903" : 1,
        "rooooooom_1347" : 1,
        "rooooooom_698" : 513,
        "rooooooom_700" : 20,
        "rooooooom_701" : 1,
        "test" : 1
      }
    },
    "ok" : {
      "count" : 12,
      "dc_stats" : {
        "BBB" : 9,
        "EquipmentRoom_001" : 1,
        "rooooooom_698" : 1,
        "rooooooom_700" : 1
      }
    },
    "warning" : {
      "count" : 0,
      "dc_stats" : { }
    },
    "critical" : {
      "count" : 1,
      "dc_stats" : {
        "rooooooom_700" : 1
      }
    },
    "health" : {
      "count" : 12,
      "dc_stats" : {
        "BBB" : 9,
        "EquipmentRoom_001" : 1,
        "rooooooom_698" : 1,
        "rooooooom_700" : 1
      }
    },
    "isolation" : {
      "count" : 0,
      "dc_stats" : { }
    }
  },
  "server_power_status" : {
    "on" : 9,
    "off" : 4,
    "unknown" : 1745
  }
}

状态码

状态码

描述

200

-

400

请求参数错误,请求失败

401

请求未鉴权

429

请求过载

500

服务端内部错误

错误码

请参见错误码

相关文档