tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateUsagePlan

Last updated: 2024-10-10 21:40:40

    1. API Description

    Domain name for API request: apigateway.tencentcloudapi.com.

    This API is used to create a usage plan.
    To use API Gateway, you need to create a usage plan and bind it to a service environment.

    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: CreateUsagePlan.
    Version Yes String Common Params. The value used for this API: 2018-08-08.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    UsagePlanName Yes String Custom usage plan name.
    UsagePlanDesc No String Custom usage plan description.
    MaxRequestNum No Integer Total number of requests allowed. Valid values: -1, [1,99999999]. The default value is -1, which indicates no limit.
    MaxRequestNumPreSec No Integer Limit of requests per second. Valid values: -1, [1,2000]. The default value is -1, which indicates no limit.

    3. Output Parameters

    Parameter Name Type Description
    Result UsagePlanInfo Usage plan details.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Creating a usage plan

    Input Example

    https://apigateway.tencentcloudapi.com/?Action=CreateUsagePlan
&UsagePlanName=xx
&<Common Request Parameters>

    Output Example

    {
    "Response": {
        "Result": {
            "UsagePlanId": "usagePlan-quqxvett",
            "UsagePlanName": "xx",
            "UsagePlanDesc": null,
            "MaxRequestNumPreSec": null,
            "MaxRequestNum": null,
            "CreatedTime": "2020-02-17T11:26:42Z",
            "ModifiedTime": "2020-02-17T11:26:42Z",
            "BindSecretIdTotalCount": 0,
            "BindSecretIds": null,
            "BindEnvironmentTotalCount": 0,
            "BindEnvironments": null
        },
        "RequestId": "b30900ef-72e9-4076-a2bd-dc8caab1ef6f"
    }
}

    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
    InvalidParameter.FormatError Incorrect parameter format.
    InvalidParameterValue.InvalidMaxRequestNum Invalid quota
    InvalidParameterValue.InvalidRegion Incorrect region.
    LimitExceeded.UsagePlanLimitExceeded The number of usage plans exceeds the limit.
    UnsupportedOperation.UnpackError
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy