批量查询物理服务器
功能介绍
查询物理服务器列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/physicalservers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
manage_state |
否 |
String |
参数解释: 服务器管理状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
marker |
否 |
String |
参数解释: 上一页数据的最后一条记录的id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
limit |
否 |
Integer |
参数解释: 分页查询时每页行数。 约束限制: 不涉及 取值范围: 10-1000,当不设置值或设置的值小于 10 时,默认值为 10。当设置的值大于 1000 时,默认值为 1000。 默认取值: 10 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
servers |
Array of PhysicalServer objects |
参数解释: 服务器列表分页 约束限制: 不涉及 |
page_info |
PageInfo object |
参数解释: 分页信息 约束限制: 不涉及 |
count |
Integer |
参数解释: 服务器总数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 服务器ID 约束限制: 不涉及 取值范围: uuid格式 默认取值: 不涉及 |
name |
String |
参数解释: 物理服务器名称,在创建实例时作为hostname 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
project_id |
String |
参数解释: 项目ID 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
domain_id |
String |
参数解释: domain ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
manage_state |
String |
参数解释: 服务器管理状态 约束限制: 不涉及 取值范围
默认取值: 不涉及 |
power_state |
String |
参数解释: 电源状态 power_state 会根据不同的操作和事件发生转换,常见的状态转换流程如下: 约束限制: 不涉及 取值范围:
示例场景:
默认取值: 不涉及 |
health_state |
String |
参数解释: 硬件健康状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
onboard_time |
String |
参数解释: 上架时间 约束限制: 不涉及 取值范围: 使用RFC 3339格式,例如:2025-04-22T12:03:18.50083+08:00 默认取值: 不涉及 |
location |
Location object |
参数解释: 物理服务器部署位置信息 约束限制: 不涉及 |
hardware_attributes |
HardwareSummary object |
参数解释: 硬件总览信息,包括服务器的制造商、型号、序列号等 约束限制: 不涉及 |
tags |
Array of Tag objects |
参数解释: 标签 约束限制: 不涉及 |
error |
ErrorStatus object |
参数解释: 失败时返回的错误对象 约束限制: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
dc |
String |
参数解释: 机房名称 约束限制: 不涉及 取值范围: 只能由中文字符、英文字母(a~z,A~Z)、数字(0~9)、下划线(_)、中划线(-)、点(.)组成,且大小不超过256字节 默认取值: 不涉及 |
rack |
String |
参数解释: 机柜名称 约束限制: 不涉及 取值范围: 由英文字母(a~z,A~Z)、数字(0~9)、下划线(_)、中划线(-)、点(.)组成,不能以中划线或者点开头,且大小不超过128字节 默认取值: 不涉及 |
unit |
String |
参数解释: 机柜U位 约束限制: 不涉及 取值范围: 大小不超过128字节 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
sn |
String |
参数解释: serial number 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
manufacturer |
String |
参数解释: 制造商 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
model |
String |
参数解释: 型号 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
main_board_manufacturer |
String |
参数解释: 主板厂商 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
参数解释: 标签key值 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
value |
String |
参数解释: 标签value值 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_type |
String |
参数解释: 错误类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
next_marker |
String |
参数解释: 下一页查询地址 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
previous_marker |
String |
参数解释: 上一页查询地址 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
current_count |
Integer |
参数解释: 本页返回条目数量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:429
参数 |
参数类型 |
描述 |
---|---|---|
- |
String |
- |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
查询物理服务器列表
GET https://{endpoint}/v1/{project_id}/physicalservers?marker={marker}&limit={limit}
响应示例
状态码:200
物理服务器查询分页
{ "servers" : [ { "id" : "0195d690-cfd4-7303-a1e1-707f2f863921", "name" : "test-host-102", "project_id" : "e750c9499ffb4244add7398a0af4f215", "domain_id" : "aef171e13fe24458a819bb42870571d9", "manage_state" : "ready", "power_state" : "", "health_state" : "", "onboard_time" : "2025-03-27T15:46:09.492642+08:00", "location" : { "dc" : "Room_room_003", "rack" : "cabinet_room_003_1", "unit" : "SN_26_151_241_102" }, "hardware_attributes" : { "sn" : "SN_26_151_241_102", "manufacturer" : "Huawei", "model" : "2288H v108" }, "tags" : [ { "key" : "2", "value" : "3" } ], "error" : { "error_code" : "", "error_msg" : "inspect imetal job failed, please contact oncall", "error_type" : "verify_server_error" }, "ops_result" : "InspectError", "az_id" : "", "region_id" : "", "bmc_firmware_version" : "" } ], "page_info" : { "next_marker" : "0197f36d-d84f-7d92-8d00-dd29b81b9498", "current_count" : 1000 }, "count" : 1763 }
状态码
状态码 |
描述 |
---|---|
200 |
物理服务器查询分页 |
400 |
请求参数错误,请求失败 |
401 |
请求未鉴权 |
429 |
请求过载 |
500 |
服务端内部错误 |
错误码
请参见错误码。