Tenant Cloud Security Cloud Workload Protection Platform Asset Management APIs DescribeImportMachineInfo

DescribeImportMachineInfo

Last Updated At: 2026-08-02 00:04:58

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

API for querying information about servers that are batch imported

Default interface request rate limit: 20 times per second.

Interface update time: 2022-06-16 12:16:37.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeImportMachineInfo
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
Filters No No Array of Filters Filter conditions.
  • Version - String - Required: No - Protection edition. PRO_VERSION: Professional Edition. BASIC_VERSION: Basic Edition. Flagship: Ultimate Edition. ProtectedMachines: Professional Edition and Ultimate Edition. BASIC_PROPOST_GENERAL_DISCOUNT: General Edition, Professional Edition (pay-as-you-go), and Basic Edition.
    		•
    ImportType Yes No String Type of the data that is batch imported. Valid values: Ip, Name, and Id.
    Example: Ip
    IsQueryProMachine No No Bool Deprecated parameter.
    Example: true
    MachineList Yes No Array of String Up to 1,000 server private IP addresses (default), server names, or server IDs.
    Example: ["192.168.0.204"]

    3. Output Parameters

    Parameter name Type Description
    EffectiveMachineInfoList Array of EffectiveMachineInfo Valid server information, including server name, public or private IP address of the server, and server tags.
    Example:View
    InvalidMachineList Array of String Servers that have failed to be imported at a time, such as servers that do not exist.
    Example: [""a9fe0359-04d9-417f-ab6d-ayay""]
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InternalError Internal error.
    InvalidParameter.ParsingError Parameter parsing error.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter Invalid parameter.
    OperationDenied Operation denied.
    InvalidParameterValue The parameter value is invalid.