Elasticsearch:UpdateCollector

リクエストヘッダー

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

リクエスト構文

PUT /openapi/collectors/{ResId} HTTP/1.1

リクエストパラメーター

RequestBody

更新するクローラーの構成情報を指定するには、RequestBody パラメーターにも次のパラメーターを入力する必要があります。

特別なパラメーターの説明

extendConfigs には、 collectorTargetInstance 、 collectorElasticsearchForKibana 、 collectorDeployMachine の 3 つの configType が含まれています。構成するパラメーターは、デプロイマシンによって異なります。具体的な組み合わせは次のとおりです。

• 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

レスポンスパラメーター

例

リクエストの例

PUT /openapi/collectors/ct-cn-77uqof2s7rg5c**** HTTP/1.1
共通リクエストヘッダー

{
    "dryRun": false, 
    "name": "fileBeat", 
    "resVersion": "6.8.5_with_community", 
    "extendConfigs": [
        {
            "instanceId": "es-cn-sfd", 
            "configType": "collectorElasticsearchForKibana", 
            "hosts": [
                "es-cn-abc.elasticsearch.aliyuncs.com:9200", 
                "es-cn-abd.elasticsearch.aliyuncs.com:9200"
            ], 
            "userName": "elastic", 
            "password": "******", 
            "protocol": "https"
        }, 
        {
            "instanceId": "ec-cn-targ", 
            "instanceType": "elasticsearch", 
            "configType": "collectorTargetInstance", 
            "hosts": [
                "es-cn-abc.elasticsearch.aliyuncs.com:9200", 
                "es-cn-abd.elasticsearch.aliyuncs.com:9200"
            ], 
            "userName": "elastic", 
            "password": "******", 
            "protocol": "https"
        }, 
        {
            "values": [
                {
                    "instanceId": "id1"
                }, 
                {
                    "instanceId": "id2"
                }
            ], 
            "type": "ECSInstanceId", 
            "configType": "collectorDeployMachine"
        }
    ], 
    "resType": "fileBeat", 
    "vpcId": "vpc-cn-abc", 
    "configs": [
        {
            "fileName": "filebeat.yml", 
            "content": "filebeat.inputs:xxx"
        }
    ]
}

成功レスポンスの例

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***",
  "Result" : {
    "configs" : {
      "fileName" : "filebeat.yml",
      "content" : "filebeat.inputs:xxx"
    },
    "dryRun" : false,
    "resType" : "fileBeat",
    "ownerId" : "16852099488*****",
    "resId" : "ct-cn-0v3xj86085dvq****",
    "collectorPaths" : [ "/var/log" ],
    "gmtUpdateTime" : "2020-06-20T07:26:47.000+0000",
    "extendConfigs" : [ {
      "enableMonitoring" : true,
      "groupId" : "default_ct-cn-5i2l75bz4776****",
      "instanceType" : "elasticsearch",
      "type" : "ECSInstanceId",
      "userName" : "elastic",
      "configType" : "collectorDeployMachine",
      "protocol" : "HTTP",
      "instanceId" : "es-cn-nif1z89fz003i****",
      "host" : "es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601",
      "kibanaHost" : "https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601",
      "totalPodsCount" : 10,
      "successPodsCount" : 8
    }, {
      "machines" : {
        "agentStatus" : "heartOk",
        "instanceId" : "i-bp13y63575oypr9d****"
      }
    }, {
      "hosts" : [ "es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200" ]
    } ],
    "resVersion" : "6.8.5_with_community",
    "vpcId" : "vpc-bp16k1dvzxtma*****",
    "name" : "ct-test",
    "gmtCreatedTime" : "2020-06-20T07:26:47.000+0000",
    "status" : "active"
  }
}

エラーコード

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