All Products
Search
Document Center

Microservices Engine:CreatePluginConfig

Last Updated:Nov 20, 2024

Creates a plug-in configuration.

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

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
mse:CreatePluginConfigcreate
*Gateway
acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-ubuwqygbq4783gqb2y3f87q****
PluginIdlongYes

The gateway plug-in ID.

20
ConfigLevelintegerYes

The application scope of the plug-in. Valid values:

  • 0: global
  • 1: route
  • 2: domain name
1
ConfigstringNo

The plug-in configuration. The configuration content of the WebAssembly (Wasm) plug-in is in the YAML format. The configuration content of the Lua plug-in is Lua code.

status_code: 200 headers: - Content-Type=application/json body: "{\"rule\": \"global\"}"
EnablebooleanYes

Indicates whether the plug-in is enabled.

true
ResourceIdListarrayNo

The domain IDs or route IDs. They are distinguished based on ConfigLevel.

longNo

The ID.

200
AcceptLanguagestringNo

The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.

zh

Response parameters

ParameterTypeDescriptionExample
object

RestResult

RequestIdstring

The request ID.

03A3E2F4-6804-5663-9D5D-2EC47A1*****
PluginConfigIDlong

The plug-in configuration ID.

10

Examples

Sample success responses

JSONformat

{
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "PluginConfigID": 10
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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