ModifyPlugin

Last updated: 2021-08-17 15:22:59

1. API Description

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

This API is used to modify a 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: apigateway.ap-shanghai-fsi.tencentcloudapi.com

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: ModifyPlugin.
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.
PluginId Yes String ID of the plugin to be modified
PluginName No String Plugin name to be modified. A plugin name can 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.
Description No String Plugin description to be modified. A description is within 200 characters.
PluginData No String Plugin definition statement to be modified. The json format is supported.

3. Output Parameters

Parameter Name Type Description
Result Boolean Whether modification succeeded.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 ModifyPlugin

Input Example

https://apigateway.tencentcloudapi.com/?Action=ModifyPlugin
&PluginName=newplugin
&PluginId=plugin-3datbg1f
&Description=Modify a plugin
&PluginData={"type":"white_list","blocks":"172.3.1.4"}
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": true,
    "RequestId": "bb85842c-c0d2-4543-8f4d-396a193babe8"
  }
}

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.
InvalidParameterValue.NotInOptions The parameter value is incorrect, as it is not an available option.
ResourceNotFound.InvalidPlugin The plugin does not exist.
UnauthorizedOperation.AccessResource You do not have permission to access the resource.
UnsupportedOperation.InvalidAction API error.