調用UpdateLogstashDescription，修改指定Logstash執行個體的名稱。
調用該介面時，請注意：
執行個體狀態為生效中（activating）、失效（invalid）和凍結（inactive）時，無法修改執行個體名稱。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
要求標頭
該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。
請求文法
PATCH|POST /openapi/logstashes/[InstanceId]/description HTTP/1.1請求參數
| 名稱 | 類型 | 位置 | 是否必選 | 樣本值 | 描述 |
| InstanceId | String | Path | 是 | ls-cn-n6w1o5jq**** | 執行個體ID。 |
| clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | 用於保證請求的等冪性。由用戶端產生該參數值，要保證在不同請求間唯一，最大不超過64個ASCII字元。 |
RequestBody
RequestBody中還需填入description欄位，用來指定修改後的執行個體名稱，樣本如下。
{
"description": "logstash_name"
}
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | 請求ID。 |
| Result | Struct | 返回結果。 |
|
| description | String | logstash_name | 執行個體名稱。 |
Result中還包含以下參數。
參數名稱 |
資料類型 |
樣本值 |
描述 |
instanceId |
String |
ls-cn-n6w1o5jq**** |
執行個體ID。 |
description |
String |
ls-cn-abc |
執行個體名稱。 |
nodeAmount |
Integer |
2 |
執行個體的節點個數。 |
paymentType |
String |
postpaid |
執行個體的付費方式。支援：prepaid（訂用帳戶）、postpaid（隨用隨付）。 |
status |
String |
active |
執行個體的狀態，支援四種狀態：正常（active）、生效中（activating）、凍結（inactive）和失效（invalid）。 |
esVersion |
String |
6.7.0_with_X-Pack |
執行個體的版本。 |
createdAt |
String |
2018-07-13T03:58:07.253Z |
執行個體的建立時間。 |
updatedAt |
String |
2018-07-13T03:58:07.253Z |
執行個體最後更新的時間。 |
nodeSpec |
節點的配置資訊。 |
||
└spec |
String |
logstash.n4.small |
節點規格。 |
└disk |
Integer |
40 |
節點的硬碟大小。 |
networkConfig |
網路設定。 |
||
└type |
String |
vpc |
網路類型。目前只支援Virtual Private Cloud（Virtual Private Cloud）。 |
└vpcId |
String |
vpc-abc |
VPC ID。 |
└vswitchId |
String |
vsw-abc |
虛擬交換器ID。 |
vsArea |
String |
cn-hangzhou-* |
執行個體所在的可用性區域。 |
domainList |
網域名稱列表。 |
||
└domain |
String |
ls-cn-abc.logstash.aliyuncs.com |
執行個體分配的私網網域名稱。 |
└port |
Integer |
7001 |
連接埠號碼。 |
樣本
請求樣本
PATCH /openapi/logstashes/ls-cn-n6w1o5jq****/description HTTP/1.1
公用要求標頭
{
"description": "logstash_name"
}正常返回樣本
JSON格式
{
"Result": {
"instanceId": "ls-cn-n6w1o5jq****",
"version": "6.7.0_with_X-Pack",
"description": "logstash_name",
"nodeAmount": 1,
"paymentType": "postpaid",
"status": "active",
"enablePublic": false,
"nodeSpec": {
"spec": "elasticsearch.sn1ne.large",
"disk": 50,
"diskType": "cloud_ssd"
},
"networkConfig": {
"vpcId": "vpc-bp16k1dvzxtmagcva****",
"vswitchId": "vsw-bp1k4ec6s7sjdbudw****",
"vsArea": "cn-hangzhou-i",
"type": "vpc"
},
"createdAt": "2020-05-27T01:30:15.947Z",
"updatedAt": "2020-07-08T02:38:47.137Z",
"commodityCode": "elasticsearch_logstash_post",
"extendConfigs": [],
"endTime": 4749897600000,
"clusterTasks": [],
"resourceGroupId": "rg-acfm2h5vbzd****",
"zoneCount": 1,
"protocol": "HTTP",
"zoneInfos": [
{
"zoneId": "cn-hangzhou-i",
"status": "NORMAL"
}
],
"instanceType": "logstash",
"inited": true,
"tags": [],
"config": {
"xpack.monitoring.elasticsearch.username": "elastic",
"xpack.monitoring.enabled": "true",
"slowlog.threshold.debug": "500ms",
"xpack.monitoring.elasticsearch.password": "Elasti****",
"xpack.monitoring.elasticsearch.hosts": "[\"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200\"]",
"slowlog.threshold.warn": "2s",
"slowlog.threshold.info": "1s",
"slowlog.threshold.trace": "100ms"
},
"endpointList": [
{
"host": "172.16.**.**",
"port": 9600,
"zoneId": "cn-hangzhou-i"
}
]
},
"RequestId": "C3845099-3D0E-4D2B-9D62-F16019EE****"
}錯誤碼
| HttpCode | 錯誤碼 | 錯誤資訊 | 描述 |
| 400 | InstanceNotFound | The instanceId provided does not exist. | 執行個體找不到，請核對執行個體狀態。 |
訪問錯誤中心查看更多錯誤碼。