Collector API メソッドと例

例 

この例では、limit=10 と指定することで応答を 10 件に制限しています。

リクエスト:

curl -u '<accessId>:<accessKey>' -X GET https://api.sumologic.com/api/v1/collectors?limit=10

応答:

{  
   "collectors":[  
      {  
         "id":2,
         "name":"OtherCollector",
         "collectorType":"Installable",
         "alive":true,
         "links":[  
            {  
               "rel":"sources",
               "href":"/v1/collectors/2/sources"
            }
         ],
         "collectorVersion":"19.33-28",
         "ephemeral":false,
         "description":"Local Windows Collection",
         "osName":"Windows 7",
         "osArch":"amd64",
         "osVersion":"6.1",
         "category":"local"
      },
      ...
   ]
}

例

次の例では、aliveBeforeDays=10 の設定により、オフラインである期間が 10 日以上の Installed Collector のリストが返されます。

リクエスト:

curl -u '<accessId>:<accessKey>' -X GET https://api.sumologic.com/api/v1/collectors/offline?aliveBeforeDays=10

応答:

{
  "collectors":[{
    "id":101622144,
    "name":"My Installed Collector",
    "timeZone":"Etc/UTC",
    "fields":{
      "_budget":"test_budget"
    },
    "links":[{
      "rel":"sources",
      "href":"/v1/collectors/101622144/sources"
    }],
    "ephemeral":false,
    "targetCpu":-1,
    "sourceSyncMode":"UI",
    "collectorType":"Installable",
    "collectorVersion":"19.162-12",
    "osVersion":"10.12.6",
    "osName":"Mac OS X",
    "osArch":"x86_64",
    "lastSeenAlive":1521143016128,
    "alive":false
  }]
}

例 

この例では、ID が 25 の Collector を取得しています。

リクエスト:

curl -u '<accessId>:<accessKey>' -X GET https://api.sumologic.com/api/v1/collectors/25

応答:

{
  "collector":{
    "id":25,
    "name":"dev-host-1",
    "timeZone":"UTC",
    "ephemeral":false,
    "sourceSyncMode":"Json",
    "collectorType":"Installable",
    "collectorVersion":"19.162-12",
    "osVersion":"3.13.0-92-generic",
    "osName":"Linux",
    "osArch":"amd64",
    "lastSeenAlive":1471553524302,
    "alive":true
  }
}

ルール

• ;、/、%、\ などの特殊文字を含む名前は、URL エンコードされる場合であってもサポートされません。
• 名前内のスペースは、URL エンコードされる場合はサポートされます。URL エンコードされるスペース文字は %20 です。たとえば、Collector の名前が Staging Area であれば、https://api.sumologic.com/api/v1/collectors/name/Staging%20Area のようにエンコードされます。
• 名前にピリオド . が含まれる場合は、リクエスト URL の末尾にスラッシュ / を付ける必要があります。たとえば、Collector の名前が Staging.Area であれば、https://api.sumologic.com/api/v1/collectors/name/Staging.Area/ のように指定する必要があります。

例 

この例では、名前が test である Collector を取得しています。

リクエスト:

curl -u '<accessId>:<accessKey>' -X GET https://api.sumologic.com/api/v1/collectors/name/test

応答:

{
  "collector":{
    "id":31,
    "name":"test",
    "timeZone":"UTC",
    "ephemeral":false,
    "sourceSyncMode":"Json",
    "collectorType":"Installable",
    "collectorVersion":"19.162-12",
    "osVersion":"3.13.0-92-generic",
    "osName":"Linux",
    "osArch":"amd64",
    "lastSeenAlive":1471553524302,
    "alive":true
  }
}

例

この例では、JSON ファイルにパラメータを指定して新規の Hosted Collector を作成しています。

リクエスト:

curl -u '<accessId>:<accessKey>' -X POST -H "Content-Type: application/json" -T hosted_collector.json https://api.sumologic.com/api/v1/collectors

リクエスト JSON (hosted_collector.json):

{
  "collector":{
    "collectorType":"Hosted",
    "name":"My Hosted Collector",
    "description":"An example Hosted Collector",
    "category":"HTTP Collection",
    "fields": {
        "_budget":"test_budget"
    }
  }
}

応答:

{
  "collector":{
    "id":102087219,
    "name":"My Hosted Collector",
    "description":"An example Hosted Collector",
    "category":"HTTP Collection",
    "timeZone":"UTC",
    "fields":{
      "_budget":"test_budget"
    },
    "links":[{
      "rel":"sources",
      "href":"/v1/collectors/102087219/sources"
    }],
    "collectorType":"Hosted",
    "collectorVersion":"",
    "lastSeenAlive":1536618284387,
    "alive":true
  }

例 

この例では、Collector を更新して ephemeral パラメータを true に変更しています。

まず、GET リクエストで -v フラグを指定して、ETag ヘッダの値を取得します。

最初の GET リクエスト:

curl -v -u '<accessId>:<accessKey>' -X GET https://api.sumologic.com/api/v1/collectors/15

最初の GET 応答:

< HTTP/1.1 200 OK
< ETag: "f58d12c6986f80d6ca25ed8a3943daa9"
...
{
  "collector":{
    "id":15,
    "name":"dev-host-1",
    "timeZone":"UTC",
    "ephemeral":false,
    "sourceSyncMode":"Json",
    "collectorType":"Installable",
    "collectorVersion":"19.162",
    "osVersion":"3.13.0-92-generic",
    "osName":"Linux",
    "osArch":"amd64",
    "lastSeenAlive":1471553974526,
    "alive":true
  }
* Connection #0 to host api.sumologic.com left intact

次に、Collector の JSON 属性を必要に応じて修正し (この例では ephemeral パラメータを true に変更します)、上記で取得した ETag を If-Match ヘッダに指定した PUT リクエストを使用します。

リクエスト:

curl -u '<accessId>:<accessKey>' -X PUT -H "Content-Type: application/json" -H "If-Match: \"f58d12c6986f80d6ca25ed8a3943daa9\"" -T updated_collector.json https://api.sumologic.net/api/v1/collectors/15

リクエスト JSON (updated_collector.json):

{
 "collector":{
    "id":15,
    "name":"dev-host-1",
    "timeZone":"UTC",
    "ephemeral":true,
    "sourceSyncMode":"Json",
    "collectorType":"Installable",
    "collectorVersion":"19.162",
    "osVersion":"3.13.0-92-generic",
    "osName":"Linux",
    "osArch":"amd64",
    "lastSeenAlive":1471553974526,
    "alive":true
  }
}

応答:

{
  "collector":{
    "id":15,
    "name":"dev-host-1",
    "timeZone":"UTC",
    "ephemeral":true,
    "sourceSyncMode":"Json",
    "collectorType":"Installable",
    "collectorVersion":"19.162",
    "osVersion":"3.13.0-92-generic",
    "osName":"Linux",
    "osArch":"amd64",
    "lastSeenAlive":1471554424736,
    "alive":true
  }
}

例

次の例では、aliveBeforeDays=10 の設定により、オフラインである期間が 10 日以上の Installed Collector がすべて削除されます。

リクエスト:

curl -u '<accessId>:<accessKey>' -X DELETE https://api.sumologic.com/api/v1/collectors/offline?aliveBeforeDays=10

応答:

応答に本文はなく、200 OK の応答とメッセージ [The delete task has been initiated (削除タスクが開始されました)] のみが返されます。ステータスを調べるには、GET リクエストを実行し、Collector が削除されているかどうかを確認します。

エラー コードとメッセージ  

コード	メッセージ
BadRequestCollectorId	リクエスト本文に無効な Collector ID が含まれています。
CannotModifyCollector	指定された Collector を修正する権限がありません。
CollectorDescriptionTooLong	説明は 1024 文字以内で指定してください。
CollectorNameTooLong	名前は 128 文字以内で指定してください。
createValidationError	指定された ID が無効です。
DuplicateResourceName	同じ名前のリソースがすでに存在します。
InvalidCollector	指定された Collector ID が無効です。
InvalidCollectorType	リクエストされた操作に対して Collector タイプが無効です。