tencent cloud



Last updated: 2022-05-05 16:20:32

1. API Description

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

This API is used to query the plugin details by plugin ID.

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: DescribePlugin.
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.
PluginId Yes String ID of the plugin to be queried
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 Plugin Plugin details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 DescribePlugin

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "Result": {
      "PluginId": "plugin-5xzwu9vh",
      "PluginName": "mynewplugins",
      "PluginType": "IPControl",
      "Description": "newmodify",
      "PluginData": "{\"blocks\":\"\",\"type\":\"black_list\"}",
      "CreatedTime": "2021-01-26T03:00:34Z",
      "ModifiedTime": "2021-01-26T04:14:01Z",
      "AttachedApiTotalCount": 1,
      "AttachedApis": [
          "ServiceId": "service-2mvp5cwi",
          "ServiceName": "clarescftest2",
          "ServiceDesc": "",
          "ApiId": "api-6wn5mmfq",
          "ApiName": "eee",
          "ApiDesc": "",
          "Environment": "release",
          "AttachedTime": "2021-01-26T04:17:41Z"
    "RequestId": "d1f768f4-ef4f-49e7-8117-4e12f720e355"

5. Developer Resources


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.
ResourceNotFound.InvalidPlugin The plugin does not exist.
UnauthorizedOperation.AccessResource You do not have permission to access the resource.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support