UpdateLogstashDescription を呼び出して、指定された Logstash インスタンスの名前を変更します。
この操作を呼び出すときは、次の点に注意してください。
インスタンスが activating、invalid、または inactive 状態の場合は、インスタンス名を変更できません。
デバッグ
リクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。 詳細については、「共通パラメーター」をご参照ください。
リクエスト構文
PATCH|POST /openapi/logstashes/[InstanceId]/description HTTPS|HTTPリクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| InstanceId | String | はい | ls-cn-n6w1o5jq**** | インスタンス ID。 |
| clientToken | String | いいえ | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | リクエストの冪等性を保証するためにクライアントによって生成された一意のトークン。 このパラメーターの値はクライアントによって生成され、異なるリクエスト間で一意です。 最大長は 64 ASCII 文字です。 |
リクエスト本文
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 | インスタンスのステータス。 4 つのインスタンスステータスがサポートされています。normal (アクティブ)、effective (アクティブ化中)、frozen (非アクティブ)、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 ( VPC ) のみがサポートされています。 |
└vpcId | String | vpc-abc | VPC の ID。 |
└vswitchId | String | vsw-abc | vSwitch の 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****"
}エラーコード
| HTTP コード | エラーコード | エラーメッセージ | 説明 |
| 400 | InstanceNotFound | 指定された instanceId は存在しません。 | インスタンスが見つからないために返されるエラーメッセージ。 インスタンスのステータスを確認してください。 |
エラーコードの一覧については、API エラーセンターをご覧ください。