All Products
Search
Document Center

Virtual Private Cloud:DescribeAccessPoints

Last Updated:Aug 29, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeAccessPointsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the access point.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh-CN: Chinese
  • en-US (default): English
zh-CN

Response parameters

ParameterTypeDescriptionExample
object

The request ID.

RequestIdstring

The request ID.

3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027
PageNumberinteger

The page number. Default value: 1.

1
PageSizeinteger

The number of entries returned per page. Maximum value: 50. Default value: 10.

10
TotalCountinteger

The total number of entries returned.

5
AccessPointSetarray<object>

The information about the access point.

object
Statusstring

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
Typestring

The network type of the Express Connect circuit. Default value: VPC.

VPC
HostOperatorstring

The Internet service provider (ISP) of the access point. Valid values:

Telehouse
Descriptionstring

The description of the access point.

The description of the access point.
AttachedRegionNostring

The region ID of the access point.

cn-hangzhou
Namestring

The name of the access point.

Name
AccessPointIdstring

The ID of the access point.

ap-cn-hangzhou-****
Locationstring

The location of the access point.

Hangzhou
AccessPointFeatureModelsarray<object>

The feature model of the access point.

object
FeatureValuestring

The feature value of the access point.

true
FeatureKeystring

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 codeError codeError messageDescription
400InvalidAccessPointType.NotSupportInvalid access point type.-
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId parameter is set to an invalid value. Specify a valid value and try again.
404InvalidRegionId.NotSupportThe 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 timeSummary of changesOperation
2023-09-20API Description Update. The Error code has changedView Change Details
2023-05-18The Error code has changed. The request parameters of the API has changedView Change Details