tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

消费管理 (API2017)

最后更新时间：2023-02-16 17:18:40

    获取消费配置

    描述

    获取指定消费策略的详细信息。

    请求行

    GET /consumer

    请求示例

    GET /consumer?topic_id=xxxx-xx-xx-xx-xxxxxxxx HTTP/1.1
Host: <Region>.cls.myqcloud.com
Authorization: <AuthorizationString>

    请求头

    无特殊

    请求参数

    字段名 类型 位置 是否必选 含义
    topic_id string query 是 查询的日志主题 ID

    返回示例

    HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 123
{
  "effective": true,
  "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
}

    响应头

    无特殊

    返回内容说明

    字段名 类型 是否必选 含义
    effective bool 是 是否生效
    ckafka object 是 ckafka 消费相关信息
    content object 否 ckafka 的元数据信息
    need_content bool 否 是否投递ckafka 的元数据信息，默认为true

    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

    错误码

    请参见 错误码 文档。

    创建消费任务

    描述

    创建新的消费任务。

    请求行

    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 是 消费任务绑定的 topic_id
    ckafka object body 是 ckafka 消费相关信息
    content object body 否 ckafka 的元数据信息
    need_content bool body 否 是否投递 ckafka 的元数据信息，默认为 true

    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

    返回示例

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

    响应头

    无特殊

    返回内容说明

    无

    错误码

    请参见 错误码 文档。

    修改消费任务

    描述

    修改现有的消费任务。

    请求行

    PUT /consumer

    请求示例

    PUT /shipper?topic_id=xxxxxxxx HTTP/1.1
Host: <Region>.cls.myqcloud.com
Authorization: <AuthorizationString>
Content-Type: application/json
{
  "effective": true,
  "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 是 消费任务绑定的 topic_id
    effective bool body 否 消费任务是否生效
    ckafka object body 否 ckafka 消费相关信息
    content object body 否 ckafka 的元数据信息
    need_content bool body 否 是否投递 ckafka 的元数据信息，默认为 true

    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

    其中 effective、ckafka 至少要有一个。

    返回示例

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

    响应头

    无特殊

    返回内容说明

    无

    错误码

    请参见 错误码 文档。

    删除消费任务

    描述

    删除消费任务。

    请求行

    DELETE /consumer

    请求示例

    DELETE /consumer?topic_id=xxxx-xx-xx-xx-xxxxxxxx HTTP/1.1
Host: <Region>.cls.myqcloud.com
Authorization: <AuthorizationString>

    请求头

    无特殊

    请求参数

    字段名 类型 位置 是否必选 含义
    topic_id string query 是 要删除消费任务的日志主题 ID

    返回示例

    HTTP/1.1 200 OK
Content-Length: 0

    响应头

    无特殊

    返回内容说明

    无

    错误码

    请参见 错误码 文档。

    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款