tencent cloud

文档反馈

创建投递任务

最后更新时间:2022-02-22 09:54:21

    功能描述

    本接口用于创建投递任务。

    注意:

    创建投递 Ckafka 投递任务时,需要确认对 Ckafka 的 Topic 具有写权限。

    请求

    请求行

    POST /consumer
    

    请求示例

    POST /consumer?topic_id=xxxxx HTTP/1.1
    Host: <Region>.cls.myqcloud.com
    Authorization: <AuthorizationString>
    Content-Type: application/json
    {
    "ckafka": {
      "vip": "10.123.123.123",
      "vport": "8888",
      "instance_id": "xxxxxx",
      "instance_name": "myname",
      "topic_id": "xxxxx",
      "topic_name": "xxx",
    },
    "content": {"enable_tag":true,"meta_fields":["__SOURCE__"]},
    "need_content": true
    }
    

    请求头

    无特殊。

    请求参数

    字段名 类型 位置 是否必须 含义
    topic_id string query 投递任务绑定的日志主题 ID
    ckafka object body Ckafka 实例信息
    need_content bool body 是否投递日志的元数据信息,默认为 true
    content object body 如果需要投递元数据信息,元数据信息的描述

    ckafka 格式如下:

    字段名 类型 是否必有 含义
    vip string Ckafka 的 vip
    vport string Ckafka 的 vport
    instance_id string Ckafka 的 instance_id
    instance_name string Ckafka 的 instance_name
    topic_id string Ckafka 的 topic_id
    topic_name string Ckafka 的 topic_name

    content 格式如下:

    字段名 类型 是否必须 含义
    enable_tag bool 是否投递 TAG 信息
    meta_fields array(string) 需要投递的元数据列表,目前仅支持:__SOURCE__,__FILENAME__和__TIMESTAMP__

    响应

    响应示例

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

    响应头

    无特殊。

    响应参数

    无。

    错误码

    参见 错误码