All Products
Search
Document Center

Virtual Private Cloud:ListBusinessAccessPoints

Last Updated:Nov 13, 2024

Queries the access points of an Express Connect circuit.

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.

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:ListBusinessAccessPointslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the Express Connect circuit.

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

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The request ID.

RequestIdstring

The request ID.

611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F
BusinessAccessPointsarray<object>

The list of access points.

BusinessAccessPointsobject
AccessPointIdstring

The ID of the access point.

ap-cn-hangzhou-xs-B
AccessPointNamestring

The name of the access point.

hangzhou-xs-B
SupportLineOperatorstring

The connectivity provider of the Express Connect circuit. Valid values:

  • CT: China Telecom.
  • CU: China Unicom.
  • CM: China Mobile.
  • CO: other connectivity providers in the Chinese mainland.
  • Equinix: Equinix.
  • Other: other connectivity providers outside the Chinese mainland.
CT
SupportPortTypesstring

The port type supported by the access point. Valid values:

  • 100Base-T: 100 Mbit/s copper Ethernet port
  • 1000Base-T: 1,000 Mbit/s copper Ethernet port
  • 1000Base-LX: 1,000 Mbit/s single-mode optical port (10 km)
  • 10GBase-T: 10,000 Mbit/s copper Ethernet port
  • 10GBase-LR: 10,000 Mbit/s single-mode optical port (10 km)
  • 40GBase-LR: 40,000 Mbit/s single-mode optical port
  • 100GBase-LR: 100,000 Mbit/s single-mode optical port
Note To use ports 40GBase-LR and 100GBase-LR, you must first contact your account manager.
1000Base-T
CloudBoxInstanceIdsstring

The ID of the cloud box.

Note You can query this parameter if the Express Connect circuits and access points are of the cloud box type.
cb-****
Longitudedouble

The longitude of the access point.

120.247514
Latitudedouble

The latitude of the access point.

30.198416

Examples

Sample success responses

JSONformat

{
  "RequestId": "611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F",
  "BusinessAccessPoints": [
    {
      "AccessPointId": "ap-cn-hangzhou-xs-B",
      "AccessPointName": "hangzhou-xs-B\n",
      "SupportLineOperator": "CT",
      "SupportPortTypes": "1000Base-T",
      "CloudBoxInstanceIds": "cb-****",
      "Longitude": 120.247514,
      "Latitude": 30.198416
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
500InternalErrorInternal system error.Internal system error.

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

Change history

Change timeSummary of changesOperation
2024-06-13The Error code has changedView Change Details