All Products
Search
Document Center

API Gateway:ModifyPlugin

Last Updated:Mar 01, 2024

Modifies the information of a plug-in.

Operation description

  • This operation is intended for API providers.
  • The name of the plug-in must be unique.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:ModifyPluginWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PluginIdstringYes

The ID of the plug-in whose information you want to modify.

a96926e82f994915a8da40a119374537
PluginNamestringNo

The name of the plug-in. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). However, it cannot start with an underscore.

modifyCors
PluginDatastringNo

The statement that is used to modify the plug-in definition.

Plugin definition
DescriptionstringNo

The description of the plug-in. The description can contain a maximum of 200 characters in length.

modify plugin first
Tagobject []No

The tag of objects that match the rule. You can specify multiple tags.

Key, Value
KeystringYes

The key of the tag.

N can be an integer from 1 to 20.``

env
ValuestringYes

The value of the tag.

N can be an integer from 1 to 20.``

' '

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CE5722A6-AE78-4741-A9B0-6C817D360510

Examples

Sample success responses

JSONformat

{
  "RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history