华为云服务器查询云服务器列表_云淘科技
功能介绍
查询云服务器信息列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2.1/{project_id}/servers?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
参数说明请参见表1。
|
参数 |
是否必选 |
描述 |
|---|---|---|
|
project_id |
是 |
项目ID。 获取方法请参见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
changes-since |
否 |
String |
云服务器上次更新状态的时间戳信息，过滤出该时间戳之后状态更新的云服务器。格式符合ISO 8601，采用UTC +0时区。CCYY-MM-DDThh:mm:ss+/-hh:mm，例如：2018-01-17T03:03:32Z 。 |
|
image |
否 |
String |
镜像ID。 在使用image作为条件过滤时，不能同时支持其他过滤条件和分页条件。如果同时指定image及其他条件，则以image条件为准；当条件不含image时，接口功能不受限制。 |
|
flavor |
否 |
String |
云服务器类型ID，匹配规则为模糊匹配。 |
|
name |
否 |
String |
云服务器名称，匹配规则为模糊匹配。 |
|
status |
否 |
String |
云服务器状态。 取值范围： ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE 直到2.37微版本，非上面范围的status字段将返回空列表，微版本2.38及以上版本，将返回400错误。 云服务器状态说明请参考云服务器状态。 |
|
limit |
否 |
Integer |
查询返回云服务器数量限制。 每页默认值是25，最多返回1000台云服务器的信息。 |
|
marker |
否 |
String |
从marker指定的云服务器ID的下一条数据开始查询。 |
|
tags |
否 |
String |
查询tag字段中包含该值的云服务器。 |
|
not-tags |
否 |
String |
查询tag字段中不包含该值的云服务器，值为标签的Key。 说明： 系统近期对标签功能进行了升级。如果之前添加的Tag为“Key.Value”的形式，则查询的时候需要使用“Key”来查询。 例如：之前添加的tag为“a.b”,则升级后，查询时需使用“not-tags=a”。 |
|
reservation_id |
否 |
String |
批量创建弹性云服务器时，指定返回的ID，用于查询本次批量创建的弹性云服务器。 |
|
sort_key |
否 |
String |
查询结果按弹性云服务器属性排序，默认排序顺序为created_at逆序。 取值范围：created_at,availability_zone,display_name,host,instance_type_id,key_name,project_id,user_id,updated_at,uuid,vm_state |
|
ip |
否 |
String |
IPv4地址过滤结果，匹配规则为模糊匹配。 |
请求消息
无
响应消息
响应参数如表3所示。
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
servers |
Array of objects |
查询云服务器信息列表，请参见表4。 |
|
servers_links |
Array of objects |
分页查询时，查询下一页数据链接，详情请参见表5 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
云服务器名称。 |
|
id |
String |
云服务器唯一标识。 |
|
links |
Array of objects |
云服务器相关快捷链接信息，详情请参见表5。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rel |
String |
快捷链接标记名称。 |
|
href |
String |
对应快捷链接。 |
请求示例
查询云服务器信息列表。
GET https://{endpoint}/v2.1/{project_id}/servers
响应示例
{
"servers": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19",
"rel": "bookmark"
}
],
"name": "new-server-test"
}
]
}
返回值
请参考通用请求返回值。
父主题： 生命周期管理
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
