UpdateCollectorName を呼び出して、コレクターの名前を変更します。
デバッグ
リクエストヘッダー
この操作では、共通リクエストヘッダーのみを使用します。詳細については、「共通リクエストパラメーター」をご参照ください。
リクエスト構造
POST /openapi/collectors/[ResId]/actions/rename HTTP/1.1
リクエストパラメーター
| パラメーター | タイプ | 位置 | 必須 | 例 | 説明 |
| ResId | 文字列 | パス | はい | ct-cn-77uqof2s7rg5c**** | コレクター ID。 |
| ClientToken | 文字列 | クエリ | いいえ | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | このパラメーターは、リクエストのべき等性を確保するために使用されます。このパラメーターの値はクライアントによって生成され、異なるリクエスト間で一意です。最大長は 64 ASCII 文字です。 |
リクエスト本文
変更されたコレクターの名前を指定するには、リクエスト本文に次のパラメーターを入力する必要があります。
パラメーター | タイプ | 必須 | 例 | 説明 |
name | 文字列 | はい | collectorName1 | 変更されたコレクターの名前。 |
例：
{ "name": "collectorName1" }
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| RequestId | 文字列 | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | リクエストの ID。 |
| Result | 構造体 | 返された結果。 | |
| collectorPaths | リスト | ["/var/log"] | Filebeat コレクションパス。コレクターのデプロイマシンが ECS の場合に表示されます。 |
| configs | configs の配列 | コレクターの構成ファイル情報。 | |
| content | 文字列 | - key: log\n title: ログファイルの内容\n description: >\n ログファイルの行が含まれています。\n .... | リモートファイルの内容。 |
| fileName | 文字列 | fields.yml | ファイルの名前。 |
| dryRun | ブール値 | false | コレクターを検証して作成するかどうか。その後、次の操作を実行できます。
|
| extendConfigs | extendConfigs の配列 | コレクター拡張構成。 | |
| configType | 文字列 | collectorDeployMachine | 構成のタイプ。その後、次の操作を実行できます。
|
| enableMonitoring | ブール値 | true | モニタリングを有効にするかどうか。 構成タイプ collectorTargetInstance、および インスタンスタイプ Elasticsearch表示されている場合。その後、次の操作を実行できます。
|
| groupId | 文字列 | default_ct-cn-5i2l75bz4776**** | マシングループ ID。 構成タイプ コレクターデプロイマシン 表示されている場合。 |
| host | 文字列 | es-cn-4591jumei000u****-kibana.internal.elasticsearch.aliyuncs.com:5601 | Kibana ダッシュボードが有効化された後の、Kibana のプライベートネットワークアクセスアドレスです。configType が collectorElasticsearchForKibana の場合に表示されます。 |
| hosts | リスト | ["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"] | コレクター出力は、インスタンスのアクセスアドレスのリストを指定します。configType が collectorTargetInstance の場合に表示されます。 |
| instanceId | 文字列 | es-cn-n6w1o1**** | コレクターに関連付けられているインスタンス ID。 が の場合はコレクター出力のインスタンス ID です。 が で、 が の場合は ACK クラスタ ID です。 構成タイプ collectorTargetInstance はコレクター出力のインスタンス ID です。 構成タイプ コレクターデプロイマシン、および 種類 ACK クラスタ は ACK クラスタ ID です。 |
| instanceType | 文字列 | elasticsearch | コレクター出力で指定されたインスタンスタイプ。サポート：Elasticsearch、Logstash。 が の場合に表示されます。 構成タイプ collectorTargetInstance 表示されている場合。 |
| kibanaHost | 文字列 | https://es-cn-4591jumei000u****.kibana.elasticsearch.aliyuncs.com:5601 | Kibana ダッシュボードが有効になった後の Kibana のインターネットアクセスアドレス。 が の場合に表示されます。 構成タイプ collectorElasticsearchForKibana 表示されている場合。 |
| machines | machines の配列 | コレクターによってデプロイされた ECS マシンのリスト。 が で、 が の場合に表示されます。 構成タイプ collectorDeployMachines、および 種類 ECSインスタンスID 表示されている場合。 | |
| agentStatus | 文字列 | heartOk | ECS 上の各コレクターのステータス。その後、次の操作を実行できます。heartOk (ハートビート正常)、heartLost (ハートビート異常)、uninstalled (インストールされていません) とfailed (インストール失敗)。 |
| instanceId | 文字列 | c1b9fde5172b84f82b9928e825a7b8988 | ECS マシン ID のリスト。 |
| protocol | 文字列 | HTTP | トランスポート プロトコル。サポートされているのは、HTTP、HTTPSです。 |
| successPodsCount | 文字列 | 8 | ACK クラスタの正常に収集されたポッドノードの総数です。configType が collectorDeployMachines で、type が ACKCluster の場合に表示されます。 |
| totalPodsCount | 文字列 | 10 | 収集された ACK クラスタのポッドノードの総数です。configType が collectorDeployMachines で、かつ type が ACKCluster の場合に表示されます。 |
| type | 文字列 | ECSInstanceId | コレクターによってデプロイされたマシンのタイプ。 が の場合に表示されます。その後、次の操作を実行できます。 構成タイプ コレクターデプロイマシン表示されている場合。その後、次の操作を実行できます。
|
| userName | 文字列 | elastic | 出力には、インスタンスのユーザー名が指定されます。デフォルト名は elastic です。configType が collectorTargetInstance または collectorElasticsearchForKibana の場合に表示されます。 |
| gmtCreatedTime | 文字列 | 2020-06-20T07:26:47.000+0000 | コレクターが作成された時刻。 |
| gmtUpdateTime | 文字列 | 2020-06-20T07:26:47.000+0000 | コレクターの更新時刻。 |
| name | 文字列 | ct-test | コレクターの名前。 |
| ownerId | 文字列 | 16852099488***** | Alibaba Cloud アカウントの ID。 |
| resId | 文字列 | ct-cn-77uqof2s7rg5c**** | コレクターインスタンス ID。 |
| resType | 文字列 | fileBeat | コレクタータイプ。fileBeat、metricBeat、heartBeat、audiBeat をサポートしています。 |
| resVersion | 文字列 | 6.8.5_with_community | コレクターのバージョン。サポートされているバージョンは、コレクターのデプロイマシンのタイプに関連しており、以下のとおりです。
|
| status | 文字列 | active | コレクターのステータス。Activating（有効）と active（有効）がサポートされています。 |
| vpcId | 文字列 | vpc-bp16k1dvzxtma***** | コレクターが配置されている仮想プライベートクラウド（VPC） ID。 |
例
リクエストの例
POST /openapi/collectors/ct-cn-77uqof2s7rg5c **** /actions/rename HTTP/1.1 パブリックリクエストヘッダー {"name": "collectorName1" }
成功レスポンスの例
JSON 形式
{ "Result": { "gmtCreatedTime": "2021-01-14T08:54:42.000+0000", "gmtUpdateTime": "2021-01-18T03:59:20.140+0000", "name": "API_test", "resId": "ct-cn-tfv81t7vs8608****", "resVersion": "6.8.5_with_community", "vpcId": "vpc-bp12nu14urf0upaf4****", "resType": "fileBeat", "ownerId": "168520994880****", "collectorPaths": [ "/opt/test/logs/" ], "configs": [ { "fileName": "fields.yml", "content": "- key: log\n title: ログファイルの内容\n description: >\n ログファイルの行が含まれています。\n fields:\n ......" }, { "fileName": "filebeat.yml", "content": "###################### Filebeat 構成例 #########################\n\n# このファイルは構成ファイルの例です ......" } ], "status": "active", "extendConfigs": [ { "configType": "collectorTargetInstance", "instanceId": "es-cn-nif201ihd0012****", "instanceType": "elasticsearch", "hosts": [ "es-cn-nif201ihd0012****.elasticsearch.aliyuncs.com:9200" ], "protocol": "HTTP", "userName": "elastic", "enableMonitoring": false }, { "configType": "collectorDeployMachine", "type": "ECSInstanceId", "machines": [ { "instanceId": "i-bp11u91xgubypcuz****", "agentStatus": "heartOk" } ], "groupId": "default_ct-cn-tfv81t7vs8608****" } ], "dryRun": false }, "RequestId": "9B2BD604-3B93-4F66-91F0-43B4D2D268FF" }
エラーコード
エラーコードのリストについては、 エラーセンター をご覧ください。