调用 DescribeShipper 接口获取投递配置的详细信息。 ## 请求说明 * 请求方式：GET * 请求地址：https://{tls\-endpoint}/DescribeShipper ## 请求参数下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6470/112170)。 ### Query |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |ShipperId |String |是 |`f3e901c3-b17f-42fd-aa8c-dc91a6c7****` |待查询的投递配置 ID。 | ## 返回参数下表仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6470/112169)。 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |ContentInfo |Object of [ContentInfo](#contentinfo) |`/` |投递日志的内容格式配置。 | |CreateTime |String |`2024-09-01 14:01:02` |创建投递配置的时间。 | |DashboardId |String |`/` |投递的默认内置仪表盘 ID。 | |KafkaShipperInfo |Object of [KafkaShipperInfo](#kafkashipperinfo) |`/` |投递到 Kafka 的相关信息。 | |ModifyTime |String |`2024-09-01 14:01:10` |投递配置的最近修改时间。 | |ProjectId |String |`myproject` |待投递日志所在的日志项目 ID。 | |ProjectName |String |`myproject` |待投递日志所在的日志项目名称。 | |RoleTrn |String |`trn:iam::2100000001:role/TLSETLAccessForUserA` |自定义角色的 Trn。 | |ShipperEndTime |Integer |`1723709712496` |投递结束时间。 | |ShipperId |String |`4a9bd4bd-53f1-43ff-b88a-64ee1be5****` |投递配置 ID。 | |ShipperName |String |`tosship` |投递配置名称。 | |ShipperStartTime |Integer |`1723709602496` |投递开始时间。 | |ShipperType |String |`tos` |投递类型。 | |Status |Boolean |`true` |是否开启投递配置。 | |TopicId |String |`c7****` |待投递日志所在的日志主题 ID。 | |TopicName |String |`mytopic` |待投递日志所在的日志主题名称。 | |TosShipperInfo |Object of [TosShipperInfo](#tosshipperinfo) |`/` |投递到 TOS 的相关信息。 | ### ContentInfo |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Format |String |`json` |日志内容解析格式。|\ | | | ||\ | | | |* 投递到 TOS 时，支持配置为 json、csv。|\ | | | |* 投递到 Kafka 时，支持配置为 original、json。 | |CsvInfo |Object of [CsvInfo](#csvinfo) |`/` |CSV 格式日志内容配置。 | |JsonInfo |Object of [JsonInfo](#jsoninfo) |`/` |JSON 格式日志内容配置。 | ### KafkaShipperInfo |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |EndTime |Integer |`1723709712496` |投递结束时间，毫秒时间戳，如果不配置，则会一直投递。|\ | | | |:::tip|\ | | | |投递到 Kafka 时，建议使用 `ShipperStartTime` 与 `ShipperEndTime` 字段配置投递的时间范围，将 `StartTime` 和 `EndTime`字段留空。|\ | | | ||\ | | | |:::| |Compress |String |`snappy` |压缩格式，当前支持 snappy、gzip、lz4、none。 | |Instance |String |`kafka-cnngbnntswg1****` |Kafka 实例。 | |StartTime |Integer |`1723709602496` |投递开始时间，毫秒时间戳，如果不配置，默认为当前时间。|\ | | | |:::tip|\ | | | |投递到 Kafka 时，建议使用 `ShipperStartTime` 与 `ShipperEndTime` 字段配置投递的时间范围，将 `StartTime` 和 `EndTime`字段留空。|\ | | | ||\ | | | |:::| |KafkaTopic |String |`topic-c` |Kafka Topic 名称。通过此投递配置投递的所有日志数据均将被投递到该 Topic 中。 | ### TosShipperInfo |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Bucket |String |`mytos` |对象存储桶名称。 | |Prefix |String |`testprefix` |存储桶的顶级目录名称。通过此投递配置投递的所有日志数据均将被投递到该目录下。 | |MaxSize |Integer |`5` |每个分区（Shard）最大可投递的原始文件大小，即未压缩的日志文件大小。单位为 MiB。 | |Compress |String |`snappy` |压缩格式。 | |Interval |Integer |`300` |投递时间间隔，单位为秒。 | |PartitionFormat |String |`%Y/%m/%d/%H/%M` |投递日志的分区规则。 | ### 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。 | ## 请求示例 ```json GET https://{tls-endpoint}/DescribeShipper?&ShipperId=f3e901c3-b17f-42fd-aa8c-dc91a6c7**** HTTP/1.1 Content-Type: application/json ``` ## 返回示例 ```json { "ShipperId": "62f555d9-d****8c8-f47cf7ab2f8e", "ShipperName": "csv-search-log", "ProjectId": "d11be*****47cf-8170-72c318262132", "ProjectName": "log-sy", "TopicId": "eca85523******56-b750-681141d6aa8a", "TopicName": "search-log", "Status": true, "ShipperType": "tos", "TosShipperInfo": { "Bucket": "tls-topic-shipper", "Prefix": "csv-search-log", "PartitionFormat": "%Y/%m/%d/%H", "MaxSize": 256, "Interval": 300, "Compress": "snappy" }, "ContentInfo": { "Format": "csv", "CsvInfo": { "PrintHeader": true, "Keys": [ "account_id", "status", "Action", "ReqID", "__image_name__", "__content__", "__time__" ], "Delimiter": ",", "EscapeChar": "'", "NonFieldContent": "" }, "JsonInfo": null }, "ShipperStartTime": 1725012764000, "ShipperEndTime": null, "CreateTime": "2024-08-22 12:23:16", "ModifyTime": "2024-08-30 18:12:44" } ``` ## 错误码您可访问[公共错误码](https://www.volcengine.com/docs/6470/112173)，获取更多错误码信息。

日志服务