All Products
Search
Document Center

API Gateway:AttachPlugin

Last Updated:Oct 19, 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

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