Last updated: 2021-08-17 15:23:02

1. API Description

Domain name for API request:

This API is used to create an API Gateway plugin.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

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 parameter. The value used for this API: CreatePlugin.
Version Yes String Common parameter. The value used for this API: 2018-08-08.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
PluginName Yes String Custom plugin name. A plugin name contain up to 50 characters out of a-z, A-Z, 0-9, and _, which must begin with a letter and end with a letter or a number.
PluginType Yes String Plugin type. Valid value: IPControl.
PluginData Yes String Plugin definition statement in json format
Description No String Plugin description within 200 characters

3. Output Parameters

Parameter Name Type Description
Result Plugin Details of the new plugin
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 CreatePlugin

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "Result": {
      "PluginId": "plugin-qrboebt1",
      "PluginName": "mytestPlugin",
      "PluginType": "IPControl",
      "Description": "IPControl",
      "PluginData": "{\"blocks\":\"\",\"type\":\"black_list\"}",
      "CreatedTime": "2021-01-25T05:46:25Z",
      "ModifiedTime": "2021-01-25T05:46:25Z",
      "AttachedApiTotalCount": null,
      "AttachedApis": null
    "RequestId": "b4ffe46b-ae2c-4ff1-911b-57fe15f3d95b"

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
FailedOperation.ServiceInOperation The service is in use. Please try again later.
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.
InvalidParameterValue.NotInOptions The parameter value is incorrect, as it is not an available option.
InvalidParameterValue.RangeExceeded The parameter value is incorrect, as it is not within the valid value range.
UnsupportedOperation.InvalidAction API error.