DescribeAccessPoints - API reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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 on each page. Maximum value: 50. Default value: 10.

Response parameters


Parameter	Type	Example	Description
AccessPointSet	Array of AccessPointType		The information about the access point.
AccessPointType
AccessPointFeatureModels	Array of AccessPointFeatureModel		The feature model of the access point.
AccessPointFeatureModel
FeatureKey	String	AP_Support_VbrBandwidthLimit	The feature of the access point.
FeatureValue	String	true	The feature value of the access point.
AccessPointId	String	ap-cn-hangzhou-****	The ID of the access point.
AttachedRegionNo	String	cn-hangzhou	The region ID of the access point.
Description	String	Access point description	The description of the access point.
HostOperator	String	China Telecom	The colocation provider of the access point.
Location	String	China (Hangzhou)	The location of the access point.
Name	String	Hangzhou-Yuhang-C	The name of the access point.
Status	String	recommended	The status of the access point. Valid values: Recommended: The access point is ready for use. hot: A large number of Express Connect circuits are connected to the access point. full: The number of Express Connect circuits connected to the access point has reached the upper limit. disabled: The access point is unavailable.
Type	String	VPC	The network type of the Express Connect circuit. Default value: VPC.
TotalCount	Integer	5	The total number of entries.
PageNumber	Integer	1	The number of the returned page. Default value: 1.
PageSize	Integer	10	The number of entries returned on each page. Maximum value: 50. Default value: 10.
RequestId	String	3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027	The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAccessPoints
&RegionId=cn-hangzhou
&<Common request parameters>

Successful response examples

XML format

<DescribeAccessPointsResponse>
      <AccessPointSet>
            <AccessPointType>
                  <Status>recommended</Status>
                  <Type>VPC</Type>
                  <Description>Access point description</Description>
                  <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
                  <HostOperator>China Telecom</HostOperator>
                  <AccessPointId>ap-cn-hangzhou-****</AccessPointId>
                  <Name>Hangzhou-Yuhang-C</Name>
                  <Location>Hangzhou</Location>
                  <AccessPointFeatureModels>
                        <AccessPointFeatureModel>
                              <FeatureValue>true</FeatureValue>
                              <FeatureKey>AP_Support_VbrBandwidthLimit</FeatureKey>
                        </AccessPointFeatureModel>
                  </AccessPointFeatureModels>
            </AccessPointType>
      </AccessPointSet>
      <TotalCount>5</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027</RequestId>
      <PageNumber>1</PageNumber>
</DescribeAccessPointsResponse>

JSON format

{
    "DescribeAccessPointsResponse": {
        "AccessPointSet": {
            "AccessPointType": {
                "Status": "recommended",
                "Type": "VPC",
                "Description": "Access point description",
                "AttachedRegionNo": "cn-hangzhou",
                "HostOperator": "China Telecom",
                "AccessPointId": "ap-cn-hangzhou-****",
                "Name": "Hangzhou-Yuhang-C",
                "Location": "Hangzhou",
                "AccessPointFeatureModels": {
                    "AccessPointFeatureModel": {
                        "FeatureValue": true,
                        "FeatureKey": "AP_Support_VbrBandwidthLimit"
                    }
                }
            }
        },
        "TotalCount": 5,
        "PageSize": 10,
        "RequestId": "3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027",
        "PageNumber": 1
    }
}

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.