Call the DescribeShipper API to get detailed information about the delivery configuration.

Request instructions

Request parameters

The following table lists the parameters specific to this API and some common parameters. For more information, see Common parameters.

Query

Parameter	Type	Required	Example value	Description
ShipperId	String	Yes	f3e901c3-b17f-42fd-aa8c-dc91a6c7****	ID of the delivery configuration to query.

Response parameters

The following table lists only the return parameters specific to this API. For more information, see Return Structure.

Parameter	Type	Example value	Description
ContentInfo	Object of ContentInfo	/	Configure the format for log delivery content.
CreateTime	String	2024-09-01 14:01:02	Time for creating the delivery configuration
DashboardId	String	/	Default built-in dashboard ID for delivery.
KafkaShipperInfo	Object of KafkaShipperInfo	/	Information related to delivery to Kafka.
ModifyTime	String	2024-09-01 14:01:10	Last modified time of the delivery configuration.
ProjectId	String	myproject	The ID of the project containing the logs to be delivered.
ProjectName	String	myproject	The name of the project where the pending delivery logs are stored
RoleTrn	String	trn:iam::2100000001:role/TLSETLAccessForUserA	Custom role Trn.
ShipperEndTime	Integer	1723709712496	Delivery end time.
ShipperId	String	4a9bd4bd-53f1-43ff-b88a-64ee1be5****	Delivery configuration ID.
ShipperName	String	tosship	Delivery configuration name.
ShipperStartTime	Integer	1723709602496	Delivery start time.
ShipperType	String	tos	Delivery type.
Status	Boolean	true	Enable delivery configuration.
TopicId	String	c7****	ID of the log topic containing logs to deliver.
TopicName	String	mytopic	Name of the log topic where pending logs are stored.
TosShipperInfo	Object of TosShipperInfo	/	Information delivered to TOS.

ContentInfo

Parameter	Type	Example value	Description
Format	String	json	Log content parsing format. When delivering to TOS, you can configure it as json, josnl or csv. When delivering to Kafka, you can configure it as original or json.
CsvInfo	Object of CsvInfo	/	CSV format log content configuration.
JsonInfo	Object of JsonInfo	/	JSON/JSONL format log content configuration.

KafkaShipperInfo

Parameter	Type	Example value	Description
EndTime	Integer	1723709712496	Delivery end time in milliseconds. If not set, delivery will continue indefinitely. tip When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to set the delivery time range, and leave the StartTime and EndTime fields blank.
Compress	String	snappy	Compression formats. Currently supports snappy, gzip, lz4, and none.
Instance	String	kafka-cnngbnntswg1****	Kafka instance.
StartTime	Integer	1723709602496	Delivery start time in milliseconds. If not set, the default is the current time. tip When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to specify the delivery time range, and leave the StartTime and EndTime fields empty.
KafkaTopic	String	topic-c	Kafka Topic name. All log data delivered through this configuration will be sent to the specified Topic.

TosShipperInfo

Parameter	Type	Example value	Description
Bucket	String	mytos	Name of the object storage bucket.
Prefix	String	testprefix	Top-level directory name for the storage bucket. All log data delivered using this delivery configuration will be placed in this directory.
MaxSize	Integer	5	The maximum size of the original file that can be delivered per shard is the uncompressed log file size. The unit is MiB.
Compress	String	snappy	Compressed format.
Interval	Integer	300	Delivery interval in seconds.
PartitionFormat	String	%Y/%m/%d/%H/%M	Shard rules for delivering logs.

CsvInfo

Parameter	Type	Example value	Description
Keys	Array of String	["user","log","ip"]	Configure the fields to be delivered. Only letters, numbers, and _-./ are supported._Cannot start with. Within the same index, the key name must be unique. Length must be between 1 and 128 characters.
Delimiter	String	,	Separator: Supports comma, tab, vertical bar, semicolon, and space.
EscapeChar	String	false	Escape character: When a field contains a separator, use escape characters to enclose the field. Currently, only single quotes, double quotes, and blank characters are supported.
PrintHeader	Boolean	false	Print the Key in the first line.
NonFieldContent	String	test	Content for invalid field; length must be between 0 and 128 characters.

JsonInfo

Parameter	Type	Example value	Description
Keys	Array of String	["__content", "__pod_name__"]	When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including __content__ (required), __source__, __path__, __time__, __image_name__, __container_name__, __pod_name__, __pod_uid__, namespace, __tag____client_ip__, and __tag____receive_time__.
Enable	Boolean	true	Enable flag.
Escape	Boolean	true	Escape content Must be set to true.

Sample request

Sample response

Error Code

You can visit Public Error Codes for more information about error codes.