tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRansomDefenseStrategyList

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

1. API Description

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

This API is used to query the list of anti-ransomware policies.

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: DescribeRansomDefenseStrategyList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Limit Yes Integer Pagination parameter (maximum quantity: 100)
Offset Yes Integer Pagination parameter
Filters.N No Array of Filters Filtering criteria
  • Ips - String - required: no - IP addresses for querying
  • MachineNames - String - required: no - instance names for querying
  • Names - String - required: no - anti-ransomware policy names for querying
  • Dirs - String - required: no - bait directory
  • Status - String - required: no - policy status: 0: disabled; 1: enabled
  • BackupType - String - required: no - backup mode: 0: weekly; 1: daily
    • Order No String Sorting order: ASC and DESC
    By No String Sorting fields, supporting CreateTime and MachineCount

    3. Output Parameters

    Parameter Name Type Description
    List Array of RansomDefenseStrategy Policy list
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of pagination query records
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Query Anti-Ransomware Policy List

    Query Anti-Ransomware Policy List

    Input Example

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

{
    "Limit": "10",
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "List": [
            {
                "Id": 0,
                "Uin": "abc",
                "Name": "abc",
                "Description": "abc",
                "Status": 1,
                "IsAll": 1,
                "IncludeDir": "abc",
                "ExcludeDir": "abc",
                "BackupType": 1,
                "Weekday": "abc",
                "Hour": "abc",
                "SaveDay": 1,
                "CreateTime": "abc",
                "ModifyTime": "abc",
                "MachineCount": 1
            }
        ],
        "TotalCount": 1,
        "RequestId": "abc"
    }
}

    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

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError Internal error
    InvalidParameter Incorrect parameter.
    InvalidParameter.IllegalRequest Invalid request.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter.ParsingError Incorrect parameter parsing.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy