tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeApiUsagePlan

最后更新时间：2024-10-10 21:40:58

    1. API Description

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

    This API is used to query the details of API usage plans in a service.
    To make authentication and throttling for a service take effect, you need to bind a usage plan to it. This API is used to query all usage plans bound to a service and APIs under it.

    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: DescribeApiUsagePlan.
    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.
    ServiceId Yes String Unique ID of the service to be queried.
    Limit No Integer Number of results to be returned. Default value: 20. Maximum value: 100.
    Offset No Integer Offset. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    Result ApiUsagePlanSet List of usage plans bound to API.
    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 Getting the list of APIs bound to a usage plan

    Input Example

    https://apigateway.tencentcloudapi.com/?Action=DescribeApiUsagePlan
&ServiceId=service-ody35h5e
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Result": {
            "TotalCount": 1,
            "ApiUsagePlanList": [
                {
                    "ServiceId": "service-ody35h5e",
                    "ServiceName": null,
                    "ApiId": "api-e92i2jds",
                    "ApiName": "test2",
                    "Path": "/users",
                    "Method": "POST",
                    "UsagePlanId": "usagePlan-quqxvett",
                    "UsagePlanName": "aaa",
                    "UsagePlanDesc": "xby",
                    "Environment": "test",
                    "InUseRequestNum": 0,
                    "MaxRequestNum": -1,
                    "MaxRequestNumPreSec": null,
                    "CreatedTime": "2020-02-17T11:26:42Z",
                    "ModifiedTime": "2020-02-17T13:47:47Z"
                }
            ]
        },
        "RequestId": "8783bfc8-70e3-494a-97f4-0ccc10987aa8"
    }
}

    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.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
    InvalidParameter.FormatError Incorrect parameter format.
    ResourceNotFound.InvalidService The corresponding service is invisible.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款