Tenant Cloud Security Cloud Workload Protection Platform Other APIs DescribeOrderList

DescribeOrderList

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

1. Interface Description

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

This API is used to query the order list.

Default interface request rate limit: 20 times per second.

Interface update time: 0001-01-01 00:00:00.

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: DescribeOrderList
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 When filtering by multiple conditions, take the intersection.
  • ProductCode: product code, which starts with p_.
  • SubProductCode: sub-product code, which starts with sp_.
  • InquireKey: billable item name, which starts with sv_.
  • Status: resource status. 1: normal, 2: isolated, 3: terminated.
  • PayMode: payment mode. 0: pay-as-you-go, 1: monthly subscription.
  • ResourceId: resource ID.
  • RenewFlag: auto-renewal flag. 0: Disabled by default (auto-renewal available for key accounts). 1: Automatically renew. 2: Manually set to not automatically renew.
  • DealNames: sub-order number.

    • Example:View
    Limit No No Uint64 Limit Entries, 10 by default, up to 100.
    Example: 10
    Offset No No Uint64 Offset. Default value: 0.
    Example: 0
    ResourceIds No No Array of String Resource ID.
    Example: ["32454"]

    3. Output Parameters

    Parameter name Type Description
    List Array of OrderList Order resource object list.
    Example:View
    TotalCount Uint64 Total number of orders.
    Example: 0
    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.
    InvalidParameter Invalid parameter.
    OperationDenied Operation denied.
    InvalidParameterValue The parameter value is invalid.