調用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 |
網絡類型。目前只支持專有網絡VPC（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. | 實例找不到，請核對實例狀態。 |
訪問錯誤中心查看更多錯誤碼。