All Products
Search
Document Center

Microservices Engine:UpdatePluginConfig

Last Updated:Nov 20, 2024

Updates plug-in configurations.

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

Request parameters

ParameterTypeRequiredDescriptionExample
IdlongNo

The ID of the plug-in configuration.

1
GatewayIdlongNo

The ID of the gateway.

1
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-ubuwqygbq4783gqb2y3f87q****
PluginIdlongYes

The ID of the gateway plug-in.

2
EnablebooleanNo

Specifies whether to enable the plug-in.

true
ConfigstringNo

The plug-in configuration. Configurations of WebAssembly plug-ins are in the YAML format, and configurations of Lua plug-ins are in the Lua code.

\# Configure a check for the required fields of the plug-in, such as name, age, and friends. Sample configuration: name: John age: 18 friends: - David - Anne
ConfigLevelintegerYes

The application scope of the plug-in.

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

The creation time.

1667309705000
GmtModifiedstringNo

The update time.

1667309705000
AcceptLanguagestringNo

The language of the response. Valid values:

zh: Chinese en: English

zh

Response parameters

ParameterTypeDescriptionExample
object

RestResult

RequestIdstring

The ID of the request.

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

Indicates whether the request is successful.

true
Codeinteger

The status code returned.

200
ErrorCodestring

The error code that is returned.

500
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

success
DynamicMessagestring

The dynamic part in the error message.

code
Datalong

The ID of the plug-in configuration.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "500",
  "HttpStatusCode": 200,
  "Message": "success",
  "DynamicMessage": "code",
  "Data": 1
}

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.

Change history

Change timeSummary of changesOperation
2024-06-03The request parameters of the API has changedView Change Details
2023-05-18The internal configuration of the API is changed, but the call is not affectedView Change Details