All Products
Search
Document Center

API Gateway:AttachPlugin

Last Updated:Mar 01, 2024

Binds a plug-in to an API.

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.

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:AttachPluginWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PluginIdstringYes

The ID of the plug-in to be bound.

9a3f1a5279434f2ba74ccd91c295af9f
GroupIdstringNo

The ID of the API group that contains the API to which the plug-in is to be bound.

285bb759342649a1b70c2093a772e087
ApiIdsstringNo

The number of the API to be operated. Separate multiple numbers with commas (,). A maximum of 100 numbers can be entered.

xxx
StageNamestringYes

The name of the runtime environment. Valid values:

  • RELEASE
  • PRE: the pre-release environment
  • TEST
TEST
ApiIdstringNo

The number of the API to be bound.

8afff6c8c4c6447abb035812e4d66b65

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

EF924FE4-2EDD-4CD3-89EC-34E4708574E7

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history