查询专属主机上的云服务器 - ListServersDedicatedHost_API_API参考

功能介绍

查询专属主机上已部署的云服务器信息。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}/servers

参数说明请参见表1。

表1 参数说明
参数	参数类型	是否必选	描述
project_id	String	是	项目ID。获取方式请参见获取项目ID。
dedicated_host_id	String	是	专属主机ID。可以从专属主机控制台查询，或者通过调用查询专属主机列表 - ListDedicatedHostsAPI获取。

请求消息

表2 查询参数
参数	位置	参数类型	是否必选	描述
limit	query	String	否	每个页面上显示的条目数。
marker	query	String	否	该值是上一页最后一条记录的ID。如果“marker”取值无效，将会返回“400”错误码。

响应消息

表3 响应参数
参数	位置	类型	描述
servers	body	Array of objects	服务器对象，详情请参见表4 servers字段数据结构说明。

表4 servers字段数据结构说明
参数	参数类型	描述
addresses	Map<String, Object>	云服务器对应的网络地址信息。属性为Map<String, Object>结构。 key为VPC子网ID。 value为网络属性，详情请参见表5。
created	String	弹性云服务器创建时间。
flavor	Object	弹性云服务器规格信息。详情参见表6。
id	String	弹性云服务器ID，格式为UUID。
name	String	弹性云服务器名称。
status	String	弹性云服务器状态。取值范围： ACTIVE、BUILD、DELETED、ERROR、HARD_REBOOT、MIGRATING、PASSWORD、PAUSED、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、SHELVED、SHELVED_OFFLOADED、SOFT_DELETED、SUSPENDED、VERIFY_RESIZE 云服务器状态说明请参考云服务器状态。
tenant_id	String	弹性云服务器所属租户ID，格式为UUID。
updated	String	弹性云服务器更新时间。
user_id	String	创建弹性云服务器的用户ID，格式为UUID。
task_state	String	弹性云服务器当前任务的状态。状态说明请参考云服务器状态表3。
image	Object	弹性云服务器镜像信息。详情参见表7。
metadata	Object	弹性云服务器元数据。详情参见表8。

表5 弹性云服务器所属网络信息的数据结构说明
参数	参数类型	描述
addr	String	IP地址信息。
version	Integer	IP地址类型，值为4或6。 4：IP地址类型是IPv4 6：IP地址类型是IPv6
OS-EXT-IPS-MAC:mac_addr	String	扩展属性，MAC地址。
OS-EXT-IPS:type	String	扩展属性，分配IP地址方式。 fixed：代表私有IP地址。 floating：代表浮动IP地址。

表6 flavor字段数据结构说明
参数	参数类型	描述
id	String	规格id。

表7 image字段数据结构说明
参数	参数类型	描述
id	String	镜像uuid。

表8 metadata字段数据结构说明
参数	参数类型	描述
os_type	String	操作系统类型。Linux或Windows。

请求示例

查询ID为ab910cf0daebca90c4001的专属主机上的云服务器。

GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/ab910cf0daebca90c4001/servers

响应示例

{
    "servers": [
        {
          "addresses": {
                "68269e6e-4a27-441b-8029-35373ad50bd9": [
                    {
                        "addr": "192.168.0.3", 
                        "version": 4,
                        "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:1b:35:78",
                        "OS-EXT-IPS:type": "fixed"
                    }
                ]
            }, 
            "created": "2012-09-07T16:56:37Z", 
            "flavor": {
                "id": "1"
            },
            "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
            "metadata": {
                "os_type": "Linux"
            }, 
            "name": "new-server-test", 
            "status": "ACTIVE", 
            "tenant_id": "a90b2728805d4240a72cc2eeb4e1244d", 
            "updated": "2012-09-07T16:56:37Z", 
            "user_id": "fake",
            "task_state": "",
            "image": {
                "id": "1ce5800a-e487-4c1b-b264-3353a39e2b4b"
            }
        }
    ]
}

返回值

请参见状态码。

查询专属主机上的云服务器 - ListServersDedicatedHost