調用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. | 執行個體找不到,請核對執行個體狀態。 |
訪問錯誤中心查看更多錯誤碼。