接口说明
查询 云服务器 信息列表。
约束说明
无
URL
GET https://ecs.cn-north-1.myhuaweicloud.com/v2.1/{project_id}/servers
请求参数
| 名称 | 类型 | IN | 必选 |
|---|---|---|---|
|
OpenStack-API-Version
|
string | header | 否 |
|
X-Auth-Token
|
string | header | 是 |
|
project_id
|
string | path | 是 |
|
changes-since
|
string | query | 否 |
|
flavor
|
string | query | 否 |
|
host
|
string | query | 否 |
|
image
|
string | query | 否 |
|
ip
|
string | query | 否 |
|
limit
|
integer | query | 否 |
|
marker
|
string | query | 否 |
|
name
|
string | query | 否 |
|
not-tags
|
string | query | 否 |
|
reservation_id
|
string | query | 否 |
|
sort_key
|
string | query | 否 |
|
status
|
string | query | 否 |
|
tags
|
string | query | 否 |
返回参数
返回码: 200
OK
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
servers
|
Array of NovaSimpleServer objects | 是 |
查询云服务器信息列表 |
|
servers_links
|
Array of PageLink objects | 否 |
分页查询时,查询下一页数据链接。 |
200 servers
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
name
|
string | 是 |
云服务器名称。 |
|
id
|
string | 是 |
云服务器唯一标识。 |
|
links
|
Array of NovaLink objects | 是 |
云服务器相关快捷链接信息。 |
200 servers.links
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
href
|
string | 是 |
相应资源的链接。 |
|
rel
|
string | 是 |
有三种取值。self:自助链接包含版本链接的资源。立即链接后使用这些链接。bookmark:书签链接提供了一个永久资源的永久链接,该链接适合于长期存储。alternate:备用链接可以包含资源的替换表示形式。例如,OpenStack计算映像可能在OpenStack映像服务中有一个替代表示。 |
200 servers_links
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
href
|
string | 是 |
相应资源的链接。 |
|
rel
|
string | 是 |
对应快捷链接。 |
请求示例
示例 1
"GET https://{endpoint}/v2.1/{project_id}/servers?limit=10"
返回示例
返回码：200
OK
示例 1
{
"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"
}
]
}
"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"
}
]
}
错误码
请参考 错误码说明。
