调用 ModifyShipper 接口修改指定的投递配置。 ## 请求说明 * 请求方式：PUT * 请求地址：https://{tls\-endpoint}/ModifyShipper ## 请求参数下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6470/112170)。 ### Body |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |ContentInfo |Object of [ContentInfo](#contentinfo) |否 |`/` |日志内容的投递格式配置。 | |KafkaShipperInfo |Object of [KafkaShipperInfo](#kafkashipperinfo) |否 |`/` |投递到 Kafka 的相关配置。 | |ShipperId |String |是 |`4a9bd4bd-53f1-43ff-b88a-64ee1be5****` |投递配置 ID。 | |ShipperName |String |否 |`test` |投递配置名称，命名规则请参考[资源命名规则](/docs/6470/74485#.6LWE5rqQ5ZG95ZCN6ZmQ5Yi2)。|\ | | | | |在一个日志项目中唯一。 | |ShipperType |String |否 |`tos` |投递的数据源类型。可选值：|\ | | | | ||\ | | | | |* tos：投递到 TOS。|\ | | | | | 如果不配置，默认为 TOS。|\ | | | | |* kafka：投递到 Kafka。 | |Status |Boolean |否 |`true` |是否开启投递配置。默认值为 true。 | |TosShipperInfo |Object of [TosShipperInfo](#tosshipperinfo) |否 |`/` |投递到对象存储 TOS 的相关信息。 | |RoleTrn |String |否 |`trn:iam::2100000001:role/TLSETLAccessForUserA` |自定义角色的 Trn。 | ### ContentInfo |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Format |String |否 |`json` |日志内容解析格式。|\ | | | | ||\ | | | | |* 投递到 TOS 时，支持配置为 json、csv。|\ | | | | |* 投递到 Kafka 时，支持配置为 original、json。 | |CsvInfo |Object of [CsvInfo](#csvinfo) |否 |`/` |CSV 格式日志内容配置。 | |JsonInfo |Object of [JsonInfo](#jsoninfo) |否 |`/` |JSON 格式日志内容配置。 | ### KafkaShipperInfo |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Compress |String |是 |`snappy` |压缩格式，当前支持 snappy、gzip、lz4、none。 | |Instance |String |是 |`kafka-cnngbnntswg1****` |Kafka 实例。 | |KafkaTopic |String |是 |`topic-c` |Kafka Topic 名称。通过此投递配置投递的所有日志数据均将被投递到该 Topic 中。 | ### TosShipperInfo |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |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](http://man7.org/linux/man-pages/man3/strptime.3.html) 语法，默认设置为 `%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 |是 |`false` |转义符，字段内容包含分隔符时，使用转义符包裹该字段，当前仅支持单引号，双引号，空字符。 | |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。 | ## 返回参数本接口无特有的返回参数。更多信息请见[返回结构](https://www.volcengine.com/docs/6470/112169)。 ## 请求示例 ```json PUT https://{tls-endpoint}/ModifyShipper HTTP/1.1 Content-Type: application/json { "ShipperId": "6e948fca-d3e*****0b-b5cca0b29383", "ContentInfo": { "Format": "json", "JsonInfo": { "Enable": true } }, "ShipperName": "tosTimeTest-1", "ShipperType": "tos", "TosShipperInfo": { "Bucket": "tos-import-logs", "Compress": "snappy", "Interval": 60, "MaxSize": 256, "PartitionFormat": "%Y", "Prefix": "timeTest" }, "ShipperStartTime": 1725012764000, "ShipperEndTime": 1723795560000 } ``` ## 返回示例 ```json HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {} ``` ## 错误码您可访问[公共错误码](https://www.volcengine.com/docs/6470/112173)，获取更多错误码信息。

日志服务