Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ VPC Channel Management/ Modifying a Backend Server Group of a VPC Channel

Updated on 2025-03-26 GMT+08:00

Online Debugging

CLI Examples

View PDF

Modifying a Backend Server Group of a VPC Channel

Function

This API is used to update a backend server group of a VPC channel. If the load balance channel is the Nacos microservice, the server group weight cannot be modified.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.
instance_id	Yes	String	Instance ID.
vpc_channel_id	Yes	String	VPC channel ID.
member_group_id	Yes	String	ID of the backend server group of the VPC channel.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
member_group_name	Yes	String	Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. NOTE: Chinese characters must be in UTF-8 or Unicode format.
member_group_remark	No	String	Description of the VPC channel's backend server group.
member_group_weight	No	Integer	Weight of the backend server group of the VPC channel. If servers exist in the current server group and the weight value exists, the weight value is automatically used to assign weights.
dict_code	No	String	Dictionary code of the backend server group of the VPC channel. The code can contain letters, digits, and special characters (-_). Not supported currently.
microservice_version	No	String	Version of the backend server group. This parameter is supported only when the VPC channel type is microservice.
microservice_port	No	Integer	Port of the backend server group. This parameter is supported only when the VPC channel type is microservice. If the port number is 0, all addresses in the backend server group use the original load balancing port to inherit logic.
microservice_labels	No	Array of MicroserviceLabel objects	Tags of the backend server group. This parameter is supported only when the VPC channel type is microservice.
reference_vpc_channel_id	No	String	ID of the reference load balance channel. This parameter is supported only when the VPC channel type is reference (vpc_channel_type=reference).

**Table 4** MicroserviceLabel
Parameter	Mandatory	Type	Description
label_name	Yes	String	Tag key Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)
label_value	Yes	String	Tag value Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
member_group_name	String	Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. NOTE: Chinese characters must be in UTF-8 or Unicode format.
member_group_remark	String	Description of the VPC channel's backend server group.
member_group_weight	Integer	Weight of the backend server group of the VPC channel. If servers exist in the current server group and the weight value exists, the weight value is automatically used to assign weights.
dict_code	String	Dictionary code of the backend server group of the VPC channel. The code can contain letters, digits, and special characters (-_). Not supported currently.
microservice_version	String	Version of the backend server group. This parameter is supported only when the VPC channel type is microservice.
microservice_port	Integer	Port of the backend server group. This parameter is supported only when the VPC channel type is microservice. If the port number is 0, all addresses in the backend server group use the original load balancing port to inherit logic.
microservice_labels	Array of MicroserviceLabel objects	Tags of the backend server group. This parameter is supported only when the VPC channel type is microservice.
reference_vpc_channel_id	String	ID of the reference load balance channel. This parameter is supported only when the VPC channel type is reference (vpc_channel_type=reference).
member_group_id	String	ID of the backend server group of the VPC channel.
create_time	String	Time when the backend server group is created.
update_time	String	Time when the backend server group is updated.

**Table 6** MicroserviceLabel
Parameter	Type	Description
label_name	String	Tag key Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)
label_value	String	Tag value Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.)

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

Modify a server-type server group of a specified VPC channel by changing the weight.

{
  "member_group_name" : "vpc_member_group",
  "member_group_weight" : 10
}

Example Responses

Status code: 200

Example 1

{
  "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"
}

Example 2

{
  "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"
}

Status code: 400

Bad Request

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

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3023",
  "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: VPC Channel Management

Previous topic: Deleting a VPC Backend Server Group

Next topic: Credential Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot