tencent cloud

All product documents
APIs
DocumentationAPIsInternational PartnersBill Management APIsQueryPolicyProductListByCode
QueryPolicyProductListByCode
Last updated: 2025-03-04 16:30:42
QueryPolicyProductListByCode
Last updated: 2025-03-04 16:30:42

1. API Description

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

This API is used to query the product list information within the specified policy range. To call this API, contact your business manager to apply for adding it to the allowlist.
Callable roles: Distributor, Second-level reseller, Reseller

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: QueryPolicyProductListByCode.
Version Yes String Common Params. The value used for this API: 2022-09-28.
Region No String Common Params. This parameter is not required.
PolicyCode Yes String Policy code.
ProductCode No String The code of the ProductName field in the bill data.
ProductName No String The ProductName field value in the billing data.
SubProductCode No String The code of the SubProductName field in the bill data.
SubProductName No String The SubProductName field value in the billing data.
Page No Integer Page parameter: current page number. The minimum value is 1.
PageSize No Integer Page parameter: Indicates the number of entries per page. Value range: [1, 200], default is 200.

3. Output Parameters

Parameter Name Type Description
ProductList Array of PolicyProductList policy product list.
Total Integer Total number of data entries
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 Querying Policy List Data

This example shows you how to query policy list data by the reseller policy code and level-2 product name.

Input Example

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

{
    "PolicyCode": "StandardPolicy2025",
    "ProductCode": "",
    "ProductName": "",
    "SubProductCode": "",
    "SubProductName": "CBM Memory Optimized BMM5",
    "Page": 1,
    "PageSize": 200
}

Output Example

{
    "Response": {
        "ProductList": [
            {
                "ComponentCode": "*",
                "ComponentName": "*",
                "ComponentTypeCode": "*",
                "ComponentTypeName": "*",
                "EndDate": "2024-12-31 00:00:00",
                "PolicyCode": "StandardPolicy2024",
                "ProductCode": "p_cvm",
                "ProductName": "Cloud Virtual Machine(CVM)",
                "StartDate": "2024-01-01 00:00:00",
                "SubProductCode": "sp_cvm_bmm5m",
                "SubProductName": "CBM Memory Optimized BMM5"
            }
        ],
        "RequestId": "5d1eb9c4-8e1b-4c8c-99b3-209e7ce35a34",
        "Total": 55
    }
}

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.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support