1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (DescribeGatewayFlowQos) is used to query the gateway access IP traffic control bandwidth.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-04-10 01:44:15.
The interface only verifies the signature but does not authenticate.
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: DescribeGatewayFlowQos |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| GatewayId | Yes | No | String | Gateway instance ID. Currently we support the following gateway instance types, Direct Connect gateway instance ID, e.g., dcg-ltjahce6; NAT gateway instance ID, e.g., nat-ltjahce6; VPN gateway instance ID, e.g., vpn-ltjahce6. Example: vpngw-4je9dgin |
| IpAddresses | No | No | Array of String | Rate limited CVM's private IP. Example: 10.0.0.12 |
| Offset | No | No | Uint64 | Offset. 0 by default. Example: 0 |
| Limit | No | No | Uint64 | Number of returns, 20 by default, up to 100. Example: 20 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| GatewayQosSet | Array of GatewayQos | Instance detail list. Example:View |
| TotalCount | Uint64 | Number of eligible instances. Example: |
| 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 |
|---|---|
| InvalidParameterValue | The parameter value is invalid. |
| ResourceNotFound | The resource does not exist |
| UnsupportedOperation.InvalidState | The resource status is invalid. |