专有云计算 > API 文档 > 云主机 > 主机管理 > 查询主机列表

查询主机列表

最近更新时间: 2023-03-10 09:50:39

请求路径

GET /api/rio/v1/compute/server

请求参数

名称	类型	位置	必须	描述
x-rio-zone-id	string	header	是	区域 ID
marker	string	query	否	list marker
limit	int	query	否	主机限制数量
status	string	query	否	主机状态过滤： `Creating` 创建中 `Changing` 修改配置中 `Running` 运行中 `Starting` 开机中 `Stopping` 关机中 `Stopped` 已关机 `Inactive` 非激活的 `Rebooting` 重启中 `Pending` 准备中 `Deleted` 已删除 `Deleting` 删除中 `Unknown` 未知状态
server_name	string	query	否	主机名称过滤
vpc_id	string	query	否	网络 ID 过滤
v_switch_id	string	query	否	交换机 ID 过滤
image_id	string	query	否	主机镜像 ID 过滤
flavor_id	string	query	否	主机规格 ID 过滤
server_ids	string	query	否	实例 ID。最多支持100个ID，ID之间用半角逗号（,）隔开。
security_group_id	string	query	否	安全组 ID 过滤
private_ip_addresses	[]string	query	否	私网 IP 过滤
public_ip_addresses	[]string	query	否	公网 IP 过滤

返回值

名称	类型	描述
request_id	string	请求 ID
data	[]ServerInfo	主机信息

ServerInfo 主机信息

名称	类型	描述
server_id	string	主机 ID
server_name	string	主机名
description	string	主机描述
zone_id	string	区域 ID
status	string	主机状态 `Creating` 创建中 `Changing` 修改配置中 `Running` 运行中 `Starting` 开机中 `Stopping` 关机中 `Stopped` 已关机 `Inactive` 非激活的 `Rebooting` 重启中 `Pending` 准备中 `Deleted` 已删除 `Deleting` 删除中 `Unknown` 未知状态
hostname	string	网络主机域名
tags	[]TagInfo	标签
image	ServerImageInfo	主机镜像信息
flavor	ServerFlavorInfo	主机规格信息
vpc	[]ServerVPCInfo	主机网络信息
disks	[]ServerDiskInfo	主机磁盘信息
security_groups	[]ServerSecurityGroupInfo	主机安全组绑定信息
key_pair_name	string	主机密钥对名称
expired_at	int64	主机过期时间
created_at	int64	主机创建时间

TagInfo 标签参数

名称	类型	描述
key	string	键名称
value	string	值

ServerImageInfo 主机镜像信息

名称	类型	描述
image_id	string	镜像 ID
image_name	string	名称
os_type	string	操作系统类型： `linux` `windows`
os_name	string	系统名称

ServerFlavorInfo 主机规格信息

名称	类型	描述
flavor_id	string	主机规格 ID
flavor_name	string	主机规格名称
cpu	int64	主机 CPU 核数
memory	int64	主机内存大小单位 MB
gpu_spec	string	实例规格附带的 GPU 类型。
gpu_amount	int64	实例规格附带的 GPU 数量。

ServerVPCInfo 专有网络信息

名称	类型	描述
private_ip_address	string	专有网络 IP 地址
vpc_id	string	专有网络 ID
vpc_name	string	专有网络名称
v_switch_id	string	交换机 ID
v_switch_name	string	交换机名称
eip_info	EIPInfo	EIP 信息

ServerEIPInfo 信息

名称	类型	描述
eip_id	string	EIP ID
eip_name	string	名称
ip_address	string	IP 地址
bandwidth	integer	带宽，单位：Mbps

ServerDiskInfo 主机磁盘信息

名称	类型	描述
id	string	磁盘 ID
size	int	磁盘大小单位 GB
is_boot	bool	是否是系统盘

ServerSecurityGroupInfo 主机安全组信息

名称	类型	描述
security_group_id	string	安全组 ID
security_group_name	string	安全组名称

请求示例

GET api/rio/v1/compute/server

##返回值示例

{
  "request_id": "TqeOOXBHnhxxKs0W",
  "data": [
    {
      "server_id": "d183cbf6-0871-4c00-a0f4-90c901f832b7",
      "server_name": "S-h1IMC",
      "description": "",
      "zone_id": "xiasha",
      "status": "Pending",
      "hostname": "",
      "tags": [],
      "image": {
        "image_id": "812e3500-7591-48b7-8dbc-7706ff83e674",
        "image_name": "CentOS",
        "os_type": "linux",
        "os_name": "CentOS7-64"
      },
      "flavor": {
        "flavor_id": "00c90f83-b633-4c7f-9c77-344e85295af1",
        "flavor_name": "1C1G",
        "cpu": 1,
        "memory": 1024
      },
      "vpc": [],
      "disks": [
        {
          "id": "8662b907-5810-44e7-9efd-bcccc5cac8eb",
          "size": 40,
          "is_boot": true
        }
      ],
      "security_groups": [
        {
          "security_group_id": "31a57ec0-d9e6-4219-815d-9ace570d30a9",
          "security_group_name": "default"
        }
      ],
      "key_pair_name": "",
      "expired_at": 0,
      "created_at": 1643016019000
    }
  ]
}

以上内容是否对您有帮助？