API网关 APIG-查询VPC通道列表:响应参数

时间:2024-11-11 18:22:29

响应参数

状态码: 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)

member_type

String

VPC通道的成员类型。

  • ip

  • ecs

type

Integer

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

  • 2:服务器类型

  • 3:微服务类型

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

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

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

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

此字段待废弃,请使用vpc_channel_type字段指定负载通道类型。

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

后端云服务器组列表。

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

微服务引擎编号

service_id

String

微服务编号

engine_name

String

微服务引擎名称

service_name

String

微服务名称

register_address

String

注册中心地址

cse_app_id

String

微服务所属的应用

version

String

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

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

云容器引擎集群名称

表11 MicroServiceInfoCCEService

参数

参数类型

描述

cluster_id

String

云容器引擎集群编号

namespace

String

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

service_name

String

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

说明:

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

cluster_name

String

云容器引擎集群名称

表12 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用户信息。

表13 NacosServerConfig

参数

参数类型

描述

ip_address

String

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

port

Integer

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

grpc_port

Integer

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

表14 NacosUserInfo

参数

参数类型

描述

user_name

String

nacos用户名。

password

String

nacos密码。

状态码: 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

错误描述

support.huaweicloud.com/api-apig/ListVpcChannelsV2.html