tencent cloud

文档反馈

IncreasePlanQuota

最后更新时间:2024-12-03 16:17:56

1. API Description

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

When the number of sites bound to your plan, the number of rules under "Web Protection - Custom Rules - Precision Matching Policy", or the number of rules under "Web Protection - Rate Limiting - Precision Rate Limiting Module" reaches the plan's quota, you can use this interface to purchase additional quotas.

This interface only supports the Enterprise Edition Plan.

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: IncreasePlanQuota.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
PlanId Yes String Plan ID, formatted as edgeone-2unuvzjmmn2q.
QuotaType Yes String The types of new plan quotas available include:
  • site: Number of sites;
  • precise_access_control_rule: the number of rules under "Web Protection - Custom Rules - Precision Matching Policy";
  • rate_limiting_rule: the number of rules under "Web Protection - Rate Limiting - Precision Rate Limiting Module".
  • QuotaNumber Yes Integer Number of new quotas. The maximum number of quotas that can be added at one time is 100.

    3. Output Parameters

    Parameter Name Type Description
    DealName String Order number.
    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 Adding Site Number Quota to Plan

    Add 10 site number quotas for the plan edgeone-2unuvzjmmn2q.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyPlanQuota
    <Common request parameters>
    
    {
        "PlanId": "edgeone-2unuvzjmmn2q",
        "QuotaType": "site",
        "QuotaNumber": 10
    }
    

    Output Example

    {
        "Response": {
            "DealName": "20240312347001004723731",
            "RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"
        }
    }
    

    Example2 Adding Custom Rule Quotas to Plan

    Add 10 rule quotas for "Web Protection - Custom Rules - Precision Matching Policy" to the plan edgeone-2unuvzjmmn2q.

    Input Example

    POST / HTTP/1.1
    Host: teo.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyPlanQuota
    <Common request parameters>
    
    {
        "PlanId": "edgeone-2unuvzjmmn2q",
        "QuotaType": "precise_access_control_rule",
        "QuotaNumber": 10
    }
    

    Output Example

    {
        "Response": {
            "DealName": "20240312347001004723731",
            "RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"
        }
    }
    

    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
    FailedOperation.InsufficientAccountBalance The account balance is insufficient.
    InvalidParameter.InvalidQuotaNumber The quota quantity format is incorrect. Enter the correct format.
    InvalidParameter.InvalidQuotaType The quota type format is incorrect. Enter the correct quota type format.
    OperationDenied.PlanHasBeenIsolated The plan has been isolated.
    OperationDenied.PlanIncreasePlanQuotaUnsupported This plan does not support the purchase of additional plan quotas.
    OperationDenied.ResourceHasBeenLocked Billing resources are in operation. Try again later.