接口說明
查詢 云服務器 信息列表。
約束說明
無
URL
GET https://ecs.cn-north-1.myhuaweicloud.com/v2.1/{project_id}/servers
請求參數(shù)
| 名稱 | 類型 | 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 | 否 |
返回參數(shù)
返回碼: 200
OK
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
servers
|
Array of NovaSimpleServer objects | 是 |
查詢云服務器信息列表 |
|
servers_links
|
Array of PageLink objects | 否 |
分頁查詢時,查詢下一頁數(shù)據鏈接。 |
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"
}
]
}
錯誤碼
請參考 錯誤碼說明。
