Help Center> ROMA Connect> API Reference> APIC APIs> VPC Channel Management> Adding or Updating a Backend Server Group of a VPC Channel
View PDF

Adding or Updating a Backend Server Group of a VPC Channel

Function

On ROMA Connect APIC, create a VPC backend server group. You can determine whether to associate a VPC backend instance with a backend instance server group to manage backend server nodes.

If the backend server group with the specified name already exists, the system updates the information about the backend server group. If the request body contains multiple backend server definitions with duplicate names, the first definition is used.

URI

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

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.

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_groups

No

Array of MemberGroupCreate objects

List of backend server groups.
Table 4 MemberGroupCreate

Parameter

Mandatory

Type

Description

member_group_name

Yes

String

Name of the backend server group of the VPC channel.

member_group_remark

No

String

Description of the backend server group of the VPC channel.

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.

Minimum: 0

Maximum: 100

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.

Minimum: 3

Maximum: 64

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

member_groups

Array of MemberGroupInfo objects

List of backend server groups of the VPC channel.
Table 6 MemberGroupInfo

Parameter

Type

Description

member_group_name

String

Name of the backend server group of the VPC channel.

member_group_remark

String

Description of the backend server group of the VPC channel.

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.

Minimum: 0

Maximum: 100

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.

Minimum: 3

Maximum: 64

member_group_id

String

ID of the backend server group of the VPC channel.

create_time

String

Time when the backend server group of the VPC channel was created.

update_time

String

Time when the backend server group of the VPC channel was updated.

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

{
  "member_groups" : [ {
    "member_group_name" : "vpc_member_group",
    "member_group_weight" : 10
  } ]
}

Example Responses

Status code: 201

Created

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

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.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620e"
}

Status code: 500

Internal Server Error

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

Status Codes

Status Code

Description

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: VPC Channel Management