All Products
Search
Document Center

API Gateway:ModifyPlugin

Last Updated:Mar 16, 2026

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:ModifyPlugin

update

*Plugin

acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}

None None

Request parameters

Parameter

Type

Required

Description

Example

PluginId

string

Yes

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

a96926e82f994915a8da40a119374537

PluginName

string

No

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

PluginData

string

No

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

Plugin definition

Description

string

No

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

modify plugin first

Tag

array<object>

No

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

Key, Value

object

No

Key

string

Yes

The key of the tag.

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

env

Value

string

Yes

The value of the tag.

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

' '

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

CE5722A6-AE78-4741-A9B0-6C817D360510

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.