CreateShipper--日志服务-火山引擎

文档中心

立即注册

导航

CreateShipper

最近更新时间：2024.11.29 12:04:13首次发布时间：2024.09.20 18:36:40

调用 CreateShipper 创建投递配置。

请求说明

请求方式：POST
请求地址：https://tls-{Region}.ivolces.com/CreateShipper

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数	类型	是否必选	示例值	描述
ContentInfo	Object of ContentInfo	是	`/`	日志内容的投递格式配置。
KafkaShipperInfo	Object of KafkaShipperInfo	否	`/`	投递到 Kafka 的相关配置。
ShipperEndTime	Integer	否	`1723709712496`	投递结束时间，毫秒时间戳，如果不配置，则会一直投递。说明投递到 Kafka 时，建议使用 `ShipperStartTime` 与 `ShipperEndTime` 字段配置投递的时间范围，将 `StartTime` 和 `EndTime` 字段留空。
ShipperName	String	是	`tosship`	投递配置名称，命名规则请参考资源命名规则。在一个日志项目中唯一。
ShipperStartTime	Integer	否	`1723709602496`	投递开始时间，毫秒时间戳。如果不配置，默认为当前时间。说明投递到 Kafka 时，建议使用 `ShipperStartTime` 与 `ShipperEndTime` 字段配置投递的时间范围，将 `StartTime` 和 `EndTime` 字段留空。
ShipperType	String	否	`tos`	投递类型。 tos：投递到 TOS。 kafka：投递到 Kafka。
TopicId	String	是	`c7****`	待投递日志所在的日志主题 ID。
TosShipperInfo	Object of TosShipperInfo	否	`/`	投递到对象存储 TOS 的相关配置。

ContentInfo

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Format	String	否	`json`	日志内容解析格式。投递到 TOS 时，支持配置为 json、csv。投递到 Kafka 时，支持配置为 original、json。
CsvInfo	Object of CsvInfo	否	`/`	CSV 格式日志内容配置。
JsonInfo	Object of JsonInfo	否	`/`	JSON 格式日志内容配置。

Format

String

否

json

日志内容解析格式。

投递到 TOS 时，支持配置为 json、csv。
投递到 Kafka 时，支持配置为 original、json。

CsvInfo Object of CsvInfo 否 / CSV 格式日志内容配置。

JsonInfo Object of JsonInfo 否 / JSON 格式日志内容配置。

KafkaShipperInfo

参数	类型	是否必选	示例值	描述
EndTime	Integer	否	`1723709712496`	投递结束时间，毫秒时间戳，如果不配置，则会一直投递。说明投递到 Kafka 时，建议使用 `ShipperStartTime` 与 `ShipperEndTime` 字段配置投递的时间范围，将 `StartTime` 和 `EndTime` 字段留空。
Compress	String	是	`snappy`	压缩格式，当前支持 snappy、gzip、lz4、none。
Instance	String	是	`kafka-cnngbnntswg1****`	Kafka 实例。
StartTime	Integer	否	`1723709602496`	投递开始时间，毫秒时间戳，如果不配置，默认为当前时间。说明投递到 Kafka 时，建议使用 `ShipperStartTime` 与 `ShipperEndTime` 字段配置投递的时间范围，将 `StartTime` 和 `EndTime` 字段留空。
KafkaTopic	String	是	`topic-c`	Kafka Topic 名称。通过此投递配置投递的所有日志数据均将被投递到该 Topic 中。

TosShipperInfo

参数	类型	是否必选	示例值	描述
Bucket	String	是	`mytos`	选择 TOS 存储桶，必须与源日志主题位于同一地域。只能包含数字、横线（-）、字母a-z。开始和结尾只能是数字或字母。长度在3-63个字符之内。
Prefix	String	否	`testprefix`	存储桶的顶级目录名称。通过此投递配置投递的所有日志数据均将被投递到该目录下。不能以正斜线（/）或者反斜线（\）开头，且不能使用连续的正斜线（/）。不能以 `..` 作为文件夹名称。同一存储桶中，文件夹不允许重名。
MaxSize	Integer	否	`5`	每个分区（Shard）最大可投递的原始文件大小，即未压缩的日志文件大小。单位为 MiB，取值范围为 5~256。
Compress	String	否	`snappy`	压缩格式，当前支持 snappy、gzip、lz4、none。
Interval	Integer	否	`300`	投递时间间隔，单位为秒，取值范围为 300～900。
PartitionFormat	String	否	`%Y/%m/%d/%H/%M`	投递日志的分区规则。子目录命名格式支持 strftime 语法，默认设置为 `%Y/%m/%d/%H/%M`，例如 2022/06/30/14/00。不能以正斜线（/）或者反斜线（\）开头。

CsvInfo

参数	类型	是否必选	示例值	描述
Keys	Array of String	是	`["user","log","ip"]`	配置需要投递的字段。仅支持字母、数字和`_-./`，并且不支持以`_`开头。同一个索引中 Key 名称唯一。长度为 1~128。
Delimiter	String	是	`,`	分隔符，支持填入逗号、制表符、竖线、分号、空格。
EscapeChar	String	是	`''`	转义符，字段内容包含分隔符时，使用转义符包裹该字段，当前仅支持单引号，双引号，空字符。
PrintHeader	Boolean	是	`false`	首行是否打印 Key。
NonFieldContent	String	是	`test`	无效字段填充内容，长度为 0~128。

JsonInfo

参数	类型	是否必选	示例值	描述
Keys	Array of String	否	`["__content", "__pod_name__"]`	以 JSON 格式投递时，如果不配置此参数则表示投递所有字段，包括 `__content__`（必选）、`__source__`、`__path__`、`__time__`、`__image_name__`、`__container_name__`、`__pod_name__`、`__pod_uid__`、`namespace`、 `__tag____client_ip__`、`__tag____receive_time__`。
Enable	Boolean	是	`true`	启用标志。
Escape	Boolean	否	`true`	是否转义。必须配置为 true。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ShipperId	String	`4a9bd4bd-53f1-43ff-b88a-64ee1be5****`	投递配置 ID。

请求示例

POST https://tls-{Region}.ivolces.com/CreateShipper HTTP/1.1
Content-Type: application/json
{
    "ContentInfo": {
        "Format": "json",
        "JsonInfo": {
            "Enable": true
        }
    },
    "ShipperName": "test",
    "ShipperType": "tos",
    "TopicId": "a91c0d37-4c71-xxxx-b9cf-c0fae292d357",
    "TosShipperInfo": {
        "Bucket": "import-test",
        "Compress": "none",
        "Interval": 60,
        "MaxSize": 256,
        "PartitionFormat": "%Y",
        "Prefix": "test/"
    },
    "ShipperStartTime": 1719203400000,
    "ShipperEndTime": 1719204600000
}

返回示例

{"ShipperId": "4a9bd4bd-53f1-43ff-b88a-64ee1be5****"}

错误码

您可访问公共错误码，获取更多错误码信息。