Queries the access points of an Express Connect circuit in a specific region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeAccessPoints | The operation that you want to perform. Set the value to DescribeAccessPoints. |
RegionId | String | Yes | cn-hangzhou | The region ID of the access point. You can call the DescribeRegions operation to query the most recent region list. |
PageNumber | Integer | No | 1 | The number of the page to return. Default value: 1. |
PageSize | Integer | No | 10 | The number of entries to return per page. Maximum value: 50. Default value: 10. |
AcceptLanguage | String | No | zh-CN | The language of the response. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027 | The request ID. |
PageNumber | Integer | 1 | The page number of the returned page. Default value: 1. |
PageSize | Integer | 10 | The number of entries returned per page. Maximum value: 50. Default value: 10. |
TotalCount | Integer | 5 | The number of entries returned. |
AccessPointSet | Array of AccessPointType | The information about the access point. |
|
AccessPointType | |||
Status | String | recommended | The status of the access point. Valid values:
|
Type | String | VPC | The network type of the Express Connect circuit. Default value: VPC. |
HostOperator | String | China Telecom | The Internet service provider (ISP) of the access point. Valid values: |
Description | String | Access point description | The description of the access point. |
AttachedRegionNo | String | cn-hangzhou | The region ID of the access point. |
Name | String | Hangzhou-Yuhang-C | The name of the access point. |
AccessPointId | String | ap-cn-hangzhou-**** | The ID of the access point. |
Location | String | Hangzhou | The location of the access point. |
AccessPointFeatureModels | Array of AccessPointFeatureModel | The feature model of the access point. |
|
AccessPointFeatureModel | |||
FeatureValue | String | true | The feature value of the access point. |
FeatureKey | String | AP_Support_VbrBandwidthLimit | The feature of the access point. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeAccessPoints
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&AcceptLanguage=zh-CN
&Common request parameters
Successful response examples
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeAccessPointsResponse>
<RequestId>3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027</RequestId>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>5</TotalCount>
<AccessPointSet>
<Status>recommended</Status>
<Type>VPC</Type>
<HostOperator>China Telecom</HostOperator>
<Description>Access point description</Description>
<AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
<Name>Hangzhou-Yuhang-C</Name>
<AccessPointId>ap-cn-hangzhou-****</AccessPointId>
<Location>Hangzhou</Location>
<AccessPointFeatureModels>
<FeatureValue>true</FeatureValue>
<FeatureKey>AP_Support_VbrBandwidthLimit</FeatureKey>
</AccessPointFeatureModels>
</AccessPointSet>
</DescribeAccessPointsResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027",
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 5,
"AccessPointSet" : [ {
"Status" : "recommended",
"Type" : "VPC",
"HostOperator" : "China Telecom",
"Description" : "Access point description",
"AttachedRegionNo" : "cn-hangzhou",
"Name" : "Hangzhou-Yuhang-C",
"AccessPointId" : "ap-cn-hangzhou-****",
"Location" : "Hangzhou",
"AccessPointFeatureModels" : [ {
"FeatureValue" : "true",
"FeatureKey" : "AP_Support_VbrBandwidthLimit"
} ]
} ]
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidRegionId.NotSupport | The RegionId provided does not support in our records. | The error message returned because the specified region ID is invalid. |
For a list of error codes, visit the API Error Center.