# 查询物理服务器列表 - ListServers #### 功能介绍 查询物理服务器列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-clouddc/clouddc_api_0003.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-clouddc/clouddc_api_0011.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | clouddc:imetal:list | List | - | - | - | - | #### URI GET /v1/{project_id}/physicalservers 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID **约束限制**： 不涉及 **取值范围**： 账号的项目ID **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | manage_state | 否 | String | **参数解释**： 服务器管理状态 **约束限制**： 不涉及 **取值范围**： - onboard：上架中，用户下单，完成LLD设计。 - os-ready: 软调完成 服务器完成软调，即将进行转维。 - ready：交付完成，完成硬装、网调、服务器初始化、软调及转维验收。 - in-use：使用中，用户发放裸机。 - maintain:维护中 服务器故障，进入维修 - offboarding：下架中。 **默认取值**： 不涉及 | | marker | 否 | String | **参数解释**： 上一页数据的最后一条记录的id **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | limit | 否 | Integer | **参数解释**： 分页查询时每页行数。 **约束限制**： 不涉及 **取值范围**： 10-1000，当不设置值或设置的值小于 10 时，默认值为 10。当设置的值大于 1000 时，默认值为 1000。 **默认取值**： 10 | | site | 否 | String | **参数解释**： 服务器归属站点。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 调用接口的认证方式分为Token，如果您使用的Token方式，此参数为必填，请填写Token的值 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | servers | Array of [PhysicalServer] objects | **参数解释**： 服务器列表分页 **约束限制**： 不涉及 | | page_info | [PageInfo] object | **参数解释**： 分页信息 **约束限制**： 不涉及 | | count | Integer | **参数解释**： 服务器总数 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表5PhysicalServer | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 服务器ID **约束限制**： 不涉及 **取值范围**： uuid格式 **默认取值**： 不涉及 | | name | String | **参数解释**： 物理服务器名称，在创建实例时作为hostname **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | project_id | String | **参数解释**： 项目ID **约束限制**： 不涉及 **取值范围**： 账号的项目ID **默认取值**： 不涉及 | | domain_id | String | **参数解释**： 租户ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | manage_state | String | **参数解释**： 服务器管理状态 **约束限制**： 不涉及 **取值范围** - onboard：上架中，用户下单，完成LLD设计。 - os-ready: 软调完成 服务器完成软调，即将进行转维。 - ready：交付完成，完成硬装、网调、服务器初始化、软调及转维验收。 - in-use：使用中，用户发放裸机。 - maintain:维护中 服务器故障，进入维修 - offboarding：下架中。 ``` stateDiagram-v2 [*] --> onboard : 完成LLD设计 onboard --> ready : 完成网调、服务器初始化、软调及转维验收 ready --> in_use : 发放裸机实例 ready --> offboarding : 请求下架 in_use --> ready : 删除裸机实例 in_use --> offboarding : 请求下架 offboarding --> [*] : 完成下架 state "in-use" as in_use ``` **默认取值**： 不涉及 | | frozen_state | Integer | **参数解释**： 服务器冻结状态 **约束限制**： 不涉及 **取值范围** - 0：未冻结。 - 1: 公安冻结。 - 2：违规冻结。 - 3：违规冻结+公安冻结。 - 4：欠费冻结。 - 5：欠费冻结+公安冻结。 - 6：欠费冻结+违规冻结。 - 7：欠费冻结+公安冻结+违规冻结。 ``` **默认取值**： 不涉及 ``` | | power_state | String | **参数解释**： 电源状态 power_state 会根据不同的操作和事件发生转换，常见的状态转换流程如下： - 开机流程：off -\> on - 关机流程：on -\> off - 重启流程：on -\> off -\> on **约束限制**： 不涉及 **取值范围**： - on：表示节点的电源已开启，硬件处于通电状态，操作系统正在运行或者可以正常启动。这意味着节点能够执行计算任务，为上层应用提供服务。 - off：表明节点的电源已关闭，硬件停止供电，所有组件处于非工作状态，无法执行任何计算任务。 **默认取值**： 不涉及 | | operation_state | String | **约束限制**： 不涉及 **取值范围**： - power-on-processing: 节点正在开启电源的过程中，此时硬件开始通电，但操作系统可能还未完全启动。 - power-on-succeed: 开启电源成功。 - power-on-failed: 开启电源失败。 - power-off-processing: 节点正在关闭电源的过程中，操作系统会进行一些清理工作，如保存数据、关闭服务等，然后切断硬件的电源供应。 - power-off-succeed: 关闭电源成功。 - power-off-failed: 关闭电源失败。 - reboot-processing: 节点正在进行重启操作，即先关闭电源，然后再重新开启。在这个过程中，节点会经历硬件初始化和操作系统启动等步骤。 - reboot-succeed: 重启操作成功。 - reboot-failed: 重启操作失败。 **默认取值**： 不涉及 | | health_state | String | **参数解释**： 硬件健康状态 **约束限制**： 不涉及 **取值范围**： - OK：健康 - Warning：警告 - Critical：严重 - Unknown：未知 说明：系统检测到潜在的问题或轻微异常。服务器目前仍然可以正常运行，但风险增加 说明：系统检测到严重的硬件故障或极端异常情况。该问题已经直接影响服务器的稳定性、性能或可用性 说明： 健康状态探测不到，未知状态 **默认取值**： 不涉及 | | 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 | **参数解释**： 失败时返回的错误对象 **约束限制**： 不涉及 | 表6Location | 参数 | 参数类型 | 描述 | |:---|:---|:---| | site | String | **参数解释**： 站点名称（仅限部署在边缘站点的服务器） **约束限制**： 不涉及 **取值范围**： 只能由中文字符、英文字母(a\~z,A\~Z)、数字(0\~9)、下划线(_)、中划线（-）、点（.）组成,且大小不超过256字节 **默认取值**： 不涉及 | | dc | String | **参数解释**： 机房名称 **约束限制**： 不涉及 **取值范围**： 只能由中文字符、英文字母(a\~z,A\~Z)、数字(0\~9)、下划线(_)、中划线（-）、点（.）组成,且大小不超过256字节 **默认取值**： 不涉及 | | rack | String | **参数解释**： 机柜名称 **约束限制**： 不涉及 **取值范围**： 由英文字母(a\~z,A\~Z)、数字(0\~9)、下划线(_)、中划线（-）、点（.）组成,不能以中划线或者点开头,且大小不超过128字节 **默认取值**： 不涉及 | | unit | String | **参数解释**： 机柜U位 **约束限制**： 不涉及 **取值范围**： 大小不超过128字节 **默认取值**： 不涉及 | 表7HardwareSummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sn | String | **参数解释**： serial number **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | manufacturer | String | **参数解释**： 制造商 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | model | String | **参数解释**： 型号 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | main_board_manufacturer | String | **参数解释**： 主板厂商 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | main_board_serial_number | String | 主板序列号 | 表8Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签key值 **约束限制**： 不涉及 **取值范围**： - 不能为空且首尾不能包含空格，最多支持128个字符 - 可用UTF-8格式表示的任意语种字母、数字和空格 - 支持部分特殊字符：_.:=+-@ - 不能以"_sys_"开头 **默认取值**： 不涉及 | | value | String | **参数解释**： 标签value值 **约束限制**： 不涉及 **取值范围**： - 可以为空但不能缺省，最多支持255个字符 - 可用UTF-8格式表示的汉字、字母、数字和空格 - 支持部分特殊字符：_.:/=+-@ **默认取值**： 不涉及 | 表9ErrorStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 | | error_msg | String | **参数解释**： 错误描述 | | error_type | String | **参数解释**： 错误类型 **约束限制**： 不涉及 **取值范围**： - power_off_error：关机异常 - power_on_error：开机异常 - reboot_failed_error：重启异常 **默认取值**： 不涉及 | 表10PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释**： 下一页查询地址 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | previous_marker | String | **参数解释**： 上一页查询地址 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | current_count | Integer | **参数解释**： 本页返回条目数量 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | **状态码：400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 | | error_msg | String | **参数解释**： 错误描述 | **状态码：401** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 | | error_msg | String | **参数解释**： 错误描述 | **状态码：429** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | - | **状态码：500** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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" : { "site" : "site_003", "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" } } ], "page_info" : { "next_marker" : "0197f36d-d84f-7d92-8d00-dd29b81b9498", "current_count" : 1000 }, "count" : 1763 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 物理服务器查询分页 | | 400 | 请求参数错误，请求失败 | | 401 | 请求未鉴权 | | 429 | 请求过载 | | 500 | 服务端内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-clouddc/ErrorCode.html)。