1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (DescribeGatewayFlowMonitorDetail) is used to query the gateway traffic monitoring details.
- It only supports querying a single gateway instance. That is, at most one of the input parameters
VpnId,DirectConnectGatewayId,PeeringConnectionId, andNatIdcan be and must be input. - If the gateway has traffic, but calling this API does not return any data, confirm whether gateway traffic monitoring is enabled on the corresponding gateway detail page in the console.
Default interface request rate limit: 30 times per second.
Interface update time: 2019-03-02 18:52:49.
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: DescribeGatewayFlowMonitorDetail |
| 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 |
| TimePoint | Yes | No | Datetime | Time point, indicating the details to query in a minute, e.g., 2019-02-28 18:15:20 indicates that the details within the minute of 18:15 will be queried. Example: 2019-02-28 18:15:20 |
| VpnId | No | No | String | VPN gateway instance ID, e.g., vpn-ltjahce6. Example: vpn-ltjahce6 |
| DirectConnectGatewayId | No | No | String | Direct Connect gateway instance ID, e.g., dcg-ltjahce6. Example: dcg-ltjahce6 |
| PeeringConnectionId | No | No | String | Peering connection instance ID, e.g., pcx-ltjahce6.Example: pcx-ltjahce6 |
| NatId | No | No | String | NAT gateway instance ID, e.g., nat-ltjahce6. Example: nat-ltjahce6 |
| Offset | No | No | Uint64 | Offset. Example: 0 |
| Limit | No | No | Uint64 | Returned quantity. Example: 20 |
| OrderField | No | No | String | Sorting fields. InPkg, OutPkg, InTraffic, and OutTraffic are supported.Example: InPkg |
| OrderDirection | No | No | String | Sorting method. ASC: Ascending order, DESC: Descending order.Example: ASC |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Uint64 | Number of eligible objects. Example: |
| GatewayFlowMonitorDetailSet | Array of GatewayFlowMonitorDetail | Gateway traffic monitoring details. Example:View |
| 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
There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.