Contents:
1. API Description
Domain name for API request: yunjing.tencentcloudapi.com.
This API (DescribeAlarmAttribute) is used to get alarm settings.
Default request rate limit: 20/sec.
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 parameter. The valueused for this API: DescribeAlarmAttribute. |
Version | Yes | String | Common parameter. The value used for this API: 2/28/2018 |
Region | No | String | Common parameter. This parameter is not required for this API. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
Offline | String | The status of the alarm on the protection software going offline: |
Malware | String | The status of the alarm on the detection of a Trojan file: |
NonlocalLogin | String | The status of the alarm on the detection of remote login: |
CrackSuccess | String | The status of the alarm on a successful brute force attack |
RequestId | String | The unique ID of a request, which is required for each troubleshooting case. |
4. Example
Example 1 Get alarm settings
Input example
https://yunjing.tencentcloudapi.com/?Action=DescribeAlarmAttribute
&<Common request parameters>
Output example
{
"Response": {
"NonlocalLogin": "OPEN",
"Offline": "CLOSE",
"RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
"Malware": "OPEN",
"CrackSuccess": "OPEN"
}
}
5. Resources for Developers
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using cloud APIs.
6. Error Codes
The following only lists the error codes related to this API. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error. |