tencent cloud

APIs

DocumentationAPIsCloud Security CenterBilling APIsDescribeCWPOrderList

DescribeCWPOrderList

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:35:09

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Query the resource order list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeCWPOrderList.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
Filters.N No Array of Filters

Take the intersection when filtering with multiple conditions

  • ProductCode: product code, starting with p_
  • SubProductCode: subproduct code, starting with sp_
  • InquireKey: billing item, starting with sv_
  • Status: resource status. 1: normal, 2: isolated, 3: terminated
  • PayMode: payment mode. 0: pay-as-you-go billing, 1: monthly subscription
  • ResourceId: resource ID
  • RenewFlag: auto-renewal label. 0: not needed by default (major customers have the auto-renewal ability), 1: auto-renewal, 2: manually set not to automatically renew
  • DealNames: sub-order number
    		•
    Offset No Integer

    Offset. Default value: 0
    Limit No Integer

    Limit entries. Default: 10. Maximum: 100

    3. Output Parameters

    Parameter Name Type Description
    List Array of CWPOrderList

    Order resource object list
    TotalCount Integer

    Total number of orders
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Example

    This API is used to query the order list.

    Input Example

    POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCWPOrderList
<Common request parameters>

{
    "Offset": 0,
    "Limit": 10
}

    Output Example

    {
    "Response": {
        "List": [
            {
                "Alias": "",
                "AutoRenewFlag": 0,
                "BeginTime": "2026-03-03 16:51:53",
                "DealName": "",
                "EndTime": "2026-03-10 16:51:53",
                "ExtraParam": {
                    "DisposableStatus": false,
                    "Mode": "PrePay"
                },
                "InquireKey": "sv_yunjing_ue_aams",
                "InquireNum": 10,
                "PayMode": 1,
                "ProductCode": "p_yunjing",
                "ProjectID": 0,
                "RegionID": 1,
                "ResourceId": "white_e141179b8afc4ca4af029791f9dd6008",
                "SourceType": 6,
                "Status": 3,
                "SubProductCode": "sp_yunjing_0014552",
                "TagList": [],
                "UsedNum": 0,
                "ZoneID": 100001
            }
        ],
        "TotalCount": 1,
        "RequestId": "25203ee3-1f33-432d-8c24-96bc8ab92316"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Previous Topic: DeleteDspmShareUserDataNext Topic: DescribeCWPLicenseBindSchedule

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback