• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. ECSs
  6. Listing Server Details

Listing Server Details

Function Description

This interface is used to query ECSs meeting the search criteria from the database and details of the ECSs.

Interface Format

Method

URI

Description

GET

/v2/{tenant_id}/servers/detail

/v2.1/{tenant_id}/servers/detail

Click the name of the ECSs to be queried. Then, the page for the ECS details is displayed.

Restrictions

When the image parameter is used as a filter condition, other filter conditions and pagination conditions are not supported. The image parameter prevails if several conditions are specified. When the image parameter is not taken as the filter condition, the interface function is not restricted.

Expanded Interface

N/A

Request Parameter

For details, see request parameters described in List Servers.

Response Parameter

Parameter

Type

Mandatory

Description

servers

List(Dict)

Yes

Specifies the details about the ECS. For details, see Querying ECS Details.

Request Example

GET /v2/9c53a566cb3443ab910cf0daebca90c4/servers/detail

GET /v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/detail

Response Example

{
    "servers": [
        {
            "status": "SHUTOFF",
            "updated": "2014-12-16T04:05:35Z",
            "hostId": "e8316daf354c1631140bdaac8a4ed2cd28f879108fad818a0ad99187",
            "OS-EXT-SRV-ATTR:host": "openstack",
            "addresses": {
                "testnet": [
                    {
                        "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:00:04:bb",
                        "version": 4,
                        "addr": "10.10.0.15",
                        "OS-EXT-IPS:type": "fixed"
                    }
                ]
            },
            "links": [
                {
                    "href": "http://172.25.150.139:8774/v2/474eff20eee84b2e87b5717cc7f34dd8/servers/998af54b-5762-4041-abc1-f98a2c27b3a2",
                    "rel": "self"
                },
                {
                    "href": "http://172.25.150.139:8774/474eff20eee84b2e87b5717cc7f34dd8/servers/998af54b-5762-4041-abc1-f98a2c27b3a2",
                    "rel": "bookmark"
                }
            ],
            "key_name": null,
            "image": {
                "id": "5ff5f101-67dc-42c7-9cd6-f4ebac86e8df",
                "links": [
                    {
                        "href": "http://172.25.150.139:8774/474eff20eee84b2e87b5717cc7f34dd8/images/5ff5f101-67dc-42c7-9cd6-f4ebac86e8df",
                        "rel": "bookmark"
                    }
                ]
            },
            "vcpuAffinity": [
                0
            ],
            "OS-EXT-STS:vm_state": "stopped",
            "OS-EXT-SRV-ATTR:instance_name": "instance-0000001b",
            "OS-SRV-USG:launched_at": "2014-12-16T03:57:12.000000",
            "OS-EXT-SRV-ATTR:hypervisor_hostname": "openstack.example.com",
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "http://172.25.150.139:8774/474eff20eee84b2e87b5717cc7f34dd8/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "id": "998af54b-5762-4041-abc1-f98a2c27b3a2",
            "security_groups": [
                {
                    "name": "default"
                }
            ],
            "tags": [
                "__type_virtual"
            ],
       "OS-EXT-SRV-ATTR:root_device_name": "/dev/vda",
       "OS-EXT-SERVICE:service_state": "up",
       "progress": 0,
       "group": "",
            "OS-SRV-USG:terminated_at": null,
            "hyperThreadAffinity": "any",
            "OS-EXT-AZ:availability_zone": "nova",
            "user_id": "dad0fb6cb2b04ca89ffdfd1c1c471d30",
            "name": "name_xx2_vm",
            "created": "2014-12-16T03:57:08Z",
            "tenant_id": "474eff20eee84b2e87b5717cc7f34dd8",
            "OS-DCF:diskConfig": "MANUAL",
            "os-extended-volumes:volumes_attached": [],
            "accessIPv4": "",
            "accessIPv6": "",
            "OS-EXT-STS:task_state": null,
            "OS-EXT-STS:power_state": 4,
            "config_drive": "",
            "metadata": {}
        },
        {
            "status": "ACTIVE",
            "updated": "2014-12-16T03:32:43Z",
            "hostId": "e8316daf354c1631140bdaac8a4ed2cd28f879108fad818a0ad99187",
            "OS-EXT-SRV-ATTR:host": "openstack",
            "addresses": {
                "testnet": [
                    {
                        "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:da:ec:7b",
                        "version": 4,
                        "addr": "10.10.0.13",
                        "OS-EXT-IPS:type": "fixed"
                    }
                ]
            },
            "links": [
                {
                    "href": "http://172.25.150.139:8774/v2/474eff20eee84b2e87b5717cc7f34dd8/servers/9ce161c5-3568-4431-b1b9-24a554528f09",
                    "rel": "self"
                },
                {
                    "href": "http://172.25.150.139:8774/474eff20eee84b2e87b5717cc7f34dd8/servers/9ce161c5-3568-4431-b1b9-24a554528f09",
                    "rel": "bookmark"
                }
            ],
            "key_name": null,
            "image": {
                "id": "5ff5f101-67dc-42c7-9cd6-f4ebac86e8df",
                "links": [
                    {
                        "href": "http://172.25.150.139:8774/474eff20eee84b2e87b5717cc7f34dd8/images/5ff5f101-67dc-42c7-9cd6-f4ebac86e8df",
                        "rel": "bookmark"
                    }
                ]
            },
            "numaOpts": 0,
            "vcpuAffinity": [
                0
            ],
            "OS-EXT-STS:vm_state": "active",
            "OS-EXT-SRV-ATTR:instance_name": "instance-00000019",
            "OS-SRV-USG:launched_at": "2014-12-16T02:04:27.000000",
            "OS-EXT-SRV-ATTR:hypervisor_hostname": "openstack.example.com",
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "http://172.25.150.139:8774/474eff20eee84b2e87b5717cc7f34dd8/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "id": "9ce161c5-3568-4431-b1b9-24a554528f09",
            "security_groups": [
                {
                    "name": "default"
                }
            ],
"tags": [
                "__type_virtual"
            ],
       "OS-EXT-SRV-ATTR:root_device_name": "/dev/vda",
       "OS-EXT-SERVICE:service_state": "up",
       "progress": 0,
       "evsOpts": 0,
       "group": "",
            "OS-SRV-USG:terminated_at": null,
            "hyperThreadAffinity": "any",
            "OS-EXT-AZ:availability_zone": "nova",
            "user_id": "dad0fb6cb2b04ca89ffdfd1c1c471d30",
            "name": "ls_vm",
            "created": "2014-12-16T02:04:22Z",
            "tenant_id": "474eff20eee84b2e87b5717cc7f34dd8",
            "OS-DCF:diskConfig": "MANUAL",
            "os-extended-volumes:volumes_attached": [],
            "accessIPv4": "",
            "accessIPv6": "",
            "OS-EXT-STS:task_state": null,
            "progress": 0,
            "OS-EXT-STS:power_state": 1,
            "config_drive": "",
            "metadata": {}
        }
    ]
}

Returned Values

See section General Request Returned Values.

Error Code

Table 1 Task error code

Error Code

Description

403

Only administrators may list deleted instances.

This error occurs because a non-administrator user queries the deleted ECSs.