DescribeGatewayFlowQos

Download PDF

Last updated: 2022-01-18 17:05:38

Download PDF

1. API Description

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

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.

3. Output Parameters

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.

4. Example

Example1 Querying the inbound bandwidth limit of a VPN gateway

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeGatewayFlowQos
&<Common request parameters>
&GatewayId=vpngw-4je9dgin

Output Example

{
  "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"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.

Recent Pages