跳转至

服务器

查看服务器列表

接口描述

查看服务器列表。

接口路径

GET /v1/servers

请求参数

参数名称 是否必须 示例 备注
datacenter_id 是 /v1/servers?datacenter_id=1 数据中心ID
hostname 否 /v1/servers?hostname=test1 主机名
ip 否 /v1/servers?ip=192.168.10 ip地址
state 否 /v1/servers?state=1 服务器状态
offset 否 /v1/servers?offset=10 跳过记录数量
limit 否 /v1/servers?limit=10 限制查询数量

服务器状态码(state字段)含义：

  • 1：运行中
  • 2：宕机
  • 3：维护中
  • 4：下线
  • -1：异常

返回数据

名称 类型 描述
code int 状态码（100001表示成功，其它表示异常）
msg string 状态码描述信息
reason string 异常时的原因
data object 响应数据，格式见示例

返回数据示例：

{
    "code": 100001,
    "msg": "success",
    "data": {
        "count": 1,
        "items": [
            {
                "id": 2, // 服务器id
                "memory": 31985,  // 服务器内存
                "used_memory": 24576, // 已使用内存
                "cpu_cores": 40,  // 服务器cpu核心数
                "used_cpu": 12, // 已使用cpu
                "enable_over_limit": false, // 是否启用了cpu超分
                "cpu_over_limit_percent": 0,  // cpu超分比例
                "state": 1,  // 服务器状态
                "hostname": "10.100.9.31",  // 服务器hostname
                "serial_number": "3J9HC92",  // sn
                "cpu_model": "Intel(R) Xeon(R) CPU E5-2650 v3 @ 2.30GHz",  // cpu型号
                "gpus": { // GPU信息
                    "NVIDIA GeForce GTX 1660 SUPER": {
                        "model": "NVIDIA GeForce GTX 1660 SUPER",  // GPU型号
                        "total": 2,  // GPU数量
                        "used": 0,  // 已使用数量
                        "enable_vGPU": false  // 是否启用vGPU
                    }
                },
                "vGPUs": null,  // vGPU信息
                "ip_addresses": [  // 网络信息
                    {
                        "ip_address": "10.100.9.31",
                        "mac_address": "c6:8b:54:06:f3:dc",
                        "is_public": false
                    },
                    {
                        "ip_address": "192.168.122.1",
                        "mac_address": "52:54:00:81:a3:cc",
                        "is_public": false
                    }
                ]
            }
        ]
    }
}

查看服务器详情

接口描述

查看服务器详细信息。

接口路径

GET /v1/servers/:id/details

请求参数

参数名称 是否必须 示例 备注
id 是 /v1/servers/1/details 服务器id

返回数据

名称 类型 描述
code int 状态码（100001表示成功，其它表示异常）
msg string 状态码描述信息
reason string 异常时的原因
data Server 响应数据，格式见示例

返回数据示例：

{
    "code": 100001,
    "msg": "success",
    "data": {
        "id": 1, // 服务器id
        "uuid": "b32985a3-4d36-4a39-91a6-2933b8905d64",  // uuid
        "hostname": "bj.clouddesktop.10.100.6.201",  // hostname
        "cpu_model": "Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz", // cpu型号
        "serial_number": "1CKFF3X",  // sn
        "total_cpu": 40,  // cpu核心数
        "used_cpu": 4,  // 已使用cpu核心数
        "total_memory": 80352,  // 内存(MB)
        "used_memory": 8192,  // 已使用内存(MB)
        "state": 1,  // 状态
        "reserve_cpu": -80,  // 预留cpu
        "reserve_memory": 4096, // 预留内存
        "enable_over_limit": true,  // 是否启用cpu超分
        "cpu_over_limit_percent": 3,  // cpu超分比例
        "created_at": "2023-10-16T07:46:47.923+08:00",
        "ip_addresses": [  // 网络信息
            {
                "id": 5,
                "ip_address": "10.100.6.201",
                "mac_address": "f4:52:14:9b:06:1c",
                "is_public": false
            },
            {
                "id": 6,
                "ip_address": "192.168.122.1",
                "mac_address": "52:54:00:5d:12:36",
                "is_public": false
            }
        ],
        "gpus": [  // 显卡信息
            {
                "model": "NVIDIA GeForce GTX 1660 SUPER",
                "total": 2,
                "used": 0
            }
        ],
        "vGPUs": null,
        "virtual_machines": [  // 服务器上的虚机
            {
                "id": 372,
                "name": "vm372",
                "gpu_model": "",
                "gpu_model_alias": "",
                "cpus": 4,
                "memory": 8192,
                "state": "create_failure"
            }
        ]
    }
}

服务器配置CPU超分

接口描述

配置CPU超分，创建虚机时可超量使用CPU资源。

接口路径

PUT /v1/servers/:id/over-limit

请求参数

路径参数

参数名称 是否必须 示例 备注
id 是 /v1/servers/1/over-limit 服务器id

Body参数

参数名称 是否必须 示例 备注
cpu_percent 是 {"cpu_percent": 1.5} CPU超分比例

返回数据

名称 类型 描述
code int 状态码（100001表示成功，其它表示异常）
msg string 状态码描述信息
reason string 异常时的原因