文档首页/ 弹性云服务器 ECS/ API参考/ API/ 生命周期管理/ 查询云服务器详情列表
更新时间：2024-11-14 GMT+08:00
查看PDF
分享

查询云服务器详情列表

功能介绍

根据用户请求条件筛选、查询所有的弹性云服务器，并关联获取弹性云服务器的详细信息。

该接口支持查询弹性云服务器计费方式，以及是否被冻结。

接口约束

当前云服务器详情列表中未包含包年/包月云服务器到期时间，如需获取，可以通过客户运营能力相关接口进行查询，详细内容，请参见查询客户包年/包月资源列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/cloudservers/detail?flavor={flavor}&name={name}&status={status}&limit={limit}&offset={offset}&not-tags={not-tags}&reservation_id={reservation_id}&enterprise_project_id={enterprise_project_id}&tags={tags}&ip={ip}

参数说明请参见表1。
表1 路径参数

参数

是否必选

描述

project_id

是

项目ID。

获取方法请参见获取项目ID。
表2 查询参数

参数

是否必选

参数类型

描述

offset

否

Integer

页码（废弃，不推荐使用，建议使用marker进行分页查询）。

当前页面数，默认值为1，取值范围大于等于0。

当取值为0时，系统默认返回第1页，与取值为1时相同。

建议设置该参数大于等于1。

marker

否

String

以单页最后一条server的id作为分页标记。

flavor

否

String

云服务器规格ID。

已上线的规格请参见《弹性云服务器产品介绍》的“实例规格”章节。

name

否

String

云服务器名称，匹配规则为模糊匹配。

支持特殊字符，例如，"." 匹配除换行符（\n、\r）之外的任何单个字符，相等于 [^\n\r]。

status

否

String

云服务器状态。

取值范围：

ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED、SHELVED、SHELVED_OFFLOADED 、UNKNOWN

弹性云服务器状态说明请参考云服务器状态

说明：

当云服务器处于中间状态时，查询范围如下：

  • ACTIVE，查询范围：ACTIVE，REBOOT，HARD_REBOOT，REBUILD，MIGRATING、RESIZE
  • SHUTOFF，查询范围：SHUTOFF，RESIZE，REBUILD
  • ERROR，查询范围：ERROR，REBUILD
  • VERIFY_RESIZE，查询范围：VERIFY_RESIZE，REVERT_RESIZE

limit

否

Integer

查询返回云服务器列表当前页面的数量。

每页默认值是25，最多返回1000台云服务器的信息，如果数据量过大建议设置成200。

tags

否

String

查询tag字段中包含该值的云服务器。

not-tags

否

String

查询tag字段中不包含该值的云服务器。

示例：查询的云服务器列表中不包含裸金属服务器，该字段设置如下：not-tags=__type_baremetal

reservation_id

否

String

使用Openstack Nova 接口批量创建弹性云服务器时，会返回该ID，用于查询本次批量创建的弹性云服务器。

enterprise_project_id

否

String

查询绑定某个企业项目的弹性云服务器。

若需要查询当前用户所有企业项目绑定的弹性云服务器，请传参all_granted_eps。

说明：
  • 查询的企业项目需具备ecs:cloudServers:list的权限。

    如果用户只有某个企业项目的权限，则需要传递该参数，查询指定企业项目绑定的弹性云服务器，否则会因权限不足而报错。

  • 当前all_granted_eps支持查询的企业项目个数不超过100。

ip

否

String

IPv4地址过滤结果，匹配规则为模糊匹配。

此处IP为云服务器的私有IP。

ip_eq

否

String

IPv4地址过滤结果，匹配规则为精确匹配。

此处IP为云服务器的私有IP。

server_id

否

String

云服务器ID，格式为UUID，匹配规则为精确匹配

示例：server_id={id1}&server_id={id2}

说明：
  • 在使用server_id作为过滤条件时，不能同时使用其他过滤条件。如果同时指定server_id及其他过滤条件，则以server_id条件为准，其他过滤条件会被忽略
  • 当server_id中含有不存在的云服务器ID时，返回的响应参数中该云服务器ID对应的servers结构体中除了id和fault其它字段均为null
  • 为了避免API的URI过长，建议一次查询的server_id个数不超过100个

请求消息

无

响应消息

响应参数如表3所示。
表3 响应参数

参数

参数类型

描述

servers

Array of objects

弹性云服务器详情列表，具体参照表3接口。

count

Integer

弹性云服务器的总数。

请求示例

查询云服务器详情列表，每页返回10个记录，从第1页开始。

GET https://{endpoint}/v1/{project_id}/cloudservers/detail?offset=1&limit=10

响应示例

{
    "count":4,
    "servers":[
        {
            "fault":null,
            "id":"b37fd80e-ac67-4d02-b9f1-9891c9c0fabf",
            "name":"ecs-5e70",
            "addresses":{
                "164489f6-cbf7-45b4-b6d0-d407c48cf7fc":[
                    {
                        "version":"4",
                        "addr":"192.168.0.206",
                        "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:95:88:3f",
                        "OS-EXT-IPS:port_id":"7b5d615c-186d-4646-9cb8-444addfe9b92",
                        "OS-EXT-IPS:type":"fixed"
                    },
                    {
                        "version":"4",
                        "addr":"192.168.0.8",
                        "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:1d:88:43",
                        "OS-EXT-IPS:port_id":"dda2027b-2f03-497b-8d42-620da2baacc3",
                        "OS-EXT-IPS:type":"fixed"
                    }
                ]
            },
            "flavor":{
                "disk":"0",
                "vcpus":"2",
                "ram":"1024",
                "id":"c3.large.2",
                "name":"c3.large.2",
                "gpus": [],
                "asic_accelerators": [] 
            },
            "accessIPv4":"",
            "accessIPv6":"",
            "status":"SHUTOFF",
            "image":{
                "id":"1ce5800a-e487-4c1b-b264-3353a39e2b4b"
            },
            "hostId":"f92345b97fd291f67a29ed735a82a8983f370175d2ba3d18d66893f4",
            "updated":"2018-08-14T07:26:49Z",
            "created":"2018-08-13T13:46:09Z",
            "metadata":{
                "metering.image_id":"af60e0d5-6952-4f3d-b0ed-31bb19d4a692",
                "metering.resourcespeccode":"c3.large.2.linux",
                "image_name":"HEC_Public_Cloudinit_CentOS_7.4_64bit",
                "metering.product_id":"00301-253164-0--0",
                "os_bit":"64",
                "lockSourceId":"",
                "lockScene":"",
                "metering.order_id":"CS1808132145NRVRE",
                "lockCheckEndpoint":"",
                "metering.imagetype":"gold",
                "lockSource":"",
                "metering.resourcetype":"1",
                "vpc_id":"164489f6-cbf7-45b4-b6d0-d407c48cf7fc",
                "os_type":"Linux",
                "charging_mode":"1"
            },
            "tags":[

            ],
            "description":"ecs-4cff",
            "locked":false,
            "config_drive":"",
            "tenant_id":"edcb94a885a84ed3a3fdf8ea4d2741da",
            "user_id":"bb7f23e27e7e46f3aaceb5f53a158bdc",
            "os-extended-volumes:volumes_attached":[
                {
                    "device":"/dev/sda",
                    "bootIndex":"0",
                    "id":"2edc879f-022e-4bd6-b079-95a27564d449",
                    "delete_on_termination":"false"
                }
            ],
            "OS-EXT-STS:task_state":null,
            "OS-EXT-STS:power_state":4,
            "OS-EXT-STS:vm_state":"stopped",
            "OS-EXT-SRV-ATTR:host":"az1.dc1",
            "OS-EXT-SRV-ATTR:instance_name":"instance-00137941",
            "OS-EXT-SRV-ATTR:hypervisor_hostname":"nova001@248",
            "OS-DCF:diskConfig":"MANUAL",
            "OS-EXT-AZ:availability_zone":"az1-dc1",
            "os:scheduler_hints":{
            },
            "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda",
            "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a62-4014-89be-1743ff3a5daf",
            "enterprise_project_id":"441d5677-b76a-4dd4-a97a-ef7fd633c095",
            "OS-EXT-SRV-ATTR:user_data":"IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRKQ2FzUWQkbm5wVmhJUFZlNVMwc3pXbnJGLnZVZ1FCWk4xTEo5Vy8wd09WTmFZaWpBRXdtRnhuQmZaTllVZXhBWktVWFVTeVhEeERuSUMzV2JjZEJyQUVBZkZvLy8nIHwgY2hwYXNzd2QgLWU7",
            "OS-SRV-USG:launched_at":"2018-08-13T13:46:46.000000",
            "OS-EXT-SRV-ATTR:kernel_id":"",
            "OS-EXT-SRV-ATTR:launch_index":0,
            "host_status":"UP",
            "OS-EXT-SRV-ATTR:reservation_id":"r-a8mg9vwr",
            "OS-EXT-SRV-ATTR:hostname":"ecs-4cff",
            "sys_tags":[
                {
                    "key":"_sys_enterprise_project_id",
                    "value":"441d5677-b76a-4dd4-a97a-ef7fd633c095"
                }
            ],
            "security_groups":[
                {
                    "id":"71846bf6-1cda-4515-8590-3707be295e76",
                    "name":"Sys-FullAccess"
                },
                {
                    "id":"b1786350-da65-11e7-b312-0255ac101b03",
                    "name":"default"
                }
            ]
        },
        {
            "fault":null,
            "id":"8380dcc9-0eac-4407-9f9e-df8c9eddeacd",
            "name":"ecs-f680",
            "addresses":{
                "164489f6-cbf7-45b4-b6d0-d407c48cf7fc":[
                    {
                        "version":"4",
                        "addr":"192.168.0.218",
                        "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:bb:b3:fe",
                        "OS-EXT-IPS:port_id":"240c696f-68d8-4f3f-941d-fecf2b375132",
                        "OS-EXT-IPS:type":"fixed"
                    }
                ]
            },
            "flavor":{
                "disk":"0",
                "vcpus":"2",
                "ram":"1024",
                "id":"c3.large.2",
                "name":"c3.large.2",
                "gpus": [],
                "asic_accelerators": [] 
            },
            "accessIPv4":"",
            "accessIPv6":"",
            "status":"SHUTOFF",
            "image":{
                "id":"1ce5800a-e487-4c1b-b264-3353a39e2b4b"
            },
            "hostId":"f92345b97fd291f67a29ed735a82a8983f370175d2ba3d18d66893f4",
            "updated":"2018-08-14T03:01:00Z",
            "created":"2018-08-13T13:38:29Z",
            "metadata":{
                "metering.image_id":"af60e0d5-6952-4f3d-b0ed-31bb19d4a692",
                "metering.imagetype":"gold",
                "metering.resourcespeccode":"c3.large.2.linux",
                "image_name":"HEC_Public_Cloudinit_CentOS_7.4_64bit",
                "metering.resourcetype":"1",
                "os_bit":"64",
                "vpc_id":"164489f6-cbf7-45b4-b6d0-d407c48cf7fc",
                "os_type":"Linux",
                "charging_mode":"0"
            },
            "tags":[
                "_sys_root_resource_id=9d81b37c-455f-4528-b0ab-a6abcd0a330b",
                "_sys_root_resource_type=xxx.resource.type.vm"
            ],
            "description":"ecs-f680",
            "locked":false,
            "config_drive":"",
            "tenant_id":"edcb94a885a84ed3a3fdf8ea4d2741da",
            "user_id":"61ee747d36bf421fa25c51a3b9565046",
            "os-extended-volumes:volumes_attached":[
                {
                    "device":"/dev/sda",
                    "bootIndex":"0",
                    "id":"3721b948-9c2f-4980-90ad-b2a16811f58c",
                    "delete_on_termination":"false"
                }
            ],
            "OS-EXT-STS:task_state":null,
            "OS-EXT-STS:power_state":4,
            "OS-EXT-STS:vm_state":"stopped",
            "OS-EXT-SRV-ATTR:host":"az1.dc1",
            "OS-EXT-SRV-ATTR:instance_name":"instance-00137937",
            "OS-EXT-SRV-ATTR:hypervisor_hostname":"nova001@248",
            "OS-DCF:diskConfig":"MANUAL",
            "OS-EXT-AZ:availability_zone":"az1-dc1",
            "os:scheduler_hints":{
            },
            "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda",
            "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a62-4026-92be-1743ff3a5daf",
            "enterprise_project_id":"441d5677-b76a-4dd4-a97a-ef7fd633c095",
            "OS-EXT-SRV-ATTR:user_data":"IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiR5aG9aeFIkVE00OWlwSGQ2OEFWcjlTMTFXNEZrZmFYTENVbEkvd0xVTmdSVjhOb0dCem5WOWFsU1lEN0ZNSHc0VmtwdU9GOERyLncudGUzVmRHLnVmY005elVZSDEnIHwgY2hwYXNzd2QgLWU7",
            "OS-SRV-USG:launched_at":"2018-08-13T13:38:53.000000",
            "OS-EXT-SRV-ATTR:kernel_id":"",
            "OS-EXT-SRV-ATTR:launch_index":0,
            "host_status":"UP",
            "OS-EXT-SRV-ATTR:reservation_id":"r-7e2g78rq",
            "OS-EXT-SRV-ATTR:hostname":"ecs-f680",
            "sys_tags":[
                {
                    "key":"_sys_enterprise_project_id",
                    "value":"441d5677-b76a-4dd4-a97a-ef7fd633c095"
                }
            ],
            "security_groups":[
                {
                    "name":"test"
                }
            ]
        },
        {
            "fault":null,
            "id":"fb70fed9-5774-44a7-ad4a-af3ea2c2da61",
            "name":"ecs-3993",
            "addresses":{
                "00159d7d-b3c3-4108-8bc4-6658814e6422":[
                    {
                        "version":"4",
                        "addr":"192.168.20.83",
                        "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:a9:8d:88",
                        "OS-EXT-IPS:port_id":"579ab762-bf89-435e-80ad-a8bdd25119c5",
                        "OS-EXT-IPS:type":"fixed"
                    }
                ]
            },
            "flavor":{
                "disk":"0",
                "vcpus":"2",
                "ram":"1024",
                "id":"c3.large.2",
                "name":"c3.large.2",
                "gpus": [],
                "asic_accelerators": [] 
            },
            "accessIPv4":"",
            "accessIPv6":"",
            "status":"SHUTOFF",
            "image":{
                "id":"1ce5800a-e487-4c1b-b264-3353a39e2b4b"
            },
            "hostId":"f92345b97fd291f67a29ed735a82a8983f370175d2ba3d18d66893f4",
            "updated":"2018-08-14T03:01:03Z",
            "created":"2018-08-13T13:38:02Z",
            "metadata":{
                "metering.image_id":"af60e0d5-6952-4f3d-b0ed-31bb19d4a692",
                "metering.imagetype":"gold",
                "metering.resourcespeccode":"c3.large.2.linux",
                "image_name":"HEC_Public_Cloudinit_CentOS_7.4_64bit",
                "metering.resourcetype":"1",
                "os_bit":"64",
                "vpc_id":"00159d7d-b3c3-4108-8bc4-6658814e6422",
                "os_type":"Linux",
                "charging_mode":"0"
            },
            "tags":[
               "combined_order_id=CBRCS231010102024YL8962"
            ],
            "description":"ecs-3993",
            "locked":false,
            "config_drive":"",
            "tenant_id":"edcb94a885a84ed3a3fdf8ea4d2741da",
            "user_id":"eb4698fe015848e9a3e86cc9956e54fa",
            "key_name":"KeyPair-3b38",
            "os-extended-volumes:volumes_attached":[
                {
                    "device":"/dev/sda",
                    "bootIndex":"0",
                    "id":"85bfbc4f-7733-419a-b171-c00585abf926",
                    "delete_on_termination":"false"
                }
            ],
            "OS-EXT-STS:task_state":null,
            "OS-EXT-STS:power_state":4,
            "OS-EXT-STS:vm_state":"stopped",
            "OS-EXT-SRV-ATTR:host":"az1.dc1",
            "OS-EXT-SRV-ATTR:instance_name":"instance-00137936",
            "OS-EXT-SRV-ATTR:hypervisor_hostname":"nova001@248",
            "OS-DCF:diskConfig":"MANUAL",
            "OS-EXT-AZ:availability_zone":"az1-dc1",
            "os:scheduler_hints":{
            },
            "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda",
            "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a25-4014-92be-1743ff3a5daf",
            "enterprise_project_id":"441d5677-b76a-4dd4-a97a-ef7fd633c095",
            "OS-SRV-USG:launched_at":"2018-08-13T13:38:24.000000",
            "OS-EXT-SRV-ATTR:kernel_id":"",
            "OS-EXT-SRV-ATTR:launch_index":0,
            "host_status":"UP",
            "OS-EXT-SRV-ATTR:reservation_id":"r-uzsewxii",
            "OS-EXT-SRV-ATTR:hostname":"ecs-3993",
            "sys_tags":[
                {
                    "key":"_sys_enterprise_project_id",
                    "value":"441d5677-b76a-4dd4-a97a-ef7fd633c095"
                }
            ],
            "security_groups":[
                {
                    "name":"test"
                },
                {
                    "name":"default"
                }
            ]
        },
        {
            "fault":null,
            "id":"e3d3f219-b445-4a7a-8f00-e31412481f8c",
            "name":"ecs-1f30",
            "addresses":{
                "00159d7d-b3c3-4108-8bc4-6658814e6422":[
                    {
                        "version":"4",
                        "addr":"192.168.20.197",
                        "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:41:5a:32",
                        "OS-EXT-IPS:port_id":"cfa2e055-54fb-427a-bde4-128bda47ae5c",
                        "OS-EXT-IPS:type":"fixed"
                    }
                ]
            },
            "flavor":{
                "disk":"0",
                "vcpus":"2",
                "ram":"1024",
                "id":"c3.large.2",
                "name":"c3.large.2",
                "gpus": [],
                "asic_accelerators": [] 
            },
            "accessIPv4":"",
            "accessIPv6":"",
            "status":"ACTIVE",
            "image":{
                "id":"1ce5800a-e487-4c1b-b264-3353a39e2b4b"
            },
            "progress":0,
            "hostId":"f92345b97fd291f67a29ed735a82a8983f370175d2ba3d18d66893f4",
            "updated":"2018-08-15T08:16:01Z",
            "created":"2018-08-13T11:57:29Z",
            "metadata":{
                "sadfasfasf":"sdffffd",
                "metering.order_id":"CS180813193577ORO",
                "metering.imagetype":"gold",
                "metering.resourcespeccode":"c3.large.2.win",
                "metering.image_id":"65cb40e6-f67e-4bef-a1e7-808166a5999d",
                "image_name":"HEC_Public_Windows2008R2_Ent_64bit40G_English",
                "aaaaaa":"0",
                "metering.resourcetype":"1",
                "aaaa":"0",
                "metering.product_id":"00301-146042-0--0",
                "os_bit":"64",
                "vpc_id":"00159d7d-b3c3-4108-8bc4-6658814e6422",
                "os_type":"Windows",
                "charging_mode":"1"
            },
            "tags":[
                "_sys_root_resource_id=4514d9b0-d611-4744-bdf9-60802fd5198a",
                "_sys_root_resource_type=xxx.resource.type.vm"
            ],
            "description":"ecs-1f30",
            "locked":false,
            "config_drive":"",
            "tenant_id":"edcb94a885a84ed3a3fdf8ea4d2741da",
            "user_id":"bb7f23e27e7e46f3aaceb5f53a158bdc",
            "key_name":"Autotest_Init_TC_OriginalAPI_Create_Keypairs_02_keypair",
            "os-extended-volumes:volumes_attached":[
                {
                    "device":"/dev/sda",
                    "bootIndex":"0",
                    "id":"5043f66b-a0d8-4eb2-8c48-49976bcdc253",
                    "delete_on_termination":"false"
                }
            ],
            "OS-EXT-STS:task_state":null,
            "OS-EXT-STS:power_state":1,
            "OS-EXT-STS:vm_state":"active",
            "OS-EXT-SRV-ATTR:host":"az1.dc1",
            "OS-EXT-SRV-ATTR:instance_name":"instance-0013772d",
            "OS-EXT-SRV-ATTR:hypervisor_hostname":"nova001@248",
            "OS-DCF:diskConfig":"MANUAL",
            "OS-EXT-AZ:availability_zone":"az1-dc1",
            "os:scheduler_hints":{
            },
            "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda",
            "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a62-4014-92be-1743ff3a5daf",
            "enterprise_project_id":"441d5677-b76a-4dd4-a97a-ef7fd633c095",
            "OS-SRV-USG:launched_at":"2018-08-13T11:57:53.576640",
            "OS-EXT-SRV-ATTR:kernel_id":"",
            "OS-EXT-SRV-ATTR:launch_index":0,
            "host_status":"UP",
            "OS-EXT-SRV-ATTR:reservation_id":"r-xmjj4pnm",
            "OS-EXT-SRV-ATTR:hostname":"ecs-1f30",
            "sys_tags":[
                {
                    "key":"_sys_enterprise_project_id",
                    "value":"441d5677-b76a-4dd4-a97a-ef7fd633c095"
                }
            ],
            "security_groups":[
                {
                    "name":"default"
                }
            ]
        }
    ]
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 生命周期管理

相关文档