Updated on 2023-06-29 GMT+08:00

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.

port

Integer

Port number of the host in the VPC channel.

The value ranges from 1 to 65535.

balance_strategy

Integer

Distribution algorithm.

  • 1: WRR

  • 2: WLC

  • 3: SH

  • 4: URI hashing

Default: 1

member_type

String

Member type of the VPC channel.

  • ip

  • ecs

Default: ecs

dict_code

String

The dictionary code of a VPC channel.

The value can contain letters, digits, and special characters (-_).

Not supported currently.

Minimum: 3

Maximum: 64

create_time

String

Time when the VPC channel is created.

id

String

VPC channel ID.

status

Integer

VPC channel status.

  • 1: normal

  • 2: abnormal

member_groups

Array of MemberGroupInfo objects

Backend cloud server groups.

microservice_info

MicroServiceInfo object

Response object of the microservice.

type

Integer

VPC channel type:

2: BUILTIN

3: MICROSERVICE

members

Array of VpcMemberInfo objects

Backend instance list.

vpc_health_config

VpcHealthConfigInfo object

Health check details.

Table 4 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 is created.

update_time

String

Time when the backend server group is updated.

Table 5 MicroServiceInfo

Parameter

Type

Description

id

String

Microservice ID.

service_type

String

Microservice type:

  • CSE

  • CCE (Not supported yet.)

cse_info

MicroServiceInfoCSE object

CSE information.

cce_info

MicroServiceInfoCCE object

To be supported

update_time

String

Time when the microservice is updated.

create_time

String

Time when the microservice is created.

Table 6 MicroServiceInfoCSE

Parameter

Type

Description

engine_id

String

Microservice engine ID.

Maximum: 64

service_id

String

Microservice ID.

Maximum: 64

engine_name

String

Microservice engine name.

service_name

String

Microservice name.

register_address

String

Registry center address.

cse_app_id

String

Application to which the microservice belongs.

version

String

Microservice version. This parameter is deprecated and is supported by the backend server group version.

Maximum: 64

Table 7 MicroServiceInfoCCE

Parameter

Type

Description

cluster_id

String

CCE cluster ID.

Maximum: 64

namespace

String

Namespace.

Maximum: 64

workload_type

String

Workload type. Options:

  • deployment

  • statefulset

  • daemonset

app_name

String

Application name.

Maximum: 64

label_key

String

Tag name.

Maximum: 64

label_value

String

Tag value.

Maximum: 64

cluster_name

String

CCE cluster name.

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

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

Minimum: 0

Maximum: 10000

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.

Default: false

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.

Minimum: 0

Maximum: 65535

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

Maximum: 255

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

Maximum: 64

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.

Table 9 VpcHealthConfigInfo

Parameter

Type

Description

protocol

String

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

  • TCP

  • HTTP

  • HTTPS

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. If this parameter is not specified or set to 0, the host port of the VPC channel is used.

If the port has a non-zero value, the port is used for health checks.

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: 1

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: 1

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

status

Integer

Health check status

  • 1: available

  • 2: unavailable

timeout

Integer

Timeout for determining whether a health check fails, in seconds. The value must be less than the value 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 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 14 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

  • Example 1

    {
      "name" : "VPC_demo",
      "port" : 22,
      "balance_strategy" : 1,
      "member_type" : "ip",
      "dict_code" : "",
      "create_time" : "2020-07-23T07:11:57.244829604Z",
      "id" : "56a7d7358e1b42459c9d730d65b14e59",
      "status" : 1,
      "member_groups" : [ ],
      "type" : 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",
        "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" : ""
      } ],
      "vpc_health_config" : {
        "protocol" : "http",
        "path" : "/vpc/demo",
        "method" : "GET",
        "port" : 22,
        "threshold_normal" : 2,
        "threshold_abnormal" : 5,
        "time_interval" : 10,
        "http_code" : "200",
        "enable_client_ssl" : false,
        "status" : 1,
        "timeout" : 5,
        "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
        "id" : "3b3d02026c5f402d85e8645ea95b0816",
        "create_time" : "2020-07-23T07:11:57Z"
      },
      "microservice_info" : {
        "id" : "",
        "project_id" : "",
        "instance_id" : "",
        "service_type" : "",
        "cse_info" : {
          "cse_app_id" : "",
          "engine_id" : "",
          "engine_name" : "",
          "register_address" : "",
          "service_id" : "",
          "service_name" : "",
          "version" : ""
        },
        "cce_info" : {
          "cluster_id" : "",
          "cluster_name" : "",
          "namespace" : "",
          "workload_type" : "",
          "app_name" : ""
        },
        "create_time" : "",
        "update_time" : ""
      }
    }
  • Example 2

    {
      "name" : "VPC_demo",
      "id" : "105c6902457144a4820dff8b1ad63331",
      "balance_strategy" : 1,
      "dict_code" : "",
      "create_time" : "2020-07-23T07:11:57.244829604Z",
      "member_type" : "ip",
      "port" : 22,
      "status" : 1,
      "member_groups" : [ {
        "member_group_id" : "c1ce135c705c4066853a0460b318fe16",
        "member_group_name" : "test",
        "member_group_weight" : 1,
        "member_group_remark" : "remark",
        "create_time" : "2020-07-23T07:11:57.244829604Z",
        "update_time" : "2020-07-23T07:11:57.244829604Z",
        "microservice_version" : "v1",
        "microservice_port" : 80
      }, {
        "member_group_id" : "c1ce135c705c4066853a0460b318fe17",
        "member_group_name" : "default",
        "member_group_weight" : 2,
        "member_group_remark" : "remark",
        "create_time" : "2020-07-23T07:11:57.244829604Z",
        "update_time" : "2020-07-23T07:11:57.244829604Z",
        "microservice_version" : "v2",
        "microservice_port" : 80
      } ],
      "type" : 3,
      "vpc_health_config" : {
        "protocol" : "http",
        "path" : "/vpc/demo",
        "method" : "GET",
        "port" : 22,
        "threshold_normal" : 2,
        "threshold_abnormal" : 5,
        "time_interval" : 10,
        "http_code" : "200",
        "enable_client_ssl" : false,
        "status" : 1,
        "timeout" : 5,
        "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
        "id" : "3b3d02026c5f402d85e8645ea95b0816",
        "create_time" : "2020-07-23T07:11:57Z"
      },
      "microservice_info" : {
        "id" : "9483afa235be45158a70c19ab817ac65",
        "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
        "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e",
        "service_type" : "CCE",
        "cse_info" : {
          "cse_app_id" : "",
          "engine_id" : "",
          "engine_name" : "",
          "register_address" : "",
          "service_id" : "",
          "service_name" : "",
          "version" : ""
        },
        "cce_info" : {
          "cluster_id" : "ab1485b4f91b45abbcd560be591f7309",
          "cluster_name" : "cce-test",
          "namespace" : "default",
          "workload_type" : "deployment",
          "app_name" : "testapp"
        },
        "create_time" : "2020-07-23T07:11:57.244829604Z",
        "update_time" : "2020-07-23T07:11:57.244829604Z"
      }
    }

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.