查看VPC通道详情

功能介绍

查看指定的VPC通道详情。

URI

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

表1 HTTP/HTTPS请求方法以及URI
请求方法	URI
GET	/v1.0/apigw/vpc-channels/{id}

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

表2 参数说明
名称	是否必选	类型	说明
id	是	String	VPC通道的编号。

请求消息

无

响应消息

表3 参数说明
名称	类型	说明
id	String	VPC通道的编号。
name	String	VPC通道的名称。
type	Integer	VPC通道的类型。 2：API网关内置支持负载均衡功能的快速通道类型
member_type	String	VPC通道的成员类型。 ip（暂不支持） instance
status	Integer	VPC通道的状态。 1：正常 2：异常
port	Integer	VPC通道中主机的端口号。
balance_strategy	Integer	分发算法。 1：加权轮询（wrr） 2：加权最少连接（wleastconn） 3：源地址哈希（source） 4：URI哈希（uri）
create_time	Timestamp	VPC通道的创建时间。
vpc_health_config	字典数据类型	健康检查详情。
vpc_instances	字典数据类型	后端实例列表。

表4 健康检查详情
名称	类型	说明
id	String	健康检查的编号。
vpc_id	String	VPC通道的编号。
protocol	String	使用以下协议，对VPC中主机执行健康检查。 TCP HTTP HTTPS
path	String	健康检查时的目标路径。说明：需要服从URI规范。
port	Integer	健康检查的目标端口，缺省时为VPC中主机的端口号。取值范围1 ~ 65535。
threshold_normal	Integer	正常阈值。判定VPC通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。取值范围2 ~ 10
threshold_abnormal	Integer	异常阈值。判定VPC通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。取值范围2 ~ 10。
time_out	Integer	超时时间：检查期间，无响应的时间，单位为秒。必须小于time_interval字段取值。取值范围2 ~ 30。
time_interval	Integer	间隔时间：连续两次检查的间隔时间，单位为秒。必须大于time_out字段取值。取值范围5 ~ 300。
http_code	String	检查目标HTTP响应时，判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值，支持如下三种格式：多个值，如：200,201,202 一系列值，如：200-299 组合值，如：201,202,210-299
create_time	Timestamp	VPC通道的创建时间。

表5 后端实例详情
名称	类型	说明
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通道的时间。

响应消息样例：

{
  "name": "vpc_001",
  "type": 2,
  "member_type": "instance",
  "port": 15565,
  "balance_strategy": 1,
  "id": "c3e6a7d85d9e47be89dfcc3cd37405d7",
  "create_time": "2018-07-27T12:30:48Z",
  "status": 1,
  "vpc_health_config": {
    "protocol": "http",
    "path": "/hc",
    "port": 15563,
    "threshold_normal": 5,
    "threshold_abnormal": 5,
    "time_out": 30,
    "time_interval": 200,
    "http_code": "205",
    "id": "f26c1b158f2e40f2b531cf5c1b5e05e5",
    "vpc_id": "c3e6a7d85d9e47be89dfcc3cd37405d7",
    "create_time": "2018-07-27T12:30:48Z"
  },
  "vpc_instances": [
    {
      "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"
    }
  ]
}