CreatePlugin - API Gateway - Alibaba Cloud Documentation Center

Creates a plug-in.

Operation description

This operation is intended for API providers.
The number of plug-ins of the same type that each user can create is limited. Different limits apply to different plug-in types.
The plug-in definitions for advanced features are restricted.
Plug-ins must be bound to APIs to take effect. After a plug-in is bound, it takes effect on that API immediately.

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
PluginName	string	Yes	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.	NewCors
PluginType	string	Yes	The type of the plug-in. Valid values: ipControl: IP address-based access control trafficControl: throttling backendSignature: backend signature jwtAuth :JWT (OpenId Connect) authentication cors :cross-origin resource sharing (CORS) caching	cors
PluginData	string	Yes	The plug-in definition. Supported formats: JSON and YAML.	Plugin definition
Description	string	No	The description of the plug-in. The description can contain a maximum of 200 characters in length.	createPlugin
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.``	' '

Parameter	Type	Description	Example
	object
PluginId	string	The ID of the plug-in.	1f3bde29b43d4d53989248327ff737f2
TagStatus	boolean	Indicates whether the plug-in is successfully marked.	true
RequestId	string	The ID of the request.	EF924FE4-2EDD-4CD3-89EC-34E4708574E7

Sample success responses

JSONformat

{
  "PluginId": "1f3bde29b43d4d53989248327ff737f2",
  "TagStatus": true,
  "RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7"
}

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

Change time	Summary of changes	Operation

No change history