Call InstallSystemPlugin to install a system preset plug-in.
Debugging
Request header
This operation uses common request parameters only. For more information, see Common parameters.
Request syntax
POST /openapi/instances/[InstanceId]/plugins/system/actions/install HTTPS|HTTP
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
InstanceId | String | Yes | es-cn-n6w1o1x0w001c**** |
The ID of the instance. |
clientToken | String | No | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. |
RequestBody
Enter the name of the plug-in to be installed in RequestBody, in the format of ["plugin_name1","plugin_name2",...,"plugin_namen"]
, such as ["aliyun-sql","codec-compression"]
.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | F99407AB-2FA9-489E-A259-40CF6DCC**** |
The ID of the request. |
Result | List | ["aliyun-sql"] |
The list of plug-ins to be installed. |
Examples
Sample requests
POST /openapi/instances/es-cn-n6w1o1x0w001c****/plugins/system/actions/install HTTP/1.1
Common request parameters
["aliyun-sql","codec-compression"]
Sample success responses
JSON
format
{
"Result": ["aliyun-sql"],
"RequestId": "5A5D8E74-565C-43DC-B031-29289FA*****"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InstanceNotFound | The instanceId provided does not exist. | The error message returned because the specified instance cannot be found. Check the instance status. |
For a list of error codes, visit the API Error Center.