文档首页/ VR云渲游平台 CVR/ API参考/ API/ 云服务器管理/ 获取云服务器列表
更新时间：2021-11-25 GMT+08:00
查看PDF
分享

获取云服务器列表

功能介绍

获取云服务器列表。

URI

GET /v2/cvr/servers

该接口需要使用global终端节点调用。

请求参数

表1 查询参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页显示的条目数量。

默认为1000，最大值为1000。

offset

否

Integer

偏移量，表示从此偏移量开始查询。

默认为0，最大值为1000。

link_status

否

String

当前设备与云服务器的连接状态。

连接状态枚举值：

  • free： 闲置
  • lost：失联
  • error：异常
  • use： 正常
  • init：初始化

publicip

否

String

云服务器绑定的公网IP地址，只支持精确匹配。

用于设备与云服务器进行网络数据传输。

name

否

String

根据云服务器名称进行模糊搜索。

privateip

否

String

云服务器绑定的私有IP地址，只支持精确搜索。

application_id

否

String

根据应用ID进行精确搜索。

可查看该应用下的云服务器列表（包括已安装该应用及安装未完成的）。

status

否

String

云服务器的当前状态。

状态枚举值：

  • ACTIVE： 实例正常运行状态。
  • SHUTOFF：实例被正常停止。
  • BUILD：创建实例后，在实例状态进入运行中之前的状态。
  • ERROR： 实例处于异常状态。

region_id

否

String

云服务器所在的区域。

区域枚举值（当前仅支持以下三个区域）：

  • cn-north-4：华北-北京四
  • cn-east-3：华东-上海一
  • cn-south-1：华南-广州

响应参数

  • 状态码为200时
    表2 响应Body参数

    参数

    参数类型

    描述

    count

    Integer

    云服务器数量。

    servers

    Array of objects

    云服务器信息列表，详情请参见表3。
    表3 server字段数据结构说明

    参数

    参数类型

    描述

    availability_zone_id

    String

    云服务器所在可用区。

    bandwidth_size

    Integer

    云服务器所绑定带宽的大小。

    单位：Mbit/s

    charging_mode

    Integer

    云服务器的计费模式。

    • 0：表示按需计费。
    • 1：表示包周期计费。

    create_time

    String

    云服务器的创建时间。

    时间格式例如：2020-05-20T03:30:52Z

    current_application_id

    String

    云服务器上正在运行应用ID。

    failure_reason

    String

    云服务器的故障信息。

    privateip

    String

    云服务器所绑定的私有IP。

    flavor_display_name

    String

    云服务器的规格显示名称。

    格式如下：

    xvCPUs | yGB | flavor_id

    x为CPU个数，y为内存大小，flavor_id为规格名。

    image_name

    String

    云服务器所安装的镜像名称。

    installed_applications

    Array of strings

    已安装的应用ID列表。

    link_device_id

    String

    正在连接的设备ID，与云服务器连接设备的唯一标识。

    link_status

    String

    设备与云服务器的连接状态。

    cluster_id

    String

    集群ID。

    name

    String

    云服务器名称。

    id

    String

    云服务器ID。

    publicip

    String

    云服务器绑定的公网IP。

    region_id

    String

    云服务器所在的区域。

    status

    String

    云服务器的状态。

    total_volume_size

    Sring

    云服务器上安装的云硬盘总量。

    单位：GB

    volume_size

    String

    云服务器上安装的云硬盘剩余量。

    单位：GB

    applications

    Array of strings

    该台云服务器上的所有应用ID列表，包括安装完成的及还未安装完成的应用。

    session_number

    Integer

    云服务器的会话路数。
  • 状态码为400时
    表4 响应Body参数

    参数

    参数类型

    描述

    error_code

    String

    返回的错误码，如CVR.0001。

    error_msg

    String

    错误的英文描述。

请求示例

  • 请求示例
    根据连接状态link_status进行筛选。 
    GET https://{endpoint}/v2/cvr/servers?limit=10&offset=0&link_status=free

响应示例

  • 状态码为200时
    OK 
    { 
    "count":1,
    "servers": [
        { 
            "id": "d7acc58a-d83f-44ac-8f57-588832d525aa", 
            "cluster_id": "50adbf76-412a-11eb-821b-fa1640a9b0aa",
            "publicip": "255.255.255.255",
            "region_id": "cn-north-4",
            "volume_size": "98",
            "total_volume_size": "99",
            "link_status": "free",
            "link_device_id": "",
            "failure_reason": "",
            "create_time": "2021-02-02T10:20:43Z",
            "current_application_id": "",
            "installed_applications": ["4d00636c-6540-11eb-b54a-fa1640a9b0aa"],
            "name": "ecs-eeee",
            "status": "ACTIVE",
            "flavor_display_name": "32vCPUs | 64GB | g5r.8xlarge.2",
            "availability_zone_id": "cn-north-4a",
            "image_name": "Windows-Server-2016-64bit",
            "charging_mode": 0,
            "privateip": "192.168.0.0",
            "bandwidth_size": 50,
            "applications": ["4d00636c-6540-11eb-b54a-fa1640a9b0aa"],       
            "session_number": 2
}
    ]
}
  • 状态码为400时 
    { 
  "error_code" : "string", 
  "error_msg" : "string" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 云服务器管理

相关文档