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 points that you want to query. You can call the DescribeRegions operation to query region IDs.
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
RequestId	String	3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027	The ID of the request.
PageNumber	Integer	1	The number of the returned page.
PageSize	Integer	10	The number of entries returned per page.
TotalCount	Integer	5	The total number of entries returned.
AccessPointSet	Array		The information about the access point.
AccessPointId	String	ap-cn-hangzhou-xs-D	The ID of the access point.
Status	String	recommended	The state of the access point. Valid values: Recommended: The access point is ready for use. Hot: The access point is busy because a large number of customers are using the access point. Full: The access point is unavailable because the connections of the access point has reached the upper limit. Disabled: The access point is disabled.
Type	String	VPC	The network type of the physical connection.
AttachedRegionNo	String	cn-beijing	The region of the access point.
Location	String	Fengtai, Beijing	The location of the access point.
HostOperator	String	Haokuan	The Internet service provider (ISP) of the access point.
Name	String	Beijing-Fengtai-A	The name of the access point.
Description	String	ap-cn-hangzhou-dq-A-EU95	The description of the access point.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeAccessPoints>
  <AccessPointSet>
        <AccessPointType>
              <Name>Hangzhou-Deqing-A</Name>
              <Status>recommended</Status>
              <Description>ap-cn-hangzhou-dq-A-EU95</Description>
              <Type>VPC</Type>
              <Location></Location>
              <HostOperator>China Unicom</HostOperator>
              <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
              <AccessPointId>ap-cn-hangzhou-dq-A</AccessPointId>
        </AccessPointType>
        <AccessPointType>
              <Name>Hangzhou-Xiaoshan-D</Name>
              <Status>recommended</Status>
              <Description>ap-cn-hangzhou-xs-EM21</Description>
              <Type>VPC</Type>
              <Location></Location>
              <HostOperator>China Mobile</HostOperator>
              <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
              <AccessPointId>ap-cn-hangzhou-xs-D</AccessPointId>
        </AccessPointType>
        <AccessPointType>
              <Name>Hangzhou-Xiaoshan-B</Name>
              <Status>recommended</Status>
              <Description>cn-hangzhou-xs-cm3-b</Description>
              <Type>VPC</Type>
              <Location></Location>
              <HostOperator>China Telecom</HostOperator>
              <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
              <AccessPointId>ap-cn-hangzhou-xs-B</AccessPointId>
        </AccessPointType>
        <AccessPointType>
              <Name>Hangzhou-Jianggan-B</Name>
              <Status>recommended</Status>
              <Description>cn-hangzhou-jg-ne205-a</Description>
              <Type>VPC</Type>
              <Location></Location>
              <HostOperator>Shiji Hulian</HostOperator>
              <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
              <AccessPointId>ap-cn-hangzhou-jg-B</AccessPointId>
        </AccessPointType>
        <AccessPointType>
              <Name>Hangzhou-Jianggan-A</Name>
              <Status>recommended</Status>
              <Description>cn-hangzhou-jg-eu6-a</Description>
              <Type>VPC</Type>
              <Location></Location>
              <HostOperator>China Unicom</HostOperator>
              <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
              <AccessPointId>ap-cn-hangzhou-jg-A</AccessPointId>
        </AccessPointType>
        <AccessPointType>
              <Name>Hangzhou-Xiaoshan-A</Name>
              <Status>recommended</Status>
              <Description>cn-hangzhou-xs-cm10</Description>
              <Type>VPC</Type>
              <Location></Location>
              <HostOperator>China Unicom</HostOperator>
              <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
              <AccessPointId>ap-cn-hangzhou-xs-A</AccessPointId>
        </AccessPointType>
        <AccessPointType>
              <Name>Hangzhou-Lin'an-A</Name>
              <Status>recommended</Status>
              <Description>cn-hangzhou-la-AM5-a</Description>
              <Type>VPC</Type>
              <Location></Location>
              <HostOperator>Huatong</HostOperator>
              <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
              <AccessPointId>ap-cn-hangzhou-la-A</AccessPointId>
        </AccessPointType>
        <AccessPointType>
              <Name>Hangzhou-Yuhang-A</Name>
              <Status>recommended</Status>
              <Description>cn-hangzhou-yh-TBC-a</Description>
              <Type>VPC</Type>
              <Location></Location>
              <HostOperator>Huatong</HostOperator>
              <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
              <AccessPointId>ap-cn-hangzhou-yh-A</AccessPointId>
        </AccessPointType>
  </AccessPointSet>
  <PageNumber>1</PageNumber>
  <TotalCount>8</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>86E1053D-8BE4-4B75-A370-183E8D3FDF25</RequestId>
</DescribeAccessPoints>

JSON format

{
	"AccessPointSet": {
		"AccessPointType": [
			{
				"Name": "Hangzhou-Deqing-A",
				"Status": "recommended",
				"Description": "ap-cn-hangzhou-dq-A-EU95",
				"Type": "VPC",
				"Location": "",
				"HostOperator": "China Unicom",
				"AttachedRegionNo": "cn-hangzhou",
				"AccessPointId": "ap-cn-hangzhou-dq-A"
			},
			{
				"Name": "Hangzhou-Xiaoshan-D",
				"Status": "recommended",
				"Description": "ap-cn-hangzhou-xs-EM21",
				"Type": "VPC",
				"Location": "",
				"HostOperator": "China Mobile",
				"AttachedRegionNo": "cn-hangzhou",
				"AccessPointId": "ap-cn-hangzhou-xs-D"
			},
			{
				"Name": "Hangzhou-Xiaoshan-B",
				"Status": "recommended",
				"Description": "cn-hangzhou-xs-cm3-b",
				"Type": "VPC",
				"Location": "",
				"HostOperator": "China Telecom",
				"AttachedRegionNo": "cn-hangzhou",
				"AccessPointId": "ap-cn-hangzhou-xs-B"
			},
			{
				"Name": "Hangzhou-Jianggan-B",
				"Status": "recommended",
				"Description": "cn-hangzhou-jg-ne205-a",
				"Type": "VPC",
				"Location": "",
				"HostOperator": "Shiji Hulian",
				"AttachedRegionNo": "cn-hangzhou",
				"AccessPointId": "ap-cn-hangzhou-jg-B"
			},
			{
				"Name": "Hangzhou-Jianggan-A",
				"Status": "recommended",
				"Description": "cn-hangzhou-jg-eu6-a",
				"Type": "VPC",
				"Location": "",
				"HostOperator": "China Unicom",
				"AttachedRegionNo": "cn-hangzhou",
				"AccessPointId": "ap-cn-hangzhou-jg-A"
			},
			{
				"Name": "Hangzhou-Xiaoshan-A",
				"Status": "recommended",
				"Description": "cn-hangzhou-xs-cm10",
				"Type": "VPC",
				"Location": "",
				"HostOperator": "China Unicom",
				"AttachedRegionNo": "cn-hangzhou",
				"AccessPointId": "ap-cn-hangzhou-xs-A"
			},
			{
				"Name": "Hangzhou-Lin'an-A",
				"Status": "recommended",
				"Description": "cn-hangzhou-la-AM5-a",
				"Type": "VPC",
				"Location": "",
				"HostOperator": "Huatong",
				"AttachedRegionNo": "cn-hangzhou",
				"AccessPointId": "ap-cn-hangzhou-la-A"
			},
			{
				"Name": "Hangzhou-Yuhang-A",
				"Status": "recommended",
				"Description": "cn-hangzhou-yh-TBC-a",
				"Type": "VPC",
				"Location": "",
				"HostOperator": "Huatong",
				"AttachedRegionNo": "cn-hangzhou",
				"AccessPointId": "ap-cn-hangzhou-yh-A"
			}
		]
	},
	"PageNumber": 1,
	"TotalCount": 8,
	"PageSize": 10,
	"RequestId": "86E1053D-8BE4-4B75-A370-183E8D3FDF25"
}

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.