すべてのプロダクト
Search

このプロダクト

    Elasticsearch:ListCollectors

    ドキュメントセンター

    Elasticsearch:ListCollectors

    最終更新日:Mar 17, 2025

    ListCollectors を呼び出して、コレクターの一覧情報を取得します。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。操作を呼び出すと、OpenAPI Explorer はさまざまな SDK の操作のサンプルコードを動的に生成します。

    リクエストヘッダー

    この操作では、共通リクエストヘッダーのみを使用します。詳細については、「共通リクエストパラメーター」をご参照ください。

    リクエスト構造

    
     GET /openapi/collectors HTTP/1.1

    リクエストパラメーター

    パラメーター タイプ 位置 必須 例 説明
    resId String Query いいえ ct-cn-77uqof2s7rg5c****

    コレクター ID。

    name String Query いいえ collectorName1

    コレクターの名前。

    instanceId String Query いいえ es-cn-nif1q8auz0003****

    コレクターに関連付けられているインスタンス ID。

    page Integer Query いいえ 1

    返される結果のページ数。デフォルト値：1、最小値：1、最大値：200。

    size Integer Query いいえ 10

    1 ページあたりの結果数。デフォルト値：20、最小値：1、最大値：500。

    sourceType String Query いいえ ECS

    コレクターがデプロイされているマシンのタイプを指定します。何も入力しないとすべてのタイプが返されます。有効な値：

    • ECS：ECS インスタンス
    • ACK：Container Service Kubernetes クラスター

    レスポンスパラメーター

    パラメーター タイプ 例 説明
    Headers Struct

    レスポンスのヘッダー。

    X-Total-Count Integer 5

    返されたレコードの数。

    RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

    リクエストの ID。

    Result Array of Result

    戻り値。

    collectorPaths List ["/var/log"]

    Filebeat の取得パス。

    configs Array of configs

    コレクターの設定ファイル情報。

    content String - key: log\n title: Log file content\n description: >\n Contains log file lines.\n ....

    リモートファイルの内容。

    fileName String fields.yml

    中間ファイルの名前。

    dryRun Boolean false

    コレクターを検証して作成するかどうか。その後、以下の操作を実行できます。

    • true: チェックのみを行い、作成は行いません。
    • false: チェックと作成を行います。
    extendConfigs Array of extendConfigs

    拡張パラメーター情報。

    configType String collectorDeployMachine

    構成のタイプ。その後、以下の操作を実行できます。

    • collectorTargetInstance: コレクターの出力
    • collectorDeployMachine: コレクターのデプロイマシン
    • collectorElasticsearchForKibana: Kibana ダッシュボードをサポートする Elasticsearch インスタンス情報
    enableMonitoring Boolean true

    監視を有効にするかどうか、configType の collectorTargetInstance、および instanceType の elasticsearch が表示されている場合。その後、次の操作を実行できます。

    • true
    • false
    groupId String default_ct-cn-5i2l75bz4776****

    マシングループ ID。 構成タイプ コレクターデプロイマシン 表示されている場合。

    host String es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601

    Kibana ダッシュボードが有効になった後の、Kibana のプライベートネットワークアクセスアドレスです。configType が collectorElasticsearchForKibana の場合に表示されます。

    hosts List ["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]

    コレクター出力は、インスタンスのアクセスアドレスのリストを指定します。configType が collectorTargetInstance の場合に表示されます。

    instanceId String es-cn-nif1z89fz003i****

    コレクターに関連付けられたインスタンス ID です。configType が collectorTargetInstance の場合、コレクター出力のインスタンス ID です。configType が collectorDeployMachines で、type が ACKCluster の場合は、ACK ( Container Kubernetes ) クラスタ ID です。

    instanceType String elasticsearch

    コレクター出力で指定されたインスタンスタイプ。 Elasticsearch 、 logstash をサポートします。 configType が collectorTargetInstance の場合に表示されます。

    kibanaHost String https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601

    Kibana ダッシュボードが有効になった後の Kibana のインターネットアクセスアドレスです。configType が collectorElasticsearchForKibana の場合に表示されます。

    machines Array of machines

    コレクターによってデプロイされた ECS マシンのリスト。 configType が collectorDeployMachines で、type が ECSInstanceId の場合に表示されます。

    agentStatus String heartOk

    ECS 上の各コレクターのステータス。その後、以下の操作を実行できます。

    • heartOk: 通常のハートビート
    • heartLost: 異常なハートビート
    • uninstalled: インストールされていません
    • failed: インストールに失敗しました
    instanceId String i-bp13y63575oypr9d****

    ECS マシン ID のリスト。

    protocol String HTTP

    伝送プロトコルは、コレクター出力で指定されたインスタンスのアクセスプロトコルと一致している必要があります。 HTTP および HTTPS がサポートされています。 configType が collectorTargetInstance の場合に表示されます。

    successPodsCount String 8

    ACK クラスタの正常に収集されたポッドノードの総数です。configType が collectorDeployMachines の場合、および type が ACKCluster の場合に表示されます。

    totalPodsCount String 10

    収集された ACK クラスタのすべてのポッドノードの数です。configType が collectorDeployMachines の場合、および type が ACKCluster の場合に表示されます。

    type String ECSInstanceId

    コレクターによってデプロイされたマシンのタイプ。 が の場合に表示されます。その後、以下の操作を実行できます。 構成タイプ collectorDeployMachine表示されている場合。その後、次の操作を実行できます。

    • ECSInstanceId:ECS
    • ACKCluster: Container Kubernetes
    userName String elastic

    出力には、インスタンスのユーザー名が指定されます。デフォルト名は elastic です。configType が collectorTargetInstance または collectorElasticsearchForKibana の場合に表示されます。

    gmtCreatedTime String 2020-08-18T02:06:12.000+0000

    コレクターが作成された時刻。

    gmtUpdateTime String 2020-08-18T09:40:43.000+0000

    コレクターの更新時刻。

    name String FileBeat001

    コレクターの名前。

    ownerId String 168520994880****

    Alibaba Cloud アカウントの ID。

    resId String ct-cn-0v3xj86085dvq****

    コレクターインスタンス ID。

    resType String fileBeat

    コレクタータイプ。FileBeat、Metricbeat、Heartbeat、Auditbeat がサポートされています。

    resVersion String 6.8.5_with_community

    コレクターのバージョン。

    status String active

    コレクターのステータス。その後、以下の操作を実行できます。

    • activating: 有効化中
    • active: 有効になっています
    vpcId String vpc-bp16k1dvzxtma*****

    コレクターが配置されている仮想プライベートクラウド (VPC) の ID。

    extendConfigs configType には collectorTargetInstance、collectorElasticsearchForKibana、collectorDeployMachine の 3 つの種類があります。デプロイ マシンが異なると、返されるパラメーターも異なります。具体的な組み合わせ方法は次のとおりです。

    • collectorTargetInstance

      • ECS

        configType、instanceId、instanceType、hosts、userName、password、protocol、enableMonitoring

      • ACK

        configType、instanceId、instanceType、userName、password、protocol、enableMonitoring

    • collectorElasticsearchForKibana

      • ECS

        configType、instanceId、host、kibanaHost、userName、password、protocol

      • ACK

        configType

    • collectorDeployMachine

      • ECS

        configType、type、machines、groupId

      • ACK

        configType、type、instanceId、totalPodsCount、successPodsCount

    例

    リクエストの例

    
     GET /openapi/collectors?resId=ct-cn-77uqof2s7rg5c ****&page=1&size=10&sourceType=ECS HTTP/1.1 パブリック リクエストヘッダー

    正常なレスポンスの例

    JSON フォーマット

    
     { "Result": [ { "gmtCreatedTime": "2020-11-05T12:42:47.000+0000", "gmtUpdateTime": "2020-11-06T06:06:20.000+0000", "name": "fileBeatOnACK", "resId": "ct-cn-6fy17c8z99c7i****", "resVersion": "6.8.5_with_community", "vpcId": "vpc-bp16k1dvzxtmagcva****", "resType": "fileBeat", "ownerId": "168520994880****", "configs": [ { "fileName": "logCollector.yml" }, { "fileName": "インデックス管理ポリシー 1 の名前" }, { "fileName": "インデックス管理ポリシー 2 の名前" } ], "status": "active", "extendConfigs": [ { "configType": "collectorTargetInstance", "instanceId": "es-cn-n6w1o1x0w001c****", "instanceType": "elasticsearch", "hosts": [ "es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "protocol": "HTTP", "userName": "elastic", "enableMonitoring": false }, { "configType": "collectorDeployMachine", "type": "ACKCluster", "instanceId": "c1b9fde5172b84f82b9928e825a7b****" }, { "configType": "collectorElasticsearchForKibana", "instanceId": "es-cn-n6w1o1x0w001c****", "host": "es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601", "protocol": "HTTPS", "kibanaHost": "https://es-cn-n6w1o1x0w001c****.kibana.elasticsearch.aliyuncs.com:5601", "userName": "elastic" } ], "dryRun": false }, { "gmtCreatedTime": "2020-09-25T10:27:02.000+0000", "gmtUpdateTime": "2020-09-25T10:27:02.000+0000", "name": "fileBeatOnECS", "resId": "ct-cn-6cro0lb0dn66c****", "resVersion": "6.8.5_with_community", "vpcId": "vpc-bp12nu14urf0upaf4****", "resType": "fileBeat", "ownerId": "168520994880****", "collectorPaths": [ "/var/log/" ], "configs": [ { "fileName": "fields.yml" }, { "fileName": "filebeat.yml" } ], "status": "active", "extendConfigs": [ { "configType": "collectorTargetInstance", "instanceId": "ls-cn-v0h1kzca****", "instanceType": "logstash", "hosts": [ "10.7.xx.xx:8007" ], "protocol": "HTTP", "enableMonitoring": false }, { "configType": "collectorDeployMachine", "type": "ECSInstanceId", "machines": [ { "instanceId": "i-bp13y63575oypr9d****", "agentStatus": "heartOk" } ], "groupId": "default_ct-cn-6cro0lb0dn66c****" } ], "dryRun": false } ], "RequestId": "70338AB9-231F-412B-A8C0-239CD32F****", "Headers": { "X-Total-Count": 2 } }

    レスポンスパラメーター

    エラーコードのリストについては、「API エラーセンター」をご参照ください。