tencent cloud

Feedback

CreatePlugin

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

1. API Description

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

This API is used to create an API Gateway plugin.

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: CreatePlugin.
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.
PluginName Yes String Custom plugin name. A plugin name should contain 2-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 values: IPControl, TrafficControl, Cors, CustomReq, CustomAuth, Routing, TrafficControlByParameter, CircuitBreaker, ProxyCache
PluginData Yes String Plugin definition statement in json format
Description No String Plugin description within 200 characters
Tags.N No Array of Tag Label

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

https://apigateway.tencentcloudapi.com/?Action=CreatePlugin
&PluginName=mytestPlugin
&PluginType=IPControl
&Description=IPControl
&PluginData={"blocks":"1.1.1.12","type":"black_list"}
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "PluginId": "plugin-qrboebt1",
      "PluginName": "mytestPlugin",
      "PluginType": "IPControl",
      "Description": "IPControl",
      "PluginData": "{\"blocks\":\"1.1.1.12\",\"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"
  }
}

Example2 Creating cache plugin

Input Example

https://apigateway.tencentcloudapi.com/?Action=CreatePlugin
&PluginName=myCachePlugin
&PluginType=ProxyCache
&Description=myCachePlugin
&PluginData={"cache_key_params":[{"parameter":"param1","position":"header"},{"parameter":"param2","position":"query"},{"parameter":"param3","position":"path"}],"cacheable_methods":["GET","POST"],"cacheable_response_codes":[200,301,404],"cache_control":false,"ttl":300}
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "PluginId": "plugin-pbboebt1",
      "PluginName": "myCachePlugin",
      "PluginType": "ProxyCache",
      "Description": "myCachePlugin",
      "PluginData": "{\"cache_key_params\":[{\"parameter\":\"param1\",\"position\":\"header\"},{\"parameter\":\"param2\",\"position\":\"query\"},{\"parameter\":\"param3\",\"position\":\"path\"}],\"cacheable_methods\":[\"GET\",\"POST\"],\"cacheable_response_codes\":[200,301,404],\"cache_control\":false,\"ttl\":300}",
      "CreatedTime": "2021-01-25T05:46:25Z",
      "ModifiedTime": "2021-01-25T05:46:25Z",
      "AttachedApiTotalCount": null,
      "AttachedApis": null
    },
    "RequestId": "b4ffe46b-ae2c-4ff1-911b-57fe15f3d95a"
  }
}

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
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.
InternalError.TsfException TSF internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
InternalError.VpcException VPC 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.DuplicatePluginConfig Duplicate plugin parameter values. Please modify and try again.
InvalidParameterValue.InvalidApiRequestConfig Invalid API configuration.
InvalidParameterValue.InvalidBackendPath The backend service path configuration is incorrect.
InvalidParameterValue.InvalidClb Invalid CLB configuration.
InvalidParameterValue.InvalidCondition Policy error.
InvalidParameterValue.InvalidIPAddress The value of the backend address parameter is incorrect.
InvalidParameterValue.InvalidPluginConfig Plugin parameter value error. Please modify and try again.
InvalidParameterValue.InvalidPort The backend service port is incorrect.
InvalidParameterValue.InvalidScfConfig The SCF API parameters are invalid.
InvalidParameterValue.InvalidServiceConfig Invalid service configuration.
InvalidParameterValue.InvalidServiceParam The parameter configuration is incorrect, as the parameter is not configured in the backend parameter configuration list.
InvalidParameterValue.InvalidServiceType The backend service type is incorrect. For backend services in WEBSOCKET type, the frontend protocol should be configured as WEBSOCKET.
InvalidParameterValue.InvalidUpstream The backend channel does not exist or is invalid.
InvalidParameterValue.InvalidUrl The URL parameters are invalid.
InvalidParameterValue.LengthExceeded The length of the parameter exceeds the limit.
InvalidParameterValue.NotInOptions The parameter value is incorrect, as it is not an available option.
InvalidParameterValue.ParameterValueLimitExceeded The number of parameters exceeded limit.
InvalidParameterValue.RangeExceeded The parameter value is incorrect, as it is not within the valid value range.
MissingParameter.BackendSpecificParam The backend service parameter is missing.
MissingParameter.PluginConfig Parameter is missing in the plugin. Please check and try again.
UnsupportedOperation.InvalidAction API error.
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