GetUserDeliveryTask - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the information about a log delivery task by account.

Operation description

This API operation queries the details of a delivery task, including the task name, discard rate, region, log category, status, delivery destination, configuration, and filtering rules.****
You can call this operation to query detailed information about a log delivery task to analyze log processing efficiency or troubleshoot delivery problems.****
****````

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:GetUserDeliveryTask	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7072132a-bd3c-46a6-9e81-aba3e0e3f861
TaskName	string	The name of the delivery task.	testoss11
DiscardRate	float	The discard rate.	0
DataCenter	string	The data center. Valid values: cn: the Chinese mainland. sg: outside the Chinese mainland.	cn
BusinessType	string	The log category. Valid values: dcdn_log_access_l1 (default): access logs. dcdn_log_er: Edge Routine logs. dcdn_log_waf: firewall logs. dcdn_log_ipa: TCP/UDP proxy logs.	dcdn_log_er
Status	string	The status of the delivery task.	online
DeliveryType	string	The destination of the delivery. Valid values: sls: Alibaba Cloud Simple Log Service (SLS). http: HTTP server. aws3: Amazon Simple Storage Service (S3). oss: Alibaba Cloud Object Storage Service (OSS). kafka: Kafka. aws3cmpt: S3-compatible storage service.	oss
FieldList	string	The fields.	ClientRequestID,ClientRequestHost
FilterRules	string	The filtering 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'}

Examples

Sample success responses

JSONformat

{
  "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'}"
}

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-12-26	The Error code has changed. The response structure of the API has changed	View Change Details
2024-10-18	The Error code has changed	View Change Details
2024-09-27	The Error code has changed	View Change Details