Retrieves a list of VpcInfo objects for a specified Virtual Private Cloud (VPC).
Try it now
Test
RAM authorization
Request syntax
GET /v2/openapi/listvpcinfobyvpc HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| VpcId |
string |
Yes |
The ID of the VPC. |
vpc-bp1***********0mh8 |
| PageNum |
integer |
No |
The page number. |
1 |
| PageSize |
integer |
No |
The number of VPCs to return on each page. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response schema. |
||
| RequestId |
string |
The request ID. |
4141784E-91FF-56E3-9371-FD011FF876F4 |
| PageNum |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries returned per page. |
10 |
| TotalCount |
integer |
The total number of VPCs. |
1 |
| VpcId |
string |
The ID of the VPC. |
vpc-bp1***********0mh8 |
| VpcInfos |
array<object> |
The details of the VPCs. |
|
|
object |
The details of a VPC. |
||
| Domain |
string |
The VPC endpoint. |
http://xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com |
| InstanceVpcName |
string |
The name of the VPC. |
xu6666 |
| RegionNo |
string |
The region ID. |
cn-hangzhou |
| InstanceName |
string |
The name of the instance. |
mkdd-test |
| Endpoint |
string |
The endpoint of the instance. |
http://172.**.***.34:80/ |
Examples
Success response
JSON format
{
"RequestId": "4141784E-91FF-56E3-9371-FD011FF876F4",
"PageNum": 1,
"PageSize": 10,
"TotalCount": 1,
"VpcId": "vpc-bp1***********0mh8",
"VpcInfos": [
{
"Domain": "http://xu6666-mkdd-test.cn-hangzhou.vpc.ots.aliyuncs.com",
"InstanceVpcName": "xu6666",
"RegionNo": "cn-hangzhou",
"InstanceName": "mkdd-test",
"Endpoint": "http://172.**.***.34:80/"
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.