All Products
Search
Document Center

Virtual Private Cloud:DescribeAccessPoints

Last Updated:Mar 01, 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

There is currently no authorization information disclosed in the API.

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 number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each 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
AccessPointSetobject []

The information about the access point.

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
AccessPointFeatureModelsobject []

The feature model of the access point.

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 changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
2023-05-18The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AcceptLanguage