tencent cloud

Feedback

DescribeNetAttackSetting

Last updated: 2024-08-27 11:45:39

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to query network attack settings.

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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeNetAttackSetting.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name Type Description
NetAttackEnable Integer 0 - Disable Network Attack Detection; 1 - Enable Network Attack Detection.
NetAttackAlarmStatus Integer 0: New warning events pending processing by default, 1: New warning events processed by default, 3: New warning events ignored by default.
Scope Integer 1 - All Premium Edition Hosts, 0 - Hosts in InstanceIds List
InstanceIds Array of String Selected hosts
Note: This field may return null, indicating that no valid values can be obtained.
ExcludeInstanceIds Array of String Custom Hosts to Exclude
Note: This field may return null, indicating that no valid values can be obtained.
AutoInclude Integer New assets automatically include: 0 - Do not include, 1 - include.
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.

4. Example

Example1 Querying Network Attack Settings

This example shows you how to query network attack settings.

Input Example

POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNetAttackSetting
<Common request parameters>

{}

Output Example

{
    "Response": {
        "NetAttackAlarmStatus": 0,
        "NetAttackEnable": 1,
        "RequestId": "8c1f7156-fc01-4905-b286-e08f4db0eec2"
    }
}

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

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.