Call UpdateKibanaSettings to modify the Kibana configuration. Currently, you can only modify the Kibana language configuration.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request header

This operation uses common request parameters only. For more information, see Common parameters.

Request syntax

PATCH|POST /openapi/instances/[InstanceId]/actions/update-kibana-settings 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-70B350****

This parameter is used to ensure the idempotence 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.


You can also specify the Kibana language by setting the i18n.locale parameter in RequestBody (optional, valid value: en by default). Example:

Note The i18n.locale parameter can only be en (English) or zh-CN (Chinese).

Response parameters

Parameter Type Example Description
RequestId String F99407AB-2FA9-489E-A259-40CF6DC*****

The ID of the request.

Result Boolean true

Return results:

  • true: The Kibana language modified successfully
  • false: The Kibana language modified failed


Sample requests

PATCH /openapi/instances/es-cn-n6w1o1x0w001c****/actions/update-kibana-settings HTTP/1.1
Common request parameters

Sample success responses

JSON format

    "Result": true,
    "RequestId": "5A5D8E74-565C-43DC-B031-29289FA9****"

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.