文档首页/ 应用与数据集成平台 ROMA Connect/ API参考（阿布扎比区域）/ 服务集成API/ VPC通道管理/ 更新VPC通道
更新时间：2022-12-05 GMT+08:00
查看PDF
分享

更新VPC通道

功能介绍

更新指定VPC通道的参数

URI

PUT /v2/{project_id}/apic/instances/{instance_id}/vpc-channels/{vpc_channel_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID

vpc_channel_id

是

String

VPC通道的编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

VPC通道的名称。

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

说明：

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

type

是

Integer

VPC通道的类型。

  • 1：私网ELB通道（待废弃）

  • 2：ROMA Connect APIC内置支持负载均衡功能的快速通道类型

port

否

Integer

VPC通道中主机的端口号。

取值范围1 ~ 65535，仅VPC通道类型为2时有效。

VPC通道类型为2时必选。

balance_strategy

否

Integer

分发算法。

  • 1：加权轮询（wrr）

  • 2：加权最少连接（wleastconn）

  • 3：源地址哈希（source）

  • 4：URI哈希（uri）

VPC通道类型为2时必选。

member_type

否

String

VPC通道的成员类型。

  • ip

  • ecs

VPC通道类型为2时必选。

缺省值：ecs

members

否

Array of MemberInfo objects

VPC后端实例列表，VPC通道类型为1时，有且仅有1个后端实例。

vpc_health_config

否

VpcHealthConfig object

健康检查详情，VPC通道类型为2时必选。
表4 MemberInfo

参数

是否必选

参数类型

描述

host

否

String

后端服务器地址

后端实例类型为ip时生效

最大长度：64

weight

否

Integer

权重值。

允许您对云服务器进行评级，权重值越大，转发到该云服务的请求数量越多。权重只对加权轮询和加权最小连接算法生效

仅VPC通道类型为2时有效。

最小值：0

最大值：100

ecs_id

否

String

后端云服务器的编号。

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

最大长度：255

ecs_name

否

String

后端云服务器的名称。

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

最大长度：64
表5 VpcHealthConfig

参数

是否必选

参数类型

描述

protocol

是

String

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

  • TCP

  • HTTP

  • HTTPS

path

否

String

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

method

否

String

健康检查时的请求方法

缺省值：GET

port

否

Integer

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

最小值：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

timeout

否

Integer

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

最小值：2

最大值：30

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

name

String

VPC通道的名称。

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

说明：

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

type

Integer

VPC通道的类型。

  • 1：私网ELB通道（待废弃）

  • 2：ROMA Connect APIC内置支持负载均衡功能的快速通道类型

port

Integer

VPC通道中主机的端口号。

取值范围1 ~ 65535，仅VPC通道类型为2时有效。

VPC通道类型为2时必选。

balance_strategy

Integer

分发算法。

  • 1：加权轮询（wrr）

  • 2：加权最少连接（wleastconn）

  • 3：源地址哈希（source）

  • 4：URI哈希（uri）

VPC通道类型为2时必选。

member_type

String

VPC通道的成员类型。

  • ip

  • ecs

VPC通道类型为2时必选。

缺省值：ecs

create_time

String

VPC通道的创建时间

id

String

VPC通道的编号

status

Integer

VPC通道的状态。

  • 1：正常

  • 2：异常

elb_id

String

私网ELB通道的编号。

仅当VPC通道类型为1时生效

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

{
  "balance_strategy" : 2,
  "member_type" : "ip",
  "name" : "VPC_demo",
  "port" : 22,
  "type" : 2,
  "vpc_health_config" : {
    "http_code" : "200",
    "path" : "/vpc/demo",
    "port" : 22,
    "protocol" : "http",
    "threshold_abnormal" : 5,
    "threshold_normal" : 2,
    "time_interval" : 10,
    "timeout" : 5,
    "enable_client_ssl" : false
  },
  "members" : [ {
    "host" : "192.168.0.5",
    "weight" : 1
  }, {
    "host" : "192.168.1.124",
    "weight" : 2
  } ]
}

响应示例

状态码： 200

OK

{
  "balance_strategy" : 2,
  "create_time" : "2020-07-23T07:11:57Z",
  "member_type" : "ip",
  "port" : 22,
  "status" : 1,
  "name" : "VPC_demo",
  "type" : 2
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2001",
  "error_msg" : "The request parameters must be specified, parameter name:members"
}

状态码： 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.3023",
  "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
}

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

错误码

请参见错误码。

父主题： VPC通道管理