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.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:CreatePlugin	create	Plugin `acs:apigateway:{#regionId}:{#accountId}:plugin/`	none	none

Request parameters

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.``	' '

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details