文档首页/应用与数据集成平台 ROMA Connect/API参考/服务集成API/VPC通道管理-项目级/查询项目下所有实例的VPC通道列表 - ListProjectVpcChannelsV2
更新时间：2025-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

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

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

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

limit

否

Integer

每页显示的条目数量

id

否

String

VPC通道的编号

name

否

String

VPC通道的名称

precise_search

否

String

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

目前支持name，member_group_name。

member_host

否

String

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

member_port

否

Integer

后端服务器端口

member_group_name

否

String

后端服务器组名称

member_group_id

否

String

后端服务器组编号

members_return

否

Boolean

是否返回后端实例列表

请求参数

表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）

member_type

String

VPC通道的成员类型。

  • ip：IP地址

  • ecs：ECS云服务器

type

String

vpc通道类型。

  • BUILTIN：BUILTIN通道类型

  • MICROSERVICE：微服务类型

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通道的字典编码

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

暂不支持

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

健康检查详情。

microservice_info

MicroServiceInfo object

微服务的响应对象

表6 MemberGroupInfo

参数

参数类型

描述

member_group_name

String

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

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

member_group_remark

String

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

member_group_weight

Integer

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

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

dict_code

String

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

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

暂不支持

microservice_version

String

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

microservice_port

Integer

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

microservice_labels

Array of MicroserviceLabel objects

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

reference_vpc_channel_id

String

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

member_group_id

String

VPC通道后端服务器组编号

create_time

String

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

update_time

String

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

表7 MicroserviceLabel

参数

参数类型

描述

label_name

String

标签名称。

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

label_value

String

标签值。

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

表8 VpcMemberInfo

参数

参数类型

描述

host

String

后端服务器地址

后端实例类型为ip时必填

weight

Integer

权重值。

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

is_backup

Boolean

是否备用节点。

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

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

member_group_name

String

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

status

Integer

后端服务器状态

  • 1：可用

  • 2：不可用

port

Integer

后端服务器端口

ecs_id

String

后端云服务器的编号。

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

ecs_name

String

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

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

id

String

后端实例对象的编号

vpc_channel_id

String

VPC通道的编号

create_time

String

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

member_group_id

String

后端服务器组编号

health_status

String

负载通道后端实例健康状态，unknown、healthy、unhealthy分别标识未做健康检查、健康、不健康

表9 VpcHealthConfigInfo

参数

参数类型

描述

protocol

String

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

  • TCP

  • HTTP

  • HTTPS

path

String

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

method

String

健康检查时的请求方法

port

Integer

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

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

threshold_normal

Integer

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

threshold_abnormal

Integer

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

time_interval

Integer

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

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配置项的证书

status

Integer

健康检查状态

  • 1：可用

  • 2：不可用

timeout

Integer

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

vpc_channel_id

String

VPC通道的编号

id

String

健康检查的编号

create_time

String

创建时间

表10 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

微服务创建时间

表11 MicroServiceInfoCSE

参数

参数类型

描述

engine_id

String

微服务引擎编号

service_id

String

微服务编号

engine_name

String

微服务引擎名称

service_name

String

微服务名称

register_address

String

注册中心地址

cse_app_id

String

微服务所属的应用

version

String

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

表12 MicroServiceInfoCCE

参数

参数类型

描述

cluster_id

String

云容器引擎集群编号

namespace

String

命名空间

workload_type

String

工作负载类型

  • deployment：无状态负载

  • statefulset：有状态负载

  • daemonset：守护进程集

app_name

String

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

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

label_key

String

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

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

label_value

String

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

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

cluster_name

String

云容器引擎集群名称（暂不支持）

表13 MicroServiceInfoCCEService

参数

参数类型

描述

cluster_id

String

云容器引擎集群编号

namespace

String

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

service_name

String

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

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

cluster_name

String

云容器引擎集群名称

表14 MicroServiceInfoNacosBase

参数

参数类型

描述

namespace

String

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

cluster_name

String

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

group_name

String

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

service_name

String

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

server_config

Array of NacosServerConfig objects

nacos服务端配置信息。

user_info

NacosUserInfo object

nacos用户信息。

表15 NacosServerConfig

参数

参数类型

描述

ip_address

String

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

port

Integer

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

grpc_port

Integer

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

表16 NacosUserInfo

参数

参数类型

描述

user_name

String

nacos用户名。

password

String

nacos密码。

状态码：400

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表20 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

OK

{
  "total" : 2,
  "size" : 2,
  "project_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

错误码

请参见错误码。

相关文档