文档首页/API网关 APIG/API参考/专享版API（V2）/专享版-VPC通道管理/查询VPC通道列表 - ListVpcChannelsV2
更新时间：2025-12-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询VPC通道列表 - ListVpcChannelsV2

功能介绍

查询VPC通道列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    apig:loadBalanceChannel:list

    List

    instance *

    g:ResourceTag/<tag-key>

    • apig:vpcChannels:list

    apig:instance:get

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

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

缺省值：0

limit

否

Integer

每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500

最小值：1

最大值：500

缺省值：20

id

否

String

VPC通道的编号

name

否

String

VPC通道的名称

dict_code

否

String

VPC通道的字典编码

支持英文，数字，特殊字符（-_.）

暂不支持

最小长度：3

最大长度：64

precise_search

否

String

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

目前支持name，member_group_name。

member_host

否

String

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

member_port

否

Integer

后端服务器端口

最小值：0

最大值：65535

member_group_name

否

String

后端服务器组名称

member_group_id

否

String

后端服务器组编号

vpc_channel_type

否

String

vpc通道类型：

  • builtin：服务器类型

  • microservice： 微服务类型

  • reference：引用负载通道类型

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

vpc_channels

Array of VpcChannelInfo objects

本次查询到的VPC通道列表

表5 VpcChannelInfo

参数

参数类型

描述

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

type

Integer

vpc通道类型，默认为服务器类型。

  • 2：服务器类型

  • 3：微服务类型

当vpc_channel_type字段为空时，负载通道类型由type字段控制：

当type不为3或microservice_info为空，VPC通道类型默认为服务器类型。

当type=3，microservice_info不为空，VPC通道类型为微服务类型。

修改负载通道时vpc通道类型不会修改，直接使用原有的vpc通道类型。

请优先使用vpc_channel_type字段指定负载通道类型。

缺省值：2

vpc_channel_type

String

vpc通道类型。

  • builtin：服务器类型

  • microservice： 微服务类型

  • reference：引用负载通道类型

当vpc_channel_type为空时，负载通道类型取决于type字段的取值。

当vpc_channel_type不为空，但type字段非空或不为0时，当vpc_channel_type的指定类型与type字段指定的类型冲突时会校验报错。

当vpc_channel_type不为空，且type字段为空或等于0时，直接使用vpc_channel_type字段的值指定负载通道类型。

修改负载通道时vpc通道类型不会修改，直接使用原有的vpc通道类型。

dict_code

String

VPC通道的字典编码

支持英文，数字，特殊字符（-_.）

暂不支持

最小长度：3

最大长度：64

create_time

String

VPC通道的创建时间

id

String

VPC通道的编号

status

Integer

VPC通道的状态。

  • 1：正常

  • 2：异常

member_groups

Array of MemberGroupInfo objects

后端云服务器组列表。

microservice_info

MicroServiceInfo object

微服务的响应对象

表6 MemberGroupInfo

参数

参数类型

描述

member_group_name

String

VPC通道后端服务器组名称。支持汉字、英文、数字、下划线、中划线、点，且只能以英文和汉字开头，3-64字符。

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

member_group_remark

String

VPC通道后端服务器组描述。

最大长度：255

member_group_weight

Integer

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

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

最小值：0

最大值：100

dict_code

String

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

支持英文，数字，特殊字符（-_.）

暂不支持

最小长度：3

最大长度：64

microservice_version

String

VPC通道后端服务器组的版本，仅VPC通道类型为微服务时支持。

最大长度：64

microservice_port

Integer

VPC通道后端服务器组的端口号，仅VPC通道类型为微服务时支持。端口号为0时后端服务器组下的所有地址沿用原来负载端口继承逻辑。

最小值：0

最大值：65535

microservice_labels

Array of MicroserviceLabel objects

VPC通道后端服务器组的标签，仅VPC通道类型为微服务时支持。

reference_vpc_channel_id

String

引用的负载通道编号，仅VPC通道类型为引用类型（vpc_channel_type=reference）时支持。

最小长度：0

最大长度：64

member_group_id

String

VPC通道后端服务器组编号

create_time

String

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

update_time

String

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

表7 MicroserviceLabel

参数

参数类型

描述

label_name

String

标签名称。

以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。

最小长度：1

最大长度：63

label_value

String

标签值。

以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。

最小长度：1

最大长度：63

表8 MicroServiceInfo

参数

参数类型

描述

id

String

微服务编号

instance_id

String

实例编号

service_type

String

微服务类型。

  • CSE：CSE微服务注册中心

  • CCE：CCE云容器引擎（工作负载）

  • CCE_SERVICE：CCE云容器引擎（Service）（暂不支持）

  • NACOS：nacos引擎，nacos_info必填

cse_info

MicroServiceInfoCSE object

CSE微服务详细信息

cce_info

MicroServiceInfoCCE object

CCE微服务工作负载信息

cce_service_info

MicroServiceInfoCCEService object

CCE微服务Service信息

nacos_info

MicroServiceInfoNacosBase object

nacos基础信息。

update_time

String

微服务更新时间

create_time

String

微服务创建时间

表9 MicroServiceInfoCSE

参数

参数类型

描述

engine_id

String

微服务引擎编号

最大长度：64

service_id

String

微服务编号

最大长度：64

engine_name

String

微服务引擎名称

service_name

String

微服务名称

register_address

String

注册中心地址

cse_app_id

String

微服务所属的应用

version

String

微服务的版本，已废弃，通过后端服务器组中的版本承载。

最大长度：64

表10 MicroServiceInfoCCE

参数

参数类型

描述

cluster_id

String

云容器引擎集群编号

最大长度：64

namespace

String

命名空间

最大长度：64

workload_type

String

工作负载类型

  • deployment：无状态负载

  • statefulset：有状态负载

  • daemonset：守护进程集

app_name

String

APP名称。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。

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

最小长度：1

最大长度：64

label_key

String

服务标识名。支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号，且只能以英文、汉字和数字开头，1-64个字符。

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

最小长度：1

最大长度：64

label_value

String

服务标识值。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。

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

最小长度：1

最大长度：64

cluster_name

String

云容器引擎集群名称

表11 MicroServiceInfoCCEService

参数

参数类型

描述

cluster_id

String

云容器引擎集群编号

最大长度：64

namespace

String

命名空间。1-63字符。只能包含小写字母、数字，以及 '-'，必须以字母开头，必须以字母数字结尾。

最小长度：1

最大长度：63

service_name

String

Service名称。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。

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

最小长度：1

最大长度：64

cluster_name

String

云容器引擎集群名称

表12 MicroServiceInfoNacosBase

参数

参数类型

描述

namespace

String

命名空间ID，当选择默认命名空间public时，此项为空。由字母、数字、连接符('-')、下划线('_')组成且64个字符之内。

最小长度：0

最大长度：64

cluster_name

String

集群名称，默认为DEFAULT。由字母、数字、连接符('-')、下划线('_')组成且64个字符之内。

最小长度：0

最大长度：64

group_name

String

分组名称，默认为DEFAULT_GROUP。由字母、数字、连接符('-')、下划线('_')、点号('.')、冒号(':')组成且128个字符之内。

最小长度：0

最大长度：128

service_name

String

微服务名称。不包含中文和@@，不得以@开头，512个字符以内。

最小长度：1

最大长度：512

server_config

Array of NacosServerConfig objects

nacos服务端配置信息。

数组长度：1 - 9

user_info

NacosUserInfo object

nacos用户信息。

表13 NacosServerConfig

参数

参数类型

描述

ip_address

String

nacos服务端IP地址。不包含中文字符。

最小长度：7

最大长度：128

port

Integer

nacos服务端端口号。取值范围1 ~ 65535。

最小值：1

最大值：65535

grpc_port

Integer

nacos服务端gRPC端口号，默认为port+1000。取值范围1 ~ 65535。

最小值：1

最大值：65535

表14 NacosUserInfo

参数

参数类型

描述

user_name

String

nacos用户名。

最小长度：1

最大长度：64

password

String

nacos密码。

最小长度：1

最大长度：64

状态码：400

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：404

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

OK

{
  "total" : 2,
  "size" : 2,
  "vpc_channels" : [ {
    "name" : "channel 1",
    "port" : 8080,
    "balance_strategy" : 1,
    "member_type" : "ip",
    "dict_code" : "",
    "create_time" : "2020-07-23T07:24:33Z",
    "id" : "105c6902457144a4820dff8b1ad63331",
    "status" : 1,
    "member_groups" : [ ],
    "type" : 2,
    "microservice_info" : {
      "id" : "",
      "instance_id" : "",
      "service_type" : "",
      "cse_info" : {
        "cse_app_id" : "",
        "engine_id" : "",
        "engine_name" : "",
        "register_address" : "",
        "service_id" : "",
        "service_name" : ""
      },
      "cce_info" : {
        "cluster_id" : "",
        "cluster_name" : "",
        "namespace" : "",
        "workload_type" : "",
        "app_name" : ""
      },
      "create_time" : "",
      "update_time" : ""
    }
  }, {
    "name" : "channel 2",
    "port" : 8088,
    "balance_strategy" : 2,
    "member_type" : "ip",
    "dict_code" : "",
    "create_time" : "2020-07-23T07:11:57Z",
    "id" : "56a7d7358e1b42459c9d730d65b14e59",
    "status" : 1,
    "member_groups" : [ ],
    "type" : 3,
    "microservice_info" : {
      "id" : "9483afa235be45158a70c19ab817ac65",
      "instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
      "service_type" : "CCE",
      "cse_info" : {
        "cse_app_id" : "",
        "engine_id" : "",
        "engine_name" : "",
        "register_address" : "",
        "service_id" : "",
        "service_name" : ""
      },
      "cce_info" : {
        "cluster_id" : "ab1485b4f91b45abbcd560be591f7309",
        "cluster_name" : "cce-test",
        "namespace" : "default",
        "workload_type" : "deployment",
        "app_name" : "testapp"
      },
      "create_time" : "2020-07-23T07:11:57.244829604Z",
      "update_time" : "2020-07-23T07:11:57.244829604Z"
    }
  } ]
}

状态码：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"
}

状态码：404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}

状态码：500

Internal Server Error

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档