UpdateCollector

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

PATCH|PUT /openapi/collectors/[ResId] HTTPS|HTTP

请求参数

RequestBody

RequestBody中还需填入以下参数，用来指定待更新采集器的配置信息。

特殊参数说明

extendConfigs中包括3种configType，分别为collectorTargetInstance、collectorElasticsearchForKibana、collectorDeployMachine，部署机器不同，需要配置的参数不同，具体组合方式如下：

• 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"
        }
    ]
}

正常返回示例

XML格式

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

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"
    }
}

错误码

访问错误中心查看更多错误码。