裸金属服务器 BMS-查询裸金属服务器详情列表(OpenStack原生):请求参数

时间:2024-10-22 15:30:17

请求参数

参数

是否必选

参数类型

描述

changes-since

String

裸金属服务器上次更新状态的时间戳信息。格式为ISO 8601时间格式,例如:2013-06-09T06:42:18Z。

image

String

镜像ID。

可以在 镜像服务 控制台查询,也可以调用“查询镜像列表”API获取。

说明:

在使用image作为条件过滤时,不能同时支持其他过滤条件和分页条件。如果同时指定image及其他条件,则以image条件为准;当条件不含image时,接口功能不受限制。

flavor

String

规格ID。

可以在裸金属服务器控制台查询,也可以调用查询裸金属服务器规格信息列表(OpenStack原生)API获取。

name

String

裸金属服务器名称,使用模糊匹配的方式查询。

例如,“?name=bob”正则表达式会同时返回bob和bobb。如果必须仅匹配bob,则可以使用与基础数据库服务器的语法相匹配的正则表达式,如MySQL或PostgreSQL(官方网站:https://www.postgresql.org/docs/9.2/static/functions-matching.html)。

status

String

裸金属服务器状态。

取值范围:

  • ACTIVE:运行中/正在关机/删除中
  • BUILD:创建中
  • ERROR:故障
  • HARD_REBOOT:强制重启中
  • REBOOT:重启中
  • SHUTOFF:关机/正在开机/删除中/重建中/重装操作系统中/重装操作系统失败/冻结

limit

Integer

每页返回裸金属服务器的条数。

marker

String

从marker指定的裸金属服务器ID的下一条数据开始查询。

tags

String

查询tag字段中包含该值的裸金属服务器

微版本2.26新增

not-tags

String

查询tag字段中不包含该值的裸金属服务器,值为标签的Key。

说明:

如果之前添加的Tag为“Key.Value”的形式,则查询的时候需要使用“Key”来查询。

例如:之前添加的tag为“a.b”,则升级后,查询时需使用“not-tags=a”。

微版本2.26新增

reservation_id

String

批量创建裸金属服务器时,指定该预留ID,可以查询同批次创建的裸金属服务器

微版本2.26新增

sort_key

String

用于排序的属性,包括uuid(裸金属服务器的uuid)、vm_state(裸金属服务器的状态)、display_name(裸金属服务器名称)、task_state(裸金属服务器任务状态)、power_state(电源状态)、created_at(创建时间)、updated_at(更新时间)、availability_zone(可用区)。可以指定多对sort_key和sort_dir。

默认排序顺序为created_at逆序。

sort_dir

String

排序方向。

  • asc:升序
  • desc:降序(默认值)
support.huaweicloud.com/api-bms/bms_api_0710.html