Queries one or more physical connection access points in a region.
Debug
By using API Explorer, you can easily debug APIs, automatically generate SDK code examples, and quickly search for APIs.
Request parameters
Parameter | Type | Required? | Example value | Description |
---|---|---|---|---|
Action | String | Yes | DescribeAccessPoints | The name of this action. Value: DescribeAccessPoints |
RegionId | String | Yes | cn-hangzhou | The region to which the access point belongs. To query the region ID, call DescribeRegions. |
Filter.N.Key | String | No | Status | The type of the n-th filter. Value range of N: 1 to 5. |
Filter.N.Value.M | RepeatList | No | recommend | The m-th value of the n-th filter. Value range of M: 1 to 5. |
HostOperator | String | No | Telecom | The service provider to which the data center connected to the access point belongs. |
Name | String | No | test | The name of the access point. |
PageNumber | Integer | No | 2 | The number of pages to return. Default value: 1. |
PageSize | Integer | No | 10 | The number of rows per page. Maximum value: 50. Default value: 10. |
Response parameters
Parameter | Type | Example value | Description |
---|---|---|---|
AccessPointSet | N/A | N/A | A list of access points. |
└AccessPointId | String | ap-cn-beijing-ft-A | The ID of the access point. |
└AttachedRegionNo | String | cn-beijing | The region of the access point. |
└Description | String | ap1 | The description of the access point. |
└HostOperator | String | CNIX | The service provider of the access point. |
└Location | String | aplocation | The location of the access point. |
└Name | String | Beijing-Fengtai-A | The name of the access point. |
└Status | String | recommended | The status of the access point. |
└Type | String | VPC | The network type of the access of the physical connection. |
TotalCount | Integer | 5 | The number of queried entries. |
PageNumber | Integer | 1 | The current page number. |
PageSize | Integer | 10 | The number of entries per page. |
RequestId | String | 3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027 | The ID of the request. |
Examples
Request example
https://vpc.aliyuncs.com/?RegionId=cn-hangzhou
&<CommonParameters>
Response example
XML format
<DescribeAccessPointsResponse>
<AccessPointSet>
<AccessPointType>
<Name>Beijing-Fengtai-A</Name>
<Status>recommended</Status>
<Description>cn-beijing-ft-cxp32</Description>
<Type>VPC</Type>
<Location/>
<HostOperator>xxx</HostOperator>
<AttachedRegionNo>cn-beijing</AttachedRegionNo>
<AccessPointId>ap-cn-beijing-ft-A</AccessPointId>
</AccessPointType>
<AccessPointType>
<Name>Beijing-Yizhuang-A</Name>
<Status>recommended</Status>
<Description>cn-beijing-yz-ne203</Description>
<Type>VPC</Type>
<Location/>
<HostOperator>xxx</HostOperator>
<AttachedRegionNo>cn-beijing</AttachedRegionNo>
<AccessPointId>ap-cn-beijing-yz-A</AccessPointId>
</AccessPointType>
<AccessPointType>
<Name>Beijing-Daxing-B</Name>
<Status>recommended</Status>
<Description>cn-beijing-dx-nu16</Description>
<Type>VPC</Type>
<Location/>
<HostOperator>China Unicom</HostOperator>
<AttachedRegionNo>cn-beijing</AttachedRegionNo>
<AccessPointId>ap-cn-beijing-dx-B</AccessPointId>
</AccessPointType>
<AccessPointType>
<Name>Beijing-Changping-A</Name>
<Status>recommended</Status>
<Description>ap-cn-beijing-cp-CM12</Description>
<Type>VPC</Type>
<Location/>
<HostOperator>China Telecom</HostOperator>
<AttachedRegionNo>cn-beijing</AttachedRegionNo>
<AccessPointId>ap-cn-beijing-cp-A</AccessPointId>
</AccessPointType>
<AccessPointType>
<Name>Beijing-Daxing-A</Name>
<Status>recommended</Status>
<Description>cn-beijing-dx-nu17-a</Description>
<Type>VPC</Type>
<Location/>
<HostOperator>GDS</HostOperator>
<AttachedRegionNo>cn-beijing</AttachedRegionNo>
<AccessPointId>ap-cn-beijing-dx-A</AccessPointId>
</AccessPointType>
</AccessPointSet>
<PageNumber>1</PageNumber>
<TotalCount>5</TotalCount>
<PageSize>10</PageSize>
<RequestId>3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027</RequestId>
</DescribeAccessPointsResponse>
JSON format
{
"PageNumber":1,
"AccessPointSet":{
"AccessPointType":[
{
"Name":"Beijing-Fengtai-A",
"Status":"recommended",
"Description":"cn-beijing-ft-cxp32",
"Type":"VPC",
"Location":"",
"HostOperator":"CNIX",
"AttachedRegionNo":"cn-beijing",
"AccessPointId":"ap-cn-beijing-ft-A"
},
{
"Name":"Beijing-Yizhuang-A",
"Status":"recommended",
"Description":"cn-beijing-yz-ne203",
"Type":"VPC",
"Location":"",
"HostOperator":"21vianet",
"AttachedRegionNo":"cn-beijing",
"AccessPointId":"ap-cn-beijing-yz-A"
},
{
"Name":"Beijing-Daxing-B",
"Status":"recommended",
"Description":"cn-beijing-dx-nu16",
"Type":"VPC",
"Location":"",
"HostOperator":"China Unicom",
"AttachedRegionNo":"cn-beijing",
"AccessPointId":"ap-cn-beijing-dx-B"
},
{
"Name":"Beijing-Changping-A",
"Status":"recommended",
"Description":"ap-cn-beijing-cp-CM12",
"Type":"VPC",
"Location":"",
"HostOperator":"China Telecom",
"AttachedRegionNo":"cn-beijing",
"AccessPointId":"ap-cn-beijing-cp-A"
},
{
"Name":"Beijing-Daxing-A",
"Status":"recommended",
"Description":"cn-beijing-dx-nu17-a",
"Type":"VPC",
"Location":"",
"HostOperator":"GDS",
"AttachedRegionNo":"cn-beijing",
"AccessPointId":"ap-cn-beijing-dx-A"
}
]
},
"TotalCount":5,
"PageSize":10,
"RequestId":"3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
404 | InvalidRegionId.NotSupport | The RegionId provided does not support in our records. | The specified region ID is invalid. |