文档首页/ API网关 APIG/ API参考（吉隆坡区域）/ 专享版API（V2）/ 专享版-VPC通道管理/ 更新后端实例
更新时间：2024-08-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新后端实例

功能介绍

更新指定的VPC通道的后端实例。更新时，使用传入的请求参数对对应云服务组的后端实例进行全量覆盖修改。若未指定修改的云服务器组，则进行全量覆盖。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

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

vpc_channel_id

是

String

VPC通道的编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

members

否

Array of MemberInfo objects

后端实例列表

member_group_name

否

String

需要修改的后端服务器组

不传时使用members中的定义对VPC通道后端进行全量覆盖修改。

传入时，只对members中对应后端服务器组的后端实例进行处理，其他后端服务器组的入参会被忽略。例如：member_group_name=primary时，只处理members中后端服务器组为105c6902457144a4820dff8b1ad63331的后端实例。
表4 MemberInfo

参数

是否必选

参数类型

描述

host

否

String

后端服务器地址

后端实例类型为ip时必填

最大长度：64

weight

否

Integer

权重值。

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

最小值：0

最大值：10000

is_backup

否

Boolean

是否备用节点。

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

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

缺省值：false

member_group_name

否

String

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

status

否

Integer

后端服务器状态

  • 1：可用

  • 2：不可用

枚举值：

  • 1

  • 2

port

否

Integer

后端服务器端口

最小值：0

最大值：65535

ecs_id

否

String

后端云服务器的编号。

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

最大长度：255

ecs_name

否

String

后端云服务器的名称。

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

最大长度：64

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

members

Array of VpcMemberInfo objects

本次查询到的云服务器列表
表6 VpcMemberInfo

参数

参数类型

描述

host

String

后端服务器地址

后端实例类型为ip时必填

最大长度：64

weight

Integer

权重值。

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

最小值：0

最大值：10000

is_backup

Boolean

是否备用节点。

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

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

缺省值：false

member_group_name

String

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

status

Integer

后端服务器状态

  • 1：可用

  • 2：不可用

枚举值：

  • 1

  • 2

port

Integer

后端服务器端口

最小值：0

最大值：65535

ecs_id

String

后端云服务器的编号。

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

最大长度：255

ecs_name

String

后端云服务器的名称。

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

最大长度：64

id

String

后端实例对象的编号

vpc_channel_id

String

VPC通道的编号

create_time

String

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

member_group_id

String

后端服务器组编号

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

错误描述

请求示例

  • 更新VPC通道非备用后端实例信息

    {
  "member_group_name" : "primary",
  "members" : [ {
    "host" : "192.168.2.25",
    "weight" : 1,
    "is_backup" : false,
    "member_group_name" : "primary"
  } ]
}

  • 全量更新VPC通道后端实例信息

    {
  "members" : [ {
    "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d",
    "ecs_name" : "APIGtest02",
    "weight" : 2
  } ]
}

响应示例

状态码： 200

OK

  • 示例 1

    {
  "total" : 1,
  "size" : 1,
  "members" : [ {
    "host" : "192.168.2.25",
    "weight" : 1,
    "is_backup" : false,
    "member_group_name" : "primary",
    "port" : 22,
    "status" : 1,
    "ecs_id" : "192.168.2.25",
    "ecs_name" : "192.168.2.25",
    "id" : "683b6807cad54122a6777ad047a6178e",
    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
    "create_time" : "2020-07-23T09:13:24Z",
    "member_group_id" : "631b551cddda40478ef720163a9412ed"
  } ]
}

  • 示例 2

    {
  "total" : 1,
  "size" : 1,
  "members" : [ {
    "host" : "192.168.0.17",
    "weight" : 2,
    "is_backup" : false,
    "member_group_name" : "primary",
    "port" : 22,
    "status" : 1,
    "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d",
    "ecs_name" : "APIGtest02",
    "id" : "5c868f0224084710a1e188b7d3057c52",
    "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331",
    "create_time" : "2020-07-23T09:03:53Z",
    "member_group_id" : "631b551cddda40478ef720163a9412ed"
  } ]
}

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

错误码

请参见错误码。