API网关 APIG-更新VPC通道:响应参数

时间:2023-12-01 09:43:00

响应参数

状态码: 200

表12 响应Body参数

参数

参数类型

描述

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

枚举值:

  • 1

  • 2

  • 3

  • 4

member_type

String

VPC通道的成员类型。

  • ip

  • ecs

缺省值:ecs

枚举值:

  • ip

  • ecs

type

Integer

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

  • 2:服务器类型

  • 3:微服务类型

缺省值:2

枚举值:

  • 2

  • 3

dict_code

String

VPC通道的字典编码

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

暂不支持

最小长度:3

最大长度:64

create_time

String

VPC通道的创建时间

id

String

VPC通道的编号

status

Integer

VPC通道的状态。

  • 1:正常

  • 2:异常

枚举值:

  • 1

  • 2

member_groups

Array of MemberGroupInfo objects

后端云服务器组列表。

microservice_info

MicroServiceInfo object

微服务的响应对象

表13 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通道类型为微服务时支持。

member_group_id

String

VPC通道后端服务器组编号

create_time

String

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

update_time

String

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

表14 MicroserviceLabel

参数

参数类型

描述

label_name

String

标签名称。

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

最小长度:1

最大长度:63

label_value

String

标签值。

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

最小长度:1

最大长度:63

表15 MicroServiceInfo

参数

参数类型

描述

id

String

微服务编号

instance_id

String

实例编号

service_type

String

微服务类型:

  • CSE:CSE微服务注册中心

  • CCE:CCE云容器引擎(工作负载)

  • CCE_SERVICE: CCE云容器引擎(Service)

枚举值:

  • CSE

  • CCE

  • CCE_SERVICE

cse_info

MicroServiceInfoCSE object

CSE微服务详细信息

cce_info

MicroServiceInfoCCE object

CCE微服务工作负载信息

cce_service_info

MicroServiceInfoCCEService object

CCE微服务Service信息

update_time

String

微服务更新时间

create_time

String

微服务创建时间

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

表17 MicroServiceInfoCCE

参数

参数类型

描述

cluster_id

String

云容器引擎集群编号

最大长度:64

namespace

String

命名空间

最大长度:64

workload_type

String

工作负载类型

  • deployment:无状态负载

  • statefulset:有状态负载

  • daemonset:守护进程集

枚举值:

  • 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

云容器引擎集群名称

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

云容器引擎集群名称

状态码: 400

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表20 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表21 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表22 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表23 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

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