Viewing Details About a Backend Server Group of a VPC Channel
Function
View details about a backend server group of the specified VPC channel.
URI
GET /v2/{project_id}/apic/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups/{member_group_id}
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. |
member_group_id |
Yes |
String |
ID of the backend server group of the VPC channel. |
Request 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
Parameter |
Type |
Description |
---|---|---|
member_group_name |
String |
Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
NOTE:
Chinese characters must be in UTF-8 or Unicode format. |
member_group_remark |
String |
Description of the VPC channel's backend server group. |
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. |
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. |
microservice_version |
String |
Version of the backend server group. This parameter is supported only when the VPC channel type is microservice. |
microservice_port |
Integer |
Port of the backend server group. This parameter is supported only when the VPC channel type is microservice. If the port number is 0, all addresses in the backend server group use the original load balancing port to inherit logic. |
microservice_labels |
Array of MicroserviceLabel objects |
Tags of the backend server group. This parameter is supported only when the VPC channel type is microservice. |
reference_vpc_channel_id |
String |
ID of the reference load balance channel. This parameter is supported only when the VPC channel type is reference (vpc_channel_type=reference). |
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 |
---|---|---|
label_name |
String |
Tag key Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.) |
label_value |
String |
Tag value Start and end with a letter or digit. Use only letters, digits, hyphens (-), underscores (_), and periods (.). (Max. 63 characters.) |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
None
Example Responses
Status code: 200
OK
{ "member_group_name" : "vpc_member_group", "member_group_id" : "105c6902457144a4820dff8b1ad63331", "dict_code" : "", "member_group_remark" : "", "create_time" : "2020-07-23T07:24:33Z", "update_time" : "2020-07-23T07:24:33Z" }
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