调用UpdateXpackMonitorConfig,更新Logstash实例的X-Pack监控报警配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /openapi/logstashes/{InstanceId}/xpack-monitor-config HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
InstanceId String Path ls-cn-oew1qbgl****

Logstash实例ID。

ClientToken String Query 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。

Object Body

X-Pack监控的配置信息。

enable Boolean Body true

是否开启X-Pack监控:

  • true:开启
  • false:不开启
endpoints Array of String Body http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200

Elasticsearch实例的访问地址。

userName String Body elastic

Elasticsearch实例的用户名。

password String Body ******

Elasticsearch实例的密码。

返回数据

名称 类型 示例值 描述
Result Boolean true

返回结果:

  • true:更新成功
  • false:更新失败
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

请求ID。

示例

请求示例

POST /openapi/logstashes/ls-cn-oew1qbgl****/xpack-monitor-config?ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "enable" : true,
  "endpoints" : [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ],
  "userName" : "elastic",
  "password" : "******"
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "30A59FC7-609B-4C12-B6EF-991A5CA7****"
}

错误码

访问错误中心查看更多错误码。