tencent cloud

PrevNext

フィードバック

キーワードで検索してください

Recent Pages

ドキュメント
ドキュメント

DescribeExportMachines

最終更新日:2024-08-27 11:44:05

1. API Description

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

This API is used to export the list of hosts in a specific region.

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: DescribeExportMachines.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
MachineType Yes String CVM type
  • CVM: Represent a virtual machine
  • BM: Represent a physical machine
    		•
    MachineRegion Yes String Machine region. Example: ap-guangzhou, ap-shanghai
    Limit No Integer Quantity of returns. It is 10 by default, and the maximum value is 100.
    Offset No Integer Offset. Default value: 0.
    Filters.N No Array of Filter Filter criteria
  • Keywords - String - required: no - keyword for query
  • Status - String - required: no - client online status (OFFLINE: offline | ONLINE: online | UNINSTALLED: not installed)
  • Version - String - required: no - current protection version (PRO_VERSION: Pro Edition | BASIC_VERSION: Basic Edition)

    • Only one value is allowed for each filter criterion. Multiple values with the OR relationship are not supported for queries.
    ProjectIds.N No Array of Integer ID List of Businesses to which machines belong

    3. Output Parameters

    Parameter Name Type Description
    TaskId String Task ID, required for obtaining the DownloadURL at API Asynchronous Export Task ExportTasks
    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 Exportinga List of Hosts in a Specific Region

    This example shows you how to export the list of hosts in a specific region using this API (DescribeExportMachines).

    Input Example

    https://cwp.tencentcloudapi.com/?Action=DescribeExportMachines
&MachineType=CVM
&MachineRegion=ap-shanghai
&Filters.0.Name=Keywords
&Filters.0.Values.0=10.0.1.1
&Limit=10
&Offset=0
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TaskId": "123",
        "RequestId": "c30f35cb-2f3e-94f5-59ae-316e0f32e660"
    }
}

    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.InvalidFormat Incorrect parameter format.
    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.
    個人情報保護方針利用規約クッキーポリシー