1. Interface Description
Interface request domain name: dc.api3.convergecloud.com.
Query access point of physical DC.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-11-29 23:52:45.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeAccessPoints |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-04-10 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| Offset | No | No | Int64 | Offset, with a default value of 0. Example: 0 |
| Limit | No | No | Int64 | Number of returns, with a default value of 20, and a maximum value of 100. Example: 100 |
| Filters | No | No | Array of Filter | Filter Parameters, supporting filtering based on an array of access point IDs (AccessPointId) Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AccessPointSet | Array of AccessPoint | Access Point Information Example:View |
| TotalCount | Uint64 | Number of Access Points Example: 100 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| MissingParameter | Parameter missing |
| ResourceUnavailable | Resource unavailable |
| InternalError | Internal error |
| InvalidParameter | Wrong parameter. |
| InvalidParameterValue | Incorrect parameter value |
| UnsupportedOperation | Operation unsupported. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | Unauthorized operation |