DescribeAccessPoints - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the access points of Express Connect circuits in a region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the access point. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN: Chinese en-US (default): English	zh-CN

Response parameters

Parameter	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027
PageNumber	integer	The page number. Default value: 1.	1
PageSize	integer	The number of entries returned per page. Maximum value: 50. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	5
AccessPointSet	array<object>	The information about the access point.
AccessPointType	object
Status	string	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.	recommended
Type	string	The network type of the Express Connect circuit. Default value: VPC.	VPC
HostOperator	string	The Internet service provider (ISP) of the access point. Valid values:	Telehouse
Description	string	The description of the access point.	The description of the access point.
AttachedRegionNo	string	The region ID of the access point.	cn-hangzhou
Name	string	The name of the access point.	Name
AccessPointId	string	The ID of the access point.	ap-cn-hangzhou-****
Location	string	The location of the access point.	Hangzhou
AccessPointFeatureModels	array<object>	The feature model of the access point.
AccessPointFeatureModel	object
FeatureValue	string	The feature value of the access point.	true
FeatureKey	string	The feature of the access point.	AP_Support_VbrBandwidthLimit

Examples

Sample success responses

JSONformat

{
  "RequestId": "3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 5,
  "AccessPointSet": {
    "AccessPointType": [
      {
        "Status": "recommended",
        "Type": "VPC",
        "HostOperator": "Telehouse",
        "Description": "The description of the access point.",
        "AttachedRegionNo": "cn-hangzhou",
        "Name": "Name",
        "AccessPointId": "ap-cn-hangzhou-****",
        "Location": "Hangzhou",
        "AccessPointFeatureModels": {
          "AccessPointFeatureModel": [
            {
              "FeatureValue": "true",
              "FeatureKey": "AP_Support_VbrBandwidthLimit"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAccessPointType.NotSupport	Invalid access point type.	-
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	The RegionId parameter is set to an invalid value. Specify a valid value and try again.
404	InvalidRegionId.NotSupport	The RegionId provided does not support in our records.	The specified region ID is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-20	API Description Update. The Error code has changed	View Change Details
2023-05-18	The Error code has changed. The request parameters of the API has changed	View Change Details