tencent cloud

DescribeAllocationRuleSummary
Last updated: 2025-11-13 20:46:22
DescribeAllocationRuleSummary
Last updated: 2025-11-13 20:46:22

1. API Description

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

This API is used to query all sharing rule overviews.

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: DescribeAllocationRuleSummary.
Version Yes String Common Params. The value used for this API: 2018-07-09.
Region No String Common Params. This parameter is not required.
Limit Yes Integer Specifies the data quantity per fetch. the maximum value is 1000.
Offset Yes Integer Pagination offset
Month No String Month, which is the current month by default if not provided.
Type No Integer Public area policy type, for filtering.
Enumeration values are as follows:.
1 - custom sharing proportion.
2 - proportional allocation.
3 - allocation by proportion.
Name No String Sharing rule name or cost allocation unit name, used for fuzzy filter criteria.

3. Output Parameters

Parameter Name Type Description
RuleList Array of AllocationRuleOverview Sharing rule expression.
Total Integer Total number of rules.
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 Query Sharing Rule Overview

Input Example

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

{
    "Month": "2022-11",
    "Limit": "2",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "Total": 2,
        "RuleList": [
            {
                "RuleId": 33,
                "RuleName": "Test 1",
                "Type": 2,
                "UpdateTime": "2022-10-30 17:26:16",
                "AllocationNode": [
                    {
                        "NodeId": 6,
                        "TreeNodeUniqKeyName": "Product Department 1"
                    },
                    {
                        "NodeId": 7,
                        "TreeNodeUniqKeyName": "Business Division II Products"
                    },
                    {
                        "NodeId": 8,
                        "TreeNodeUniqKeyName": "Product Division 3"
                    },
                    {
                        "NodeId": 9,
                        "TreeNodeUniqKeyName": "Product Department 4"
                    }
                ]
            },
            {
                "RuleId": 29,
                "RuleName": "test_allocation2",
                "Type": 1,
                "UpdateTime": "2022-10-24 12:05:04",
                "AllocationNode": [
                    {
                        "NodeId": 2,
                        "TreeNodeUniqKeyName": "Finance Department"
                    },
                    {
                        "NodeId": 5,
                        "TreeNodeUniqKeyName": "Organization Department"
                    }
                ]
            }
        ],
        "RequestId": "78933c15-099c-4958-9ca0-8c148bc1da04"
    }
}

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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InternalError.GatewayError Gateway error.
InternalError.UnknownError Undefined exception.
InvalidParameter Invalid parameter.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback