DescribeAccessPoints-阿里云帮助中心

Call the DescribeAccessPoints operation to query Express Connect access points in a specified region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the access point is located. You can call the DescribeRegions operation to obtain the region ID.	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 elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027
PageNumber	integer	The page number. Default: 1.	1
PageSize	integer	The number of entries per page. Maximum: 50. Default: 10.	10
TotalCount	integer	The total number of entries.	5
AccessPointSet	object	The list of access points.
AccessPointType	array<object>	The list of access points.
	array<object>	The details of an access point.
Status	string	The status of the access point. recommended: The access point is operating normally. hot: The access point is under heavy load but operating normally. full: The access point is fully occupied and cannot accept new connections. disabled: The access point is unavailable.	recommended
Type	string	The network type to which the access point provides access. Default: VPC.	VPC
HostOperator	string	The carrier of the access point.	中国电信
Description	string	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.	杭州-余杭-C
AccessPointId	string	The access point ID.	ap-cn-hangzhou-****
Location	string	The location of the access point.	杭州
AccessPointFeatureModels	object	A list of features of the access point.
AccessPointFeatureModel	array<object>	A list of features of the access point.
	object	A feature of the access point.
FeatureValue	string	The value of the feature.	true
FeatureKey	string	The key of the feature.	AP_Support_VbrBandwidthLimit

Examples

Success response

JSON format

{
  "RequestId": "3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 5,
  "AccessPointSet": {
    "AccessPointType": [
      {
        "Status": "recommended",
        "Type": "VPC",
        "HostOperator": "中国电信",
        "Description": "接入点描述信息",
        "AttachedRegionNo": "cn-hangzhou",
        "Name": "杭州-余杭-C",
        "AccessPointId": "ap-cn-hangzhou-****",
        "Location": "杭州",
        "AccessPointFeatureModels": {
          "AccessPointFeatureModel": [
            {
              "FeatureValue": "true",
              "FeatureKey": "AP_Support_VbrBandwidthLimit"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidAccessPointType.NotSupport	Invalid access point type.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidRegionId.NotSupport	The RegionId provided does not support in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.