Domain name for API request: cfw.intl.tencentcloudapi.com.
Query status monitoring scenario. Op=describe_scene is used to detect available scenarios, metrics, perspectives, and secondary dropdown available_options. Op=fetch_scene is used to pull specific scenario snapshots, with results in the JSON string of Response.Data.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: DescribeCfwStatusMonitor. |
| Version | Yes | String | Common Params. The value used for this API: 2019-09-04. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Op | Yes | String | Operation type. describe_scene means discovery of scenarios and secondary dropdown options; fetch_scene means acquisition of scenario-based snapshots. Required. |
| FirewallType | Yes | String | Firewall scenario type. Supports internet_edge (Internet edge firewall), nat_cluster (NAT border firewall - cluster), nat_ha (NAT border firewall - primary/secondary), vpc_cluster (VPC boundary firewall - cluster), vpc_ha (VPC boundary firewall - primary/secondary). Required. |
| SelectionId | No | String | Secondary dropdown option ID. fetch_scene is imported as needed, and the value comes from selection.available_options[].ID returned by describe_scene. internet_edge is the region, NAT is the instance ID, and VPC bandwidth scenario is the firewall group ID. The connections aggregation scenario for VPC_cluster ignores this parameter. |
| SelectionName | No | String | Secondary dropdown display name. Can be used as an alternative to SelectionId for matching by name. The value comes from selection.available_options[].name returned by describe_scene. |
| SelectionInstanceId | No | String | Engine instance ID. Mainly used in vpc ha scenarios where a firewall group corresponds to multiple instances. Preferentially use the selection.available_options[].instance_ID returned by describe_scene. If only instance_ids are available, select a string value from the array. |
| Metric | No | String | Metrics tab. fetch_scene can be passed; used when not passed, this scenario default value. Support bandwidth, connections. |
| Perspective | No | String | Perspective under the metric. fetch_scene is optional; the default value for this scenario is used when not provided. Supports ip, subnet, session, switch, and vpc. The actual usable composite is subject to the return from describe_scene. |
| IpScope | No | String | NAT primary/secondary number of connections IP perspective range. External means external IP, asset means Asset IP. Only nat_ha + connections + ip is used. Other group input will return InvalidParameter. |
| TimePreset | No | String | Preset time range. Default 24h; used by fetch_scene. Supports 5m, 15m, 30m, 1h, 6h, 24h, 3d, 7d, 30d, today, yesterday, day before yesterday, this week, last week, this month. |
| StartTime | No | String | Custom start time. Format YYYY-MM-DD HH:MM:SS; must be specified together with EndTime, maximum span 30 days. |
| EndTime | No | String | Custom end time. Format YYYY-MM-DD HH:MM:SS; must be consistent with StartTime at the same time, maximum span 30 days. |
| Page | No | Integer | Page number, starting from 1. Default is 1; used for the fetch_scene list viewing angle. |
| Limit | No | Integer | Entries per page. Default 10, value 1 to 100; used for the viewing angle of the fetch_scene list. |
| OverviewOnly | No | Boolean | Whether to only get overview data. When true, fetch_scene only requests overview, skips table/detail, and is suitable for viewing scenario snapshot summary. |
| Offset | No | Integer | Original offset coverage. Option, overwrites the calculation result of Page after input; value 0 to 10000. |
| SortBy | No | String | Sorting field. Option. InputMax and OutputMax are supported for the Internet boundary IP and NAT IP/subnet perspective. SwitchName is supported for the VPC switch perspective. FlowMax is supported for the VPC IP/VPC perspective. Do not pass other groups. |
| SortOrder | No | String | Sorting order. Default desc; supports asc, desc. |
| Filters.N | No | Array of CfwStatusMonitorFilter | Filter condition list. Reserved. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | String | Query result. UTF-8 JSON object string; the caller needs to parse Response.Data. The scene returned by describe_scene includes metric_options, perspective_options, default_metric, default_perspective, selection_required_by_metric, selection_kind_by_metric, and time_preset_options; selection.available_options returns options applicable to SelectionId, SelectionName, and SelectionInstanceId. fetch_scene returns a data snapshot of the selected scenario, which may contain overview, table, or detail. The example below is a section of the field structure, and the array only shows representative values. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
describe_scene is used to identify usable metric/perspective composites, default values, selection item sums, and secondary dropdown available_options; fetch_scene should use the discovery results as-is. The output is a section of the field structure, and the array only displays representative values.
POST / HTTP/1.1
Host: cfw.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfwStatusMonitor
<Common request parameters>
{
"Op": "describe_scene",
"FirewallType": "internet_edge"
}{
"Response": {
"Data": "{\"op\":\"describe_scene\",\"scene\":{\"firewall_type\":\"internet_edge\",\"metric_options\":[\"bandwidth\"],\"perspective_options\":{\"bandwidth\":[\"ip\"]},\"default_metric\":\"bandwidth\",\"default_perspective\":{\"bandwidth\":\"ip\"},\"selection_required_by_metric\":{\"bandwidth\":false},\"selection_kind_by_metric\":{\"bandwidth\":\"region\"},\"time_preset_options\":[\"1h\",\"24h\",\"7d\"]},\"selection\":{\"available_options\":[{\"id\":\"__all__\",\"name\":\"all regions\"},{\"id\":\"ap-guangzhou\",\"name\":\"Guangzhou\"}]}}"
"RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
}
}fetch_scene pulls a specific scenario snapshot. It is not just a metrics query, but also includes scenario selection, overview, and list/detail perspectives.
POST / HTTP/1.1
Host: cfw.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfwStatusMonitor
<Common request parameters>
{
"Op": "fetch_scene",
"FirewallType": "internet_edge",
"Metric": "bandwidth",
"Perspective": "ip",
"SelectionId": "ap-guangzhou",
"TimePreset": "24h",
"OverviewOnly": true,
"Limit": 10
}{
"Response": {
"Data": "{\"op\":\"fetch_scene\",\"data\":{\"overview\":{\"InputMax\":1024}}}",
"RequestId": "4266525E-10C4-41E1-8A28-5CCE1FBF6A58"
}
}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 |
|---|---|
| FailedOperation.ResponseTooLarge | FailedOperation.ResponseTooLarge |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
文档反馈