# 添加或更新VPC通道后端服务器组 - CreateMemberGroup #### 功能介绍 在APIG中创建VPC通道后端服务器组，VPC通道后端实例可以选择是否关联后端实例服务器组，以便管理后端服务器节点。 如果指定名称的后端服务器组已存在，则更新对应后端服务器组信息。如果请求体中包含多个重复名称的后端服务器定义，则使用第一个定义。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-apig/apig-api-180713003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-apig/apig-api-grant-policy_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | apig:loadBalanceChannel:createServerGroup | Write | instance \* | g:ResourceTag/\ | apig:vpcChannels:addOrUpdateMemberGroups | - apig:instance:get - apig:loadBalanceChannel:get | #### URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-apig/apig-api-180713009.html)。 | | instance_id | 是 | String | 实例ID，在API网关控制台的"实例信息"中获取。 | | vpc_channel_id | 是 | String | VPC通道的编号 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | member_groups | 否 | Array of [MemberGroupCreate] objects | 后端服务器组列表 | 表4MemberGroupCreate | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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通道类型为微服务时支持。 | | reference_vpc_channel_id | 否 | String | 引用的负载通道编号，仅VPC通道类型为引用类型（vpc_channel_type=reference）时支持。 最小长度：**0** 最大长度：**64** | 表5MicroserviceLabel | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | label_name | 是 | String | 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：**1** 最大长度：**63** | | label_value | 是 | String | 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：**1** 最大长度：**63** | #### 响应参数 **状态码：201** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | Integer | 本次返回的列表长度 | | total | Long | 满足条件的记录数 | | member_groups | Array of [MemberGroupInfo] objects | VPC通道后端服务器组列表 | 表7MemberGroupInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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通道类型为微服务时支持。 | | reference_vpc_channel_id | String | 引用的负载通道编号，仅VPC通道类型为引用类型（vpc_channel_type=reference）时支持。 最小长度：**0** 最大长度：**64** | | member_group_id | String | VPC通道后端服务器组编号 | | create_time | String | VPC通道后端服务器组创建时间 | | update_time | String | VPC通道后端服务器组更新时间 | 表8MicroserviceLabel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | label_name | String | 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：**1** 最大长度：**63** | | label_value | String | 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：**1** 最大长度：**63** | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：404** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：500** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 - 创建服务器类型的VPC通道后端服务器组 ``` { "member_groups" : [ { "member_group_name" : "vpc_member_group", "member_group_weight" : 10 } ] } ``` - 创建微服务类型的VPC通道后端服务器组 ``` { "member_groups" : [ { "member_group_name" : "vpc_member_group", "member_group_weight" : 10, "microservice_version" : "v1", "microservice_port" : 80, "microservice_labels" : [ { "label_name" : "cluster_id", "label_value" : "c429700c-5dc4-482a-9c0e-99f6c0635113" } ] } ] } ``` #### 响应示例 **状态码：201** Created - 示例 1 ``` { "total" : 1, "size" : 1, "member_groups" : [ { "member_group_name" : "vpc_member_group", "member_group_id" : "105c6902457144a4820dff8b1ad63331", "member_group_remark" : "", "member_group_weight" : 10, "create_time" : "2020-07-23T07:24:33Z", "update_time" : "2020-07-23T07:24:33Z", "microservice_version" : "", "microservice_port" : 0, "microservice_labels" : [ ] } ] } ``` - 示例 2 ``` { "total" : 1, "size" : 1, "member_groups" : [ { "member_group_name" : "vpc_member_group", "member_group_id" : "105c6902457144a4820dff8b1ad63331", "member_group_remark" : "", "member_group_weight" : 10, "create_time" : "2020-07-23T07:24:33Z", "update_time" : "2020-07-23T07:24:33Z", "microservice_version" : "v1", "microservice_port" : 80, "microservice_labels" : [ { "label_name" : "cluster_id", "label_value" : "c429700c-5dc4-482a-9c0e-99f6c0635113" } ] } ] } ``` **状态码：400** Bad Request ``` { "error_code" : "APIG.2001", "error_msg" : "The request parameters must be specified, parameter name:name" } ``` **状态码：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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-apig/ErrorCode.html)。