GetUserDeliveryTask - Query log delivery task details | ESA API - Edge Security Acceleration

Queries the delivery configuration and status information of a specified task for a user.

Operation description

Features: This operation retrieves the detailed delivery information of a specified task under an Alibaba Cloud account, including the task name, discard rate, region, business type, status, delivery type and configuration, and filter rules.
Scenarios: Use this operation when you need to understand or check the log processing and delivery configuration of a specific task for analyzing processing efficiency or troubleshooting issues.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
TaskName	string	Yes	The task name.	test_project

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7072132a-bd3c-46a6-9e81-aba3e0e3f861
TaskName	string	The task name.	testoss11
DiscardRate	number	The discard rate.	0
DataCenter	string	The data center. Valid values: cn: the Chinese mainland. sg: global (excluding the Chinese mainland).	cn
BusinessType	string	The business type. Valid values: dcdn_log_access_l1 (default): access logs. dcdn_log_er: Edge Routine function logs. dcdn_log_waf: security protection logs. dcdn_log_ipa: Layer 4 acceleration logs.	dcdn_log_er
Status	string	The task status.	online
DeliveryType	string	The delivery type. Valid values: sls: Alibaba Cloud Simple Log Service. http: HTTP service. aws3: Amazon S3 service. oss: Alibaba Cloud Object Storage Service. kafka: Kafka service. aws3cmpt: Amazon S3-compatible service.	oss
FieldList	string	The field array.	ClientRequestID,ClientRequestHost
FilterRules	string	The filter rules.	[{"ClientSSLProtocol": {"equals": ["TLSv1.3"]}}]
SinkConfig	any	The delivery configuration.	{'Project': 'er-online-hjy-pro', 'Logstore': 'er-online-hjy-log', 'Region': 'cn-hangzhou', 'Endpoint': 'cn-hangzhou.log.aliyuncs.com', 'Aliuid': '1077912128805410'}
Details	string	The list of Edge Routine PODs.	xxx,xxx
RawRule	string	The filter rules for the delivery task. Note New version of delivery filter rules.	{ "where": { "or": [ { "and": [ { "key": "site", "operator": "eq", "value": "example.com" }, { "key": "status_code", "operator": "in", "value": ["200", "304"] } ] } ] } }
FilterVer	string	The version of the filter rules. Note For backward compatibility with legacy filter rules, the default value is v1. Newly created rules use v2.	v2

Examples

Success response

JSON format

{
  "RequestId": "7072132a-bd3c-46a6-9e81-aba3e0e3f861",
  "TaskName": "testoss11",
  "DiscardRate": 0,
  "DataCenter": "cn",
  "BusinessType": "dcdn_log_er",
  "Status": "online",
  "DeliveryType": "oss",
  "FieldList": "ClientRequestID,ClientRequestHost",
  "FilterRules": "[{\"ClientSSLProtocol\": {\"equals\": [\"TLSv1.3\"]}}]",
  "SinkConfig": "{'Project': 'er-online-hjy-pro', 'Logstore': 'er-online-hjy-log', 'Region': 'cn-hangzhou', 'Endpoint': 'cn-hangzhou.log.aliyuncs.com', 'Aliuid': '1077912128805410'}",
  "Details": "xxx,xxx",
  "RawRule": "{\n  \"where\": {\n    \"or\": [\n      {\n        \"and\": [\n          { \"key\": \"site\", \"operator\": \"eq\", \"value\": \"example.com\" },\n          { \"key\": \"status_code\", \"operator\": \"in\", \"value\": [\"200\", \"304\"] }\n        ]\n      }\n    ]\n  }\n}",
  "FilterVer": "v2"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalError	An internal exception occurred, please try again later.	An inner exception was triggered. Please try again later.
403	EsaService.NotOpen	ESA service has not opend.	Edge Security Accelerator (ESA) is not turned on

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.