Help Center/ ROMA Connect/ API Reference (ME-Abu Dhabi Region)/ APIC APIs/ VPC Channel Management/ Querying Details of a VPC Channel
Updated on 2022-12-05 GMT+08:00
View PDF
Share

Querying Details of a VPC Channel

Function

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

URI

GET /v2/{project_id}/apic/instances/{instance_id}/vpc-channels/{vpc_channel_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.

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

name

String

VPC channel name.

The value is a string of 3 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with an English letter.

NOTE:

Characters must be encoded using UTF-8 or Unicode.

type

Integer

VPC channel type.

  • 1: private network ELB channel (to be deprecated)

  • 2: fast channel with the load balancing function

port

Integer

Port number of the host in the VPC channel.

The value ranges from 1 to 65535. This parameter is valid only if the VPC channel type is 2.

This parameter is mandatory only if the VPC channel type is 2.

balance_strategy

Integer

Distribution algorithm.

  • 1: WRR

  • 2: WLC

  • 3: SH

  • 4: URI hashing

This parameter is required if the VPC channel type is set to 2.

member_type

String

Member type of the VPC channel.

  • ip

  • ecs

This parameter is required if the VPC channel type is set to 2.

Default: ecs

create_time

String

Time when the VPC channel is created

id

String

VPC channel ID.

status

Integer

VPC channel status.

elb_id

String

ID of a private network ELB channel.

This parameter is valid only when the VPC channel type is set to 1.

members

Array of VpcMemberInfo objects

Backend server list. Only one backend server is included if the VPC channel type is set to 1.

vpc_health_config

VpcHealthConfigInfo object

Health check details. This parameter is valid only when the VPC channel type is set to 2.
Table 4 VpcMemberInfo

Parameter

Type

Description

host

String

Backend server address.

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

Maximum: 64

weight

Integer

Backend server weight.

The higher the weight is, the more requests a cloud server will receive. The weight is only available for the WRR and WLC algorithms.

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

Minimum: 0

Maximum: 100

ecs_id

String

Backend server ID.

This parameter is valid only when the backend instance type is instance. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_).

Maximum: 255

ecs_name

String

Backend server name.

This parameter is valid only when the backend instance type is instance. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

Maximum: 64

id

String

Backend instance object ID.

status

Number

Backend server status.

  • 1: valid

vpc_channel_id

String

VPC channel ID.

create_time

String

Time when the backend server is added to the VPC channel.
Table 5 VpcHealthConfigInfo

Parameter

Type

Description

protocol

String

Protocol for performing health checks on backend servers in the VPC channel

path

String

Destination path for health checks. This parameter is required if protocol is set to http.

method

String

Request method for health checks.

Default: GET

port

Integer

Destination port for health checks. By default, the host port of the VPC channel is used.

Minimum: 0

Maximum: 65535

threshold_normal

Integer

Healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy.

Minimum: 2

Maximum: 10

threshold_abnormal

Integer

Unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy.

Minimum: 2

Maximum: 10

time_interval

Integer

Interval between consecutive checks. Unit: s. The value must be greater than that of timeout.

Minimum: 5

Maximum: 300

http_code

String

Response codes for determining a successful HTTP response. The value can be any integer within 100–599 in one of the following formats: Multiple values, for example, 200,201,202 Range, for example, 200-299 Multiple values and ranges, for example, 201,202,210-299. This parameter is required if protocol is set to http.

enable_client_ssl

Boolean

Whether to enable two-way authentication . If this function is enabled, the certificate specified by backend_client_certificate in the instance configuration is used.

Default: false

timeout

Integer

Timeout for determining whether a health check fails. Unit: s. The value must be less than that of time_interval.

Minimum: 2

Maximum: 30

vpc_channel_id

String

VPC channel ID.

id

String

Health check ID.

create_time

String

Creation time.

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

{
  "id" : "56a7d7358e1b42459c9d730d65b14e59",
  "balance_strategy" : 1,
  "create_time" : "2020-07-23T07:11:57.244829604Z",
  "member_type" : "ip",
  "port" : 22,
  "status" : 1,
  "name" : "VPC_demo",
  "type" : 2,
  "vpc_health_config" : {
    "create_time" : "2020-07-23T07:11:57Z",
    "http_code" : "200",
    "id" : "3b3d02026c5f402d85e8645ea95b0816",
    "method" : "GET",
    "path" : "/vpc/demo",
    "port" : 22,
    "protocol" : "http",
    "threshold_abnormal" : 5,
    "threshold_normal" : 2,
    "time_interval" : 10,
    "timeout" : 5,
    "enable_client_ssl" : false
  },
  "members" : [ {
    "create_time" : "2020-07-23T07:11:57Z",
    "host" : "192.168.0.5",
    "id" : "be63c6260a1043888187f84af39c9f0e",
    "status" : 1,
    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
    "weight" : 1
  }, {
    "create_time" : "2020-07-23T07:11:57Z",
    "host" : "192.168.1.124",
    "id" : "a57b13f1b89b417ca8acd76909e6df67",
    "status" : 1,
    "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
    "weight" : 2
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:id. 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