Tenant Cloud Security Cloud Workload Protection Platform Settings Center APIs DescribeLicenseBindList

DescribeLicenseBindList

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

1. Interface Description

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

This API is used to query the servers that are bound to a license in the Settings Center > License Management module.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-06-09 10:50:08.

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: DescribeLicenseBindList
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. Valid values:
  • InstanceID, IP, 

    MachineName (fuzzy match),
  • Keywords (host name or IP address for fuzzy match
  • AgentStatus: ONLINE: online; OFFLINE: offline; UNINSTALLED: not protected; SHUTDOWN: shut down; TERMINATED_PRO_VERSION: Pro Edition activated and server terminated.

    • Example:View
    LicenseId Yes No Uint64 License ID.
    Example: 1
    LicenseType Yes No Uint64 License type. 0: Pro Edition license; 5: Ultimate Edition license.
    Example: 0
    Limit No No Uint64 Maximum number of entries to return. Default value: 10.
    Example: 10
    Offset No No Uint64 Offset. Default value: 0.
    Example: 0
    ResourceId Yes No String Resource ID.
    Example: any data

    3. Output Parameters

    Parameter name Type Description
    List Array of LicenseBindDetail Information about bound servers.
    Example:View
    TotalCount Uint64 Total number.
    Example: 10
    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.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    InvalidParameterValue The parameter value is invalid.