调用UpdateLogstashSettings,更新指定Logstash实例的配置。

调用该接口时,请注意:

实例状态为生效中(activating)、失效(invalid)和冻结(inactive)时,无法更新信息。

调试

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

请求头

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

请求语法

PATCH|POST /openapi/logstashes/[InstanceId]/instance-settings HTTP/1.1

请求参数

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

实例ID。

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

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

RequestBody

RequestBody中还需要填入以下参数,用来更新指定Logstash实例的配置。

参数

类型

是否必要

示例值

描述

config

Map

{"thread_pool.bulk.queue_size":500}

用于更新实例的YML配置信息。

返回数据

名称 类型 示例值 描述
RequestId String 71D0D1DA-B22F-58CB-AF5B-D1657A6A****

请求ID。

返回数据中还包含Result参数,参数说明请参见ListLogstash

示例

请求示例

PATCH /openapi/logstashes/ls-cn-2r42btxr****/instance-settings HTTP/1.1
公共请求头

正常返回示例

JSON格式

{
    "Result": {
        "instanceId": "ls-cn-2r42btxr****",
        "version": "7.4.0_with_X-Pack",
        "description": "lrr",
        "nodeAmount": 1,
        "paymentType": "postpaid",
        "status": "active",
        "enablePublic": false,
        "nodeSpec": {
            "spec": "elasticsearch.sn1ne.large",
            "disk": 20,
            "diskType": "cloud_efficiency"
        },
        "dataNode": true,
        "networkConfig": {
            "vpcId": "vpc-bp1jy348ibzulk6hn****",
            "vswitchId": "vsw-bp1a0mifpletdd1da****",
            "vsArea": "cn-hangzhou-h",
            "whiteIpGroupList": [],
            "type": "vpc"
        },
        "createdAt": "2021-08-30T08:28:21.976Z",
        "updatedAt": "2021-08-30T08:59:06.371Z",
        "commodityCode": "elasticsearch_logstash_post",
        "extendConfigs": [],
        "endTime": 4786012800000,
        "clusterTasks": [],
        "resourceGroupId": "rg-acfmxxkk2p7****",
        "zoneCount": 1,
        "protocol": "HTTP",
        "zoneInfos": [
            {
                "zoneId": "cn-hangzhou-h",
                "status": "NORMAL"
            }
        ],
        "instanceType": "logstash",
        "inited": true,
        "tags": [
            {
                "tagKey": "acs:rm:rgId",
                "tagValue": "rg-acfmxxkk2p7****"
            }
        ],
        "serviceVpc": false,
        "isNewDeployment": false,
        "config": {
            "xpack.monitoring.enabled": "true",
            "xpack.monitoring.elasticsearch.username": "elastic",
            "slowlog.threshold.debug": "500ms",
            "xpack.monitoring.elasticsearch.hosts": "[\"http://es-cn-7pp2bvb75005u****.elasticsearch.aliyuncs.com:9200\"]",
            "xpack.monitoring.elasticsearch.password": "*******",
            "slowlog.threshold.warn": "2s",
            "slowlog.threshold.info": "1s",
            "slowlog.threshold.trace": "100ms"
        },
        "endpointList": [
            {
                "host": "172.29.XX.XX",
                "port": 9600,
                "zoneId": "cn-hangzhou-h"
            }
        ]
    },
    "RequestId": "71D0D1DA-B22F-58CB-AF5B-D1657A6A****"
}

错误码

HttpCode 错误码 错误信息 描述
400 InstanceActivating Instance is activating. 实例目前处于生效中。
400 InstanceNotFound The instanceId provided does not exist. 实例找不到,请核对实例状态。

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