Querying VPC Channel Details
Function
This API is used to query the details of a VPC channel.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document. |
instance_id |
Yes |
String |
Gateway ID. |
vpc_channel_id |
Yes |
String |
VPC channel ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
name |
String |
VPC channel name. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
port |
Integer |
Host port of the VPC channel. This parameter is valid only when the VPC channel type is set to 2. The value range is 1–65535. This parameter is required only when the VPC channel type is set to 2. |
balance_strategy |
Integer |
Distribution algorithm.
This parameter is required only when the VPC channel type is set to 2. Default: 1 Enumeration values:
|
member_type |
String |
Member type of the VPC channel.
This parameter is required only when the VPC channel type is set to 2. Default: ecs Enumeration values:
|
create_time |
String |
Time when the VPC channel is created. |
id |
String |
VPC channel ID. |
status |
Integer |
VPC channel status.
Enumeration values:
|
member_groups |
Array of MemberGroupInfo objects |
Backend cloud server groups. Currently, this parameter is not supported. |
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. |
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. |
member_group_weight |
Integer |
Weight of the backend server group. If the server group contains servers and a weight has been set for it, the weight is automatically used to assign weights to servers in this group. Minimum: 0 Maximum: 100 |
dict_code |
String |
Dictionary code of the backend server group. The value can contain letters, digits, hyphens (-), underscores (_), and periods (.). Currently, this parameter is not supported. 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. |
Parameter |
Type |
Description |
---|---|---|
host |
String |
Backend server address. This parameter is required when the member type is IP address. Maximum: 64 |
weight |
Integer |
Weight. The higher the weight is, the more requests a backend service will receive. Minimum: 0 Maximum: 10000 |
is_backup |
Boolean |
Indicates whether the backend service is a standby node. After you enable this function, the backend service serves as a standby node. It works only when all non-standby nodes are faulty. This function is supported only when your gateway has been upgraded to the corresponding version. If your gateway does not support this function, contact technical support. Default: false |
member_group_name |
String |
Backend server group name. Select a server group for the backend service address. Currently, this parameter is not supported. |
status |
Integer |
Backend server status.
Enumeration values:
|
port |
Integer |
Backend server port. Minimum: 0 Maximum: 65535 |
ecs_id |
String |
Backend server ID. This parameter is valid when the member type is instance. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), and underscores (_). |
ecs_name |
String |
Backend server name. This parameter is valid when the member type is instance. The value can contain 1 to 64 characters, including letters, digits, periods (.), hyphens (-), and underscores (_). |
id |
String |
Backend server ID. |
vpc_channel_id |
String |
VPC channel ID. |
create_time |
String |
Time when the backend server is added to the VPC channel. |
member_group_id |
String |
Backend server group ID. Currently, this parameter is not supported. |
Parameter |
Type |
Description |
---|---|---|
protocol |
String |
Protocol for performing health checks on backend servers in the VPC channel. Enumeration values:
|
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 Enumeration values:
|
port |
Integer |
Destination port for health checks. By default, the host port of the VPC channel is used. Minimum: 1 Maximum: 65535 |
threshold_normal |
Integer |
Healthy threshold. It 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. It 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 the value 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:
|
enable_client_ssl |
Boolean |
Indicates whether to enable two-way authentication. If this function is enabled, the certificate specified in the backend_client_certificate configuration item of the gateway is used. Default: false |
status |
Integer |
Health check result.
Enumeration values:
|
timeout |
Integer |
Timeout for determining whether a health check fails. Unit: s. 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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot