Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ VPC Channel Management/ Querying Backend Servers of a VPC Channel
Updated on 2025-07-18 GMT+08:00
View PDF

Querying Backend Servers of a VPC Channel

Function

This API is used to query the backend servers of a VPC channel.

URI

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

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0.

limit

No

Integer

Number of items displayed on each page.

name

No

String

Cloud server name.

member_group_name

No

String

Name of the backend server group.

member_group_id

No

String

ID of the backend server group.

precise_search

No

String

Parameter name for exact matching. If multiple parameters need to support exact match, separate them with commas (,).

Currently, name and member_group_name are supported.

Request Parameters

Table 3 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).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

members

Array of VpcMemberInfo objects

Backend server group ID.
Table 5 VpcMemberInfo

Parameter

Type

Description

host

String

Backend server address.

This parameter is valid when the member type is IP address.

weight

Integer

Backend server weight.

The higher the weight is, the more requests a cloud server will receive.

It is valid only when the VPC channel type is set to 2.

is_backup

Boolean

Indicates whether it is a standby node.

After this parameter is enabled, the corresponding backend service functions as the standby node and works only when all non-standby nodes are faulty.

The instance must be upgraded to the corresponding version to support this function. If the instance does not support this function, contact technical support.

member_group_name

String

Name of the backend server group. Select a server group for the backend service address so that the backend addresses of the corresponding server group can be changed in a unified manner.

status

Integer

Backend server status.

  • 1: available

  • 2: unavailable

port

Integer

Backend server port.

ecs_id

String

Backend ECS ID

This parameter is mandatory when the backend instance type is ECS. It can include letters, digits, hyphens (-), and underscores (_) (max. 64 characters).

ecs_name

String

Backend ECS name

This parameter is mandatory when the backend instance type is ECS. It can include letters, digits, hyphens (-), underscores (_), and periods (.) (max. 64 characters).

id

String

VPC channel list.

vpc_channel_id

String

Backend instance ID.

create_time

String

VPC channel ID.

member_group_id

String

Time when the backend server is added to the VPC channel.

health_status

String

Health status of the backend instance of the load balance channel. The value can be unknown, healthy, or unhealthy, indicating that no health check is performed, healthy, or unhealthy, respectively.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 2,
  "size" : 2,
  "members" : [ {
    "host" : "192.168.0.5",
    "weight" : 1,
    "is_backup" : false,
    "member_group_name" : "",
    "status" : 1,
    "port" : 22,
    "ecs_id" : "192.168.0.5",
    "ecs_name" : "192.168.0.5",
    "id" : "be63c6260a1043888187f84af39c9f0e",
    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
    "create_time" : "2020-07-23T07:11:57Z",
    "health_status" : "unhealthy",
    "member_group_id" : ""
  }, {
    "host" : "192.168.1.124",
    "weight" : 2,
    "is_backup" : false,
    "member_group_name" : "",
    "status" : 1,
    "port" : 22,
    "ecs_id" : "192.168.1.124",
    "ecs_name" : "192.168.1.124",
    "id" : "a57b13f1b89b417ca8acd76909e6df67",
    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
    "create_time" : "2020-07-23T07:11:57Z",
    "member_group_id" : "",
    "health_status" : "unhealthy"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

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