文档首页/ API网关 APIG/ API参考(巴黎区域)/ 共享版API/ VPC通道管理/ 查看后端实例列表(云服务器列表)
更新时间:2022-02-21 GMT+08:00

查看后端实例列表(云服务器列表)

功能介绍

查看指定VPC通道的云服务器列表。

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

GET

/v1.0/apigw/vpc-channels/{id}/members[?page_size, page_no, name]

  • 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
  • 查询条件可为以下字段以及对应的值:name、page_size、page_no。

URI中的参数说明如下表所示。

表2 参数说明

名称

是否必选

类型

说明

id

String

VPC通道的编号。

name

String

云服务器的名称。

page_size

Integer

每页显示的云服务器数量,默认值:20。

page_no

Integer

页码,默认值:1。

请求消息

响应消息

表3 参数说明

名称

类型

说明

total

Integer

符合条件的云服务器总数。

size

Integer

本次查询返回的列表长度。

vpc_instances

字典数据类型

本次查询到的云服务器列表。

表4 后端实例详情

名称

类型

说明

id

String

后端实例对象的编号。

vpc_id

String

VPC通道的编号。

status

Integer

后端实例对象的状态。

instance_name

String

云服务器的名称。

instance_id

String

云服务器的ID。

host

String

云服务器的主机地址

weight

Integer

权重值。

权重值越大,转发到该云服务器的请求数量越多。

取值范围1 ~ 100。

create_time

Timestamp

云服务器增加到VPC通道的时间。

响应消息样例:

{
  "total": 2,
  "size": 2,
  "vpc_instances": [
    {
      "instance_id": "instance02",
      "instance_name": "instance_name02",
      "host": "127.0.0.2",
      "weight": 10,
      "id": "680e42fab429447ca23b9623107523d9",
      "vpc_id": "c3e6a7d85d9e47be89dfcc3cd37405d7",
      "status": 1,
      "create_time": "2018-07-27T12:42:32Z"
    },
    {
      "instance_id": "instance01",
      "instance_name": "instance_name01",
      "host": "127.0.0.1",
      "weight": 10,
      "id": "c3bc73605a8b400793363c87574fbad7",
      "vpc_id": "c3e6a7d85d9e47be89dfcc3cd37405d7",
      "status": 1,
      "create_time": "2018-07-27T12:30:48Z"
    }
  ]
}

状态码

表5 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error