tencent cloud

文档反馈

ExportRansomDefenseMachineList

最后更新时间:2024-08-27 11:45:21

1. API Description

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

This API is used to export the backup details list.

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: ExportRansomDefenseMachineList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Filters.N No Array of Filters Filtering criteria
  • Ips - String - required: no - IP address for querying
  • MachineNames - String - required: no - instance name for querying
  • Names - String - required: no - instance name for querying
  • Status - String - required: no - policy status: 0: backup in progress; 1: backup succeeded; 2: backup failed
  • LastBackupTimeBegin - String - required: no - start of the last backup time
  • LastBackupTimeEnd - String - required: no - end of the last backup time
  • Order No String Sorting method: ASC / DESC
    By No String Sorting fields, supporting CreateTime and MachineCount

    3. Output Parameters

    Parameter Name Type Description
    TaskId String Task ID, which is used to obtain the download URL (DownloadUrl) using the asynchronous task export API ExportTasks.
    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 Exporting the List of Backup Details

    This example shows you how to export the list of backup details based on filter parameters.

    Input Example

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

    Output Example

    {
        "Response": {
            "RequestId": "requestId",
            "TaskId": "123213"
        }
    }
    

    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.