AttachPlugin - API Gateway - Alibaba Cloud Documentation Center

Operation description

This operation is intended for API providers.
You can only bind plug-ins to published APIs.
The plug-in takes effect immediately after it is bound to an API.
If you bind a different plug-in to an API, this plug-in takes effect immediately.

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:AttachPlugin

update

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

*Plugin

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

None

Request parameters

Parameter	Type	Required	Description	Example
PluginId	string	Yes	The ID of the plug-in to be bound.	9a3f1a5279434f2ba74ccd91c295af9f
GroupId	string	No	The ID of the API group that contains the API to which the plug-in is to be bound.	285bb759342649a1b70c2093a772e087
ApiIds	string	No	The number of the API to be operated. Separate multiple numbers with commas (,). A maximum of 100 numbers can be entered.	xxx
StageName	string	Yes	The name of the runtime environment. Valid values: RELEASE PRE: the pre-release environment TEST	TEST
ApiId	string	No	The number of the API to be bound.	8afff6c8c4c6447abb035812e4d66b65

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	EF924FE4-2EDD-4CD3-89EC-34E4708574E7

Examples

Success response

JSON format

{
  "RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.