调用 DescribeShippers 获取投递配置列表。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ProjectId | String | 否 | f3e901c3-b17f-42fd-aa8c-dc91a6c7**** | 指定日志项目 ID，用于查询指定日志项目下的数据投递配置。 |
| ProjectName | String | 否 | fa************ | 指定日志项目名称，用于查询指定日志项目下的数据投递配置。支持模糊匹配。 |
| IamProjectName | String | 否 | default | 指定 IAM 项目名称，用于查询指定 IAM 项目下的数据投递配置。 |
| PageNumber | Integer | 否 | 10 | 分页大小。默认为 20，最大为 100。 |
| PageSize | Integer | 否 | 20 | 分页查询时的页码。默认为 1，即从第一页数据开始返回。 |
| ShipperName | String | 否 | test | 指定投递配置名称，支持模糊匹配。 |
| ShipperId | String | 否 | f3e901c3-b17f-42fd-aa8c-dc91a6c7**** | 指定投递配置 ID。 |
| TopicName | String | 否 | test | 指定日志主题名称，用于查询该日志主题相关的数据投递配置。支持模糊匹配。 |
| TopicId | String | 否 | f3e901c3-b17f-42fd-aa8c-dc91a6c7**** | 指定日志主题 ID，用于查询该日志主题相关的数据投递配置。 |
ShipperType | String | 否 |
| 指定投递类型，用于查询该投递类型相关的投递配置。可选值包括：
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Shippers | Array of DescribeResp | / | 投递配置相关信息。 |
| Total | Integer | 5 | 投递配置数量。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Boolean | true | 是否开启投递配置。 |
| TopicId | String | c7**** | 待投递日志所在的日志主题 ID。 |
| ProjectId | String | dc7**** | 待投递日志所在的日志项目 ID。 |
| ShipperId | String | 4a9bd4bd-53f1-43ff-b88a-64ee1be5**** | 投递配置 ID。 |
| TopicName | String | mytopic | 待投递日志所在的日志主题名称。 |
| CreateTime | String | 2024-08-01 14:01:02 | 投递配置的创建时间。 |
| ModifyTime | String | 2024-08-01 14:01:10 | 投递配置的最近修改时间。 |
| ContentInfo | Object of ContentInfo | / | 投递日志的内容格式配置。 |
| DashboardId | String | / | 投递的默认内置仪表盘 ID。 |
| ProjectName | String | myproject | 待投递日志所在的日志项目名称。 |
| ShipperName | String | tosship | 投递配置名称。 |
| ShipperType | String | tos | 投递类型。 |
| ShipperEndTime | Integer | 1723709712496 | 投递结束时间。 |
| TosShipperInfo | Object of TosShipperInfo | / | 投递到 TOS 的相关信息。 |
| KafkaShipperInfo | Object of KafkaShipperInfo | / | 投递到 Kafka 的相关信息。 |
| ShipperStartTime | Integer | 1723709602496 | 投递开始时间。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Format | String |
| 日志内容解析格式。
|
| CsvInfo | Object of CsvInfo | / | CSV 格式日志内容配置。 |
| JsonInfo | Object of JsonInfo | / | JSON 格式日志内容配置。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Bucket | String | mytos | 对象存储桶名称。 |
| Prefix | String | testprefix | 存储桶的顶级目录名称。通过此投递配置投递的所有日志数据均将被投递到该目录下。 |
| MaxSize | Integer | 5 | 每个分区（Shard）最大可投递的原始文件大小，即未压缩的日志文件大小。单位为 MiB。 |
| Compress | String | snappy | 压缩格式。 |
| Interval | Integer | 300 | 投递时间间隔，单位为秒。 |
| PartitionFormat | String | %Y/%m/%d/%H/%M | 投递日志的分区规则。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| EndTime | Integer | 1723709712496 | 投递结束时间，毫秒时间戳，如果不配置，则会一直投递。 |
| Compress | String | snappy | 压缩格式，当前支持 snappy、gzip、lz4、none。 |
| Instance | String | kafka-cnngbnntswg1**** | Kafka 实例。 |
| StartTime | Integer | 1723709602496 | 投递开始时间，毫秒时间戳，如果不配置，默认为当前时间。 |
| KafkaTopic | String | topic-c | Kafka Topic 名称。通过此投递配置投递的所有日志数据均将被投递到该 Topic 中。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Keys | Array of String |
| 配置需要投递的字段。
|
| Delimiter | String | , | 分隔符，支持填入逗号、制表符、竖线、分号、空格。 |
| EscapeChar | String | false | 转义符，字段内容包含分隔符时，使用转义符包裹该字段，当前仅支持单引号，双引号，空字符。 |
| PrintHeader | Boolean | false | 首行是否打印 Key。 |
| NonFieldContent | String | test | 无效字段填充内容，长度为 0~128。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| 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 | 是否转义。 |
GET https://tls-{Region}.ivolces.com/DescribeShippers?&ProjectId=f3e901c3-b17f-42fd-aa8c-dc91a6c7****&ProjectName=&IamProjectName=&PageNumber=10&PageSize=20&ShipperName=test&ShipperId=f3e901c3-b17f-42fd-aa8c-dc91a6c7****&TopicName=test&TopicId=f3e901c3-b17f-42fd-aa8c-dc91a6c7****&ShipperType=tos HTTP/1.1 Content-Type: application/json
{ "Shippers": [ { "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" }, { "ShipperId": "6e948fca-d3*****-b5cca0b29383", "ShipperName": "tosTimeTest", "ProjectId": "d11be542-3ba2******70-72c318262132", "ProjectName": "log-sy", "TopicId": "680284a6-8e88-4d*****1-d416a48c45ad", "TopicName": "import-task", "Status": true, "ShipperType": "tos", "TosShipperInfo": { "Bucket": "tos-import-logs", "Prefix": "timeTest", "PartitionFormat": "%Y", "MaxSize": 256, "Interval": 60, "Compress": "snappy" }, "ContentInfo": { "Format": "json", "CsvInfo": null, "JsonInfo": { "Enable": true, "Escape": false, "Keys": null } }, "ShipperStartTime": 1725012764000, "ShipperEndTime": 1723795560000, "CreateTime": "2024-08-16 16:06:39", "ModifyTime": "2024-08-30 18:12:44" } ], "Total": 2 }
您可访问公共错误码，获取更多错误码信息。