更新时间:2022-12-05 GMT+08:00

添加后端实例

功能介绍

为指定的VPC通道添加弹性云服务器

URI

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

表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参数

参数

是否必选

参数类型

描述

members

Array of MemberInfo objects

后端实例列表

表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

响应参数

状态码: 201

表5 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

members

Array of VpcMemberInfo objects

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

表6 VpcMemberInfo

参数

参数类型

描述

host

String

后端服务器地址

后端实例类型为ip时生效

最大长度:64

weight

Integer

权重值。

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

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

最小值:0

最大值:100

ecs_id

String

后端云服务器的编号。

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

最大长度:255

ecs_name

String

后端云服务器的名称。

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

最大长度:64

id

String

后端实例对象的编号

status

Number

后端实例对象的状态

  • 1: 有效

vpc_channel_id

String

VPC通道的编号

create_time

String

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

状态码: 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通道添加后端服务器地址

    {
      "members" : [ {
        "host" : "192.168.2.25",
        "weight" : 1
      } ]
    }
  • VPC通道添加云服务器

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

响应示例

状态码: 201

Created

  • 示例 1

    {
      "total" : 1,
      "size" : 1,
      "members" : [ {
        "create_time" : "2020-07-23T09:13:24Z",
        "host" : "192.168.2.25",
        "id" : "683b6807cad54122a6777ad047a6178e",
        "status" : 1,
        "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
        "weight" : 1
      } ]
    }
  • 示例 2

    {
      "total" : 2,
      "size" : 2,
      "members" : [ {
        "create_time" : "2020-07-23T09:03:53Z",
        "host" : "192.168.0.17",
        "id" : "5c868f0224084710a1e188b7d3057c52",
        "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d",
        "ecs_name" : "APIGtest02",
        "status" : 1,
        "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331",
        "weight" : 2
      }, {
        "create_time" : "2020-07-23T07:24:34Z",
        "host" : "192.168.0.39",
        "id" : "33ac0e39d005492eb1f4683e66d1a0d1",
        "ecs_id" : "ebe1104f-1254-4ac6-8ed7-366bec84f36e",
        "ecs_name" : "APIGtest01",
        "status" : 1,
        "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331",
        "weight" : 1
      } ]
    }

状态码: 400

Bad Request

{
  "error_code" : "APIG.2004",
  "error_msg" : "The parameter value is outside the allowable range,parameterName:weight. 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"
}

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

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码