-
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。 表1 路径参数 参数 是否必选 描述 project_id 是 项目ID。 获取方法请参见获取项目ID。
-
响应消息 响应参数如表3所示。 表3 响应参数 参数 参数类型 描述 servers Array of objects 查询云服务器信息列表,请参见表4。 servers_links Array of objects 分页查询时,查询下一页数据链接,详情请参见表5 表4 servers字段数据结构说明 参数 参数类型 描述 name String 云服务器名称。 id String 云服务器唯一标识。 links Array of objects 云服务器相关快捷链接信息,详情请参见表5。 表5 servers_links,links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 href String 对应快捷链接。
-
响应示例 {
"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"
}
]
}
-
URI GET /v2.1/{project_id}/servers/detail?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。 表1 路径参数 参数 是否必选 描述 project_id 是 项目ID。 获取方法请参见获取项目ID。
-
响应示例 {
"servers": [
{
"addresses": {
"68269e6e-4a27-441b-8029-35373ad50bd9": [
{
"addr": "192.168.0.3",
"version": 4
}
]
},
"created": "2012-09-07T16:56:37Z",
"flavor": {
"id": "s3.xlarge.2",
"links": [
{
"href": "http://openstack.example.com/openstack/flavors/s3.xlarge.2",
"rel": "bookmark"
}
]
},
"hostId": "16d193736a5cfdb60c697ca27ad071d6126fa13baeb670fc9d10645e",
"id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
"image": "",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
],
"metadata": {},
"name": "new-server-test",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2012-09-07T16:56:37Z",
"user_id": "fake"
}
]
}
-
响应示例 {
"servers": [
{
"addresses": {
"68269e6e-4a27-441b-8029-35373ad50bd9": [
{
"addr": "192.168.0.3",
"version": 4
}
]
},
"created": "2012-09-07T16:56:37Z",
"flavor": {
"id": "s3.xlarge.2",
"links": [
{
"href": "http://openstack.example.com/openstack/flavors/s3.xlarge.2",
"rel": "bookmark"
}
]
},
"hostId": "16d193736a5cfdb60c697ca27ad071d6126fa13baeb670fc9d10645e",
"id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
"image": "",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
],
"metadata": {},
"name": "new-server-test",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2012-09-07T16:56:37Z",
"user_id": "fake"
}
]
}
-
URI GET /v2.1/{project_id}/servers/detail?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。 表1 路径参数 参数 是否必选 描述 project_id 是 项目ID。 获取方法请参见获取项目ID。
-
响应示例 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89 {
"servers": [
{
"tenant_id": "c685484a8cc2416b97260938705deb64",
"addresses": {
"08a7715f-7de6-4ff9-a343-95ba4209f24a": [
{
"OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77",
"OS-EXT-IPS:type": "fixed",
"addr": "192.168.0.107",
"version": 4
}
]
},
"metadata": {
"op_svc_userid": "1311c433dd9b408886f57d695c229cbe"
},
"OS-EXT-STS:task_state": null,
"OS-DCF:diskConfig": "MANUAL",
"OS-EXT-AZ:availability_zone": "az-dc-1",
"links": [
{
"rel": "self",
"href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
},
{
"rel": "bookmark",
"href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
}
],
"OS-EXT-STS:power_state": 1,
"id": "95bf2490-5428-432c-ad9b-5e3406f869dd",
"os-extended-volumes:volumes_attached": [
{
"id": "dfa375b5-9856-44ad-a937-a4802b6434c3"
},
{
"id": "bb9f1b27-843b-4561-b62e-ca18eeaec417"
},
{
"id": "86e801c3-acc6-465d-890c-d43ba493f553"
},
{
"id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6"
}
],
"OS-EXT-SRV-ATTR:host": "bms.az1",
"image": {
"links": [
{
"rel": "bookmark",
"href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319"
}
],
"id": "1a6635d8-afea-4f2b-abb6-27a202bad319"
},
"OS-SRV-USG:terminated_at": null,
"accessIPv4": "",
"accessIPv6": "",
"created": "2017-05-24T06:14:05Z",
"hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e",
"OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2",
"key_name": "$key_name",
"flavor": {
"links": [
{
"rel": "bookmark",
"href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium"
}
],
"id": "physical.83.medium"
},
"security_groups": [
{
"name": "0011b620-4982-42e4-ad12-47c95ca495c4"
}
],
"config_drive": "",
"OS-EXT-STS:vm_state": "active",
"OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3",
"user_id": "1311c433dd9b408886f57d695c229cbe",
"name": "bms",
"progress": 0,
"OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078",
"updated": "2017-05-25T03:40:25Z",
"status": "ACTIVE"
}
]
}
-
请求示例 查询裸金属服务器的详情列表。 1 https://{E
CS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail
查询标签中包含__type_baremetal的裸金属服务器的详情列表。 1 https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal
查询标签中包含__type_baremetal且名称包含bms-test01的裸金属服务器的详情列表。 1 https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal&name=bms-test01
-
URI GET /v2.1/{project_id}/servers/detail{?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&tags={tags}¬-tags={not-tags}&reservation_id={reservation_id}&sort_key={sort_key}&sort_dir={sort_dir}} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。
-
请求参数 参数 是否必选 参数类型 描述 changes-since 否 String 裸金属服务器上次更新状态的时间戳信息。格式为ISO 8601时间格式,例如:2013-06-09T06:42:18Z。 image 否 String 镜像ID。 可以在
镜像服务 控制台查询,也可以调用“查询镜像列表”API获取。 说明: 在使用image作为条件过滤时,不能同时支持其他过滤条件和分页条件。如果同时指定image及其他条件,则以image条件为准;当条件不含image时,接口功能不受限制。 flavor 否 String 规格ID。 可以在裸金属服务器控制台查询,也可以调用查询裸金属服务器规格信息列表(废弃)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:降序(默认值)
-
响应示例 { "server": { "tenant_id": "7910a6e50b80402ba028c8d96c1b31fe", "image": "", "accessIPv4": "", "addresses": { "03be5c1e-e05d-4905-a105-c3bd9b730bdc": [ { "addr": "192.168.0.72", "version": 4 } ] }, "metadata": {}, "accessIPv6": "", "created": "2018-05-17T03:15:48Z", "hostId": "7dc82f6b1d406200fc63e395cf4829cbffcb49de0e9c75c5773f201f", "flavor": { "links": [ { "rel": "bookmark", "href": "https://None/7910a6e50b80402ba028c8d96c1b31fe/flavors/c3.1U1G" } ], "id": "c3.1U1G" }, "OS-DCF:diskConfig": "MANUAL", "user_id": "d698a78532ca430f8daec1858f2b500e", "name": "new-server-test", "progress": 0, "links": [ { "rel": "self", "href": "https://None/v2/7910a6e50b80402ba028c8d96c1b31fe/servers/1a19ef4f-be0a-4526-bf2f-14b4464d536a" }, { "rel": "bookmark", "href": "https://None/7910a6e50b80402ba028c8d96c1b31fe/servers/1a19ef4f-be0a-4526-bf2f-14b4464d536a" } ], "id": "1a19ef4f-be0a-4526-bf2f-14b4464d536a", "updated": "2018-05-21T00:36:27Z", "status": "ACTIVE" }}
-
请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 server 是 Object 云服务器数据结构,详情请参见表3 表3 server字段数据结构说明 参数 是否必选 参数类型 描述 name 否 String 修改后的云服务器名称,字符长度范围为1-255。 description 否 String 对弹性云服务器的任意描述,最大255字节。 微版本2.19及以上版本支持。