ExportLicenseDetail

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

1. Interface Description

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

This API is used to export the license binding information.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-06-01 11:06:27.

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: ExportLicenseDetail
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.
ExportMonth No No String Month of data to export. This parameter is available only when the IsHistory parameter is set to False.
Example: 2022-03
Filters No No Array of Filters Conditions. 
  • LicenseType: license type. 0: Pro Edition; 5: Ultimate Edition.
  • ResourceId: resource ID.

  • Example:View
    IsHistory No No Bool Specifies whether to export the details of all licenses.
    Example: false
    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
    DownloadUrl String Download URL. This parameter has been deprecated.
    Example: url
    TaskId Uint64 Task ID, required for obtaining the DownloadURL at API Asynchronous Export Task ExportTasks
    Example: 1
    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
    ResourceNotFound The resource does not exist.