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

Querying VPC Channels

Function

This API is used to query the VPC channels.

URI

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

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

Default: 0

limit

No

Integer

Number of items displayed on each page.

Minimum: 1

Maximum: 500

Default: 20

id

No

String

VPC channel ID.

name

No

String

VPC channel name.

vpc_type

No

Integer

VPC channel type.

precise_search

No

String

Parameter name (name) for exact matching.

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.

vpc_channels

Array of VpcChannelInfo objects

VPC channel list.
Table 5 VpcChannelInfo

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.

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,
  "vpc_channels" : [ {
    "member_type" : "instance",
    "balance_strategy" : 1,
    "create_time" : "2020-07-23T07:24:33Z",
    "port" : 8080,
    "name" : "channel 1",
    "id" : "105c6902457144a4820dff8b1ad63331",
    "type" : 1,
    "status" : 1
  }, {
    "member_type" : "ip",
    "balance_strategy" : 2,
    "create_time" : "2020-07-23T07:11:57Z",
    "port" : 8088,
    "name" : "channel 2",
    "id" : "56a7d7358e1b42459c9d730d65b14e59",
    "type" : 2,
    "status" : 1
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "The request parameters must be specified,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.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

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