DescribePluginsByApi

最后更新时间：2025-10-30 21:27:20

DescribePluginsByApi

最后更新时间： 2025-10-30 21:27:20

1. API Description

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

This API is used to query all plug-ins bound with the API.

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: DescribePluginsByApi.
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.
ApiId	Yes	String	ID of the API to query
ServiceId	Yes	String	ID of the service to query
EnvironmentName	No	String	Environment information
Limit	No	Integer	Number of returned results. Default value: 20. Maximum value: 100
Offset	No	Integer	Offset. Default value: 0

3. Output Parameters

Parameter Name	Type	Description
Result	AttachedPluginSummary	List of plug-ins bound with the API
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 DescribeAvailablePluginApis

Input Example

https://apigateway.intl.tencentcloudapi.com/?Action=DescribePluginsByApi
&ApiId=api-fa23vfd
&EnvironmentName=release
&ServiceId=service-o5as3moe
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "PluginSummary": [
                {
                    "PluginId": "plugin-9l0d4sdf",
                    "PluginName": "onlyname",
                    "PluginType": "IPControl",
                    "Description": "modifyDesc",
                    "PluginData": "{\"blocks\":\"1.1.1.1\",\"type\":\"black_list\"}",
                    "Environment": "release",
                    "AttachedTime": "2021-01-25T06:56:58Z"
                }
            ]
        },
        "RequestId": "4effd8e7-abd0-4f95-a881-301d68d9985e"
    }
}

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

Tencent Cloud CLI 3.0

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.InvalidFilterNotSupportedName	The parameter value is incorrect.
ResourceNotFound.InvalidApi	Incorrect `ApiId`.
ResourceNotFound.InvalidService	The corresponding service is invisible.
UnauthorizedOperation.AccessResource	You do not have permission to access the resource.
UnsupportedOperation.InvalidAction	API error.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud