Tenant Cloud Security Cloud Workload Protection Platform Settings Center APIs DescribeLicenseList

DescribeLicenseList

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 information about all license orders.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-12-12 15:20:20.

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: DescribeLicenseList
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.
  • LicenseStatus: License status. 0: unused; 1: partially used; 2: used up; 3: unavailable; 4: available.
  • BuyTime: Purchase time.
  • LicenseType: License type. 0: Pro Edition license; 5: Ultimate Edition license.
  • DeadlineStatus: Expiration status. NotExpired: not expired; Expire: expired (including terminated); NearExpiry: about to expire.
  • ResourceId: Resource ID.
  • Keywords: IP address for filtering.
  • PayMode: Payment mode. 0: pay-as-you-go; 1: monthly subscription.
  • OrderStatus: Order status. 1: normal; 2: isolated; 3: terminated.
  • DealNames: Sub-order numbers. The maximum number of sub-order numbers cannot exceed 10. Otherwise, a failure will occur.

    • Example:View
    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
    ResourceIds No No Array of String Resource IDs, which are used as a filter condition. The ResourceIds parameter and the Filters.ResourceId parameter cannot be specified together. If you specify them together, the ResourceIds parameter takes precedence.
    Example: ["cwp-1sd324s"]
    Tags No No Array of Tags Tags, which are used as a filter condition. A tag is a key-value pair.
    Example:View

    3. Output Parameters

    Parameter name Type Description
    List Array of LicenseDetail Information about license quantities.
    Example:View
    TotalCount Uint64 Total number.
    Example: 12
    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 Invalid parameter.
    InvalidParameterValue The parameter value is invalid.