Domain name for API request: vpc.tencentcloudapi.com.
This API (DescribeGatewayFlowQos) is used to query the QoS bandwidth limit of inbound IP flow in a gateway.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeGatewayFlowQos. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| GatewayId | Yes | String | Gateway instance ID, which currently supports these types: ID of Direct Connect gateway instance, e.g. dcg-ltjahce6;ID of NAT gateway instance, e.g. nat-ltjahce6;ID of VPN gateway instance, e.g. vpn-ltjahce6. |
| IpAddresses.N | No | Array of String | CVM private IP addresses with limited bandwidth. |
| Offset | No | Integer | Offset. Default value: 0. |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| GatewayQosSet | Array of GatewayQos | List of instance details. |
| TotalCount | Integer | Number of eligible instances. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://vpc.tencentcloudapi.com/?Action=DescribeGatewayFlowQos
&<Common request parameter>
&GatewayId=vpngw-4je9dgin{
"Response": {
"GatewayQosSet": [
{
"VpcId": "vpc-mrzkofih",
"IpAddress": "10.0.0.12",
"Bandwidth": 10,
"CreateTime": "2020-01-01 10:00:00"
}
],
"TotalCount": 1,
"RequestId": "5cf1a813-d4f8-4e0c-8f90-c155a84a3ea1"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue | Incorrect parameter value. |
| ResourceNotFound | The resource does not exist. |
| UnsupportedOperation.InvalidState | Invalid resource status. |
Was this page helpful?