更新时间:2022-03-29 GMT+08:00
分享

查询项目下所有实例的VPC通道列表

功能介绍

查询项目下所有实例的VPC通道列表

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/apic/vpc-channels

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0

缺省值:0

limit

Integer

每页显示的条目数量

最小值:1

最大值:500

缺省值:20

id

String

VPC通道的编号

name

String

VPC通道的名称

precise_search

String

指定需要精确匹配查找的参数名称,多个参数需要支持精确匹配时参数之间使用“,”隔开。

目前支持name,member_group_name。

member_host

String

后端服务地址。默认精确查询,不支持模糊查询。

member_port

Integer

后端服务器端口

最小值:0

最大值:65535

member_group_name

String

后端服务器组名称

member_group_id

String

后端服务器组编号

members_return

Boolean

是否返回后端实例列表

缺省值:false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

project_vpc_channels

Array of ProjectVpcChannelInfo objects

本次查询到的实例VPC通道列表

表5 ProjectVpcChannelInfo

参数

参数类型

描述

name

String

VPC通道的名称。

长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、中划线、下划线组成,且只能以英文或中文开头。

说明:

中文字符必须为UTF-8或者unicode编码。

port

Integer

VPC通道中主机的端口号。

取值范围1 ~ 65535。

balance_strategy

Integer

分发算法。

  • 1:加权轮询(wrr)

  • 2:加权最少连接(wleastconn)

  • 3:源地址哈希(source)

  • 4:URI哈希(uri)

缺省值:1

member_type

String

VPC通道的成员类型。

  • ip

  • ecs

缺省值:ecs

dict_code

String

VPC通道的字典编码

支持英文,数字,特殊字符(-_.)

暂不支持

最小长度:3

最大长度:64

create_time

String

VPC通道的创建时间

id

String

VPC通道的编号

status

Integer

VPC通道的状态。

  • 1:正常

  • 2:异常

member_groups

Array of MemberGroupInfo objects

后端云服务器组列表。

instance_id

String

实例编号

instance_name

String

实例名称

members

Array of VpcMemberInfo objects

后端实例列表。

vpc_health_config

VpcHealthConfigInfo object

健康检查详情。

表6 MemberGroupInfo

参数

参数类型

描述

member_group_name

String

VPC通道后端服务器组名称

member_group_remark

String

VPC通道后端服务器组描述

member_group_weight

Integer

VPC通道后端服务器组权重值。

当前服务器组存在服务器且此权重值存在时,自动使用此权重值分配权重。

最小值:0

最大值:100

dict_code

String

VPC通道后端服务器组的字典编码

支持英文,数字,特殊字符(-_.)

暂不支持

最小长度:3

最大长度:64

member_group_id

String

VPC通道后端服务器组编号

create_time

String

VPC通道后端服务器组创建时间

update_time

String

VPC通道后端服务器组更新时间

表7 VpcMemberInfo

参数

参数类型

描述

host

String

后端服务器地址

后端实例类型为ip时必填

最大长度:64

weight

Integer

权重值。

允许您对后端服务进行评级,权重值越大,转发到该云服务的请求数量越多。

最小值:0

最大值:10000

is_backup

Boolean

是否备用节点。

开启后对应后端服务为备用节点,仅当非备用节点全部故障时工作。

实例需要升级到对应版本才支持此功能,若不支持请联系技术支持。

缺省值:false

member_group_name

String

后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。

status

Integer

后端服务器状态

  • 1:可用

  • 2:不可用

port

Integer

后端服务器端口

最小值:0

最大值:65535

ecs_id

String

后端云服务器的编号。

后端实例类型为ecs时必填,支持英文,数字,“-”,“_”,1 ~ 64字符。

最大长度:255

ecs_name

String

[后端云服务器的名称。]

后端实例类型为ecs时必填,支持汉字,英文,数字,“-”,“_”,“.”,1 ~ 64字符。

最大长度:64

id

String

后端实例对象的编号

vpc_channel_id

String

VPC通道的编号

create_time

String

后端实例增加到VPC通道的时间

member_group_id

String

后端服务器组编号

表8 VpcHealthConfigInfo

参数

参数类型

描述

protocol

String

使用以下协议,对VPC中主机执行健康检查:

  • TCP

  • HTTP

  • HTTPS

path

String

健康检查时的目标路径。protocol = http或https时必选

method

String

健康检查时的请求方法

缺省值:GET

port

Integer

健康检查的目标端口,缺少或port = 0时为VPC中主机的端口号。

若此端口存在非0值,则使用此端口进行健康检查。

最小值:0

最大值:65535

threshold_normal

Integer

正常阈值。判定VPC通道中主机正常的依据为:连续检查x成功,x为您设置的正常阈值。

最小值:2

最大值:10

threshold_abnormal

Integer

异常阙值。判定VPC通道中主机异常的依据为:连续检查x失败,x为您设置的异常阈值。

最小值:2

最大值:10

time_interval

Integer

间隔时间:连续两次检查的间隔时间,单位为秒。必须大于timeout字段取值。

最小值:5

最大值:300

http_code

String

检查目标HTTP响应时,判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值,支持如下三种格式:

  • 多个值,如:200,201,202

  • 一系列值,如:200-299

  • 组合值,如:201,202,210-299 protocol = http时必选

enable_client_ssl

Boolean

是否开启双向认证。若开启,则使用实例配置中的backend_client_certificate配置项的证书

缺省值:false

status

Integer

健康检查状态

  • 1:可用

  • 2:不可用

timeout

Integer

超时时间:检查期间,无响应的时间,单位为秒。必须小于time_interval字段取值。

最小值:2

最大值:30

vpc_channel_id

String

VPC通道的编号

id

String

健康检查的编号

create_time

String

创建时间

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码: 200

OK

{
  "total" : 2,
  "size" : 2,
  "vpc_channels" : [ {
    "member_type" : "ip",
    "balance_strategy" : 1,
    "create_time" : "2020-07-23T07:24:33Z",
    "port" : 8080,
    "name" : "channel 1",
    "id" : "105c6902457144a4820dff8b1ad63331",
    "type" : 1,
    "status" : 1,
    "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e",
    "instance_name" : "test"
  }, {
    "member_type" : "ip",
    "balance_strategy" : 2,
    "create_time" : "2020-07-23T07:11:57Z",
    "port" : 8088,
    "name" : "channel 2",
    "id" : "56a7d7358e1b42459c9d730d65b14e59",
    "type" : 2,
    "status" : 1,
    "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e",
    "instance_name" : "test"
  } ]
}

状态码: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "The request parameters must be specified,parameterName:name. Please refer to the support documentation"
}

状态码: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close