All Products
Search

This Product

    Edge Security Acceleration:GetUserDeliveryTask

    Document Center

    Edge Security Acceleration:GetUserDeliveryTask

    Last Updated:Jun 25, 2026

    Queries the delivery configuration and status of a specified task.

    Operation description

    • Function: Retrieves detailed delivery information for a specified task, including the task name, discard rate, region, business type, status, delivery type, delivery configuration, and filter rules.

    • Use case: Review the log processing and delivery configuration for a specific task to analyze processing efficiency or troubleshoot 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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    esa:GetUserDeliveryTask

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TaskName

    string

    Yes

    The task name.

    test_project

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    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: Chinese mainland

    • sg: Global (excluding the Chinese mainland)

    cn
    BusinessType

    string

    The business type. Valid values:

    • dcdn_log_access_l1 (default): access log.

    • dcdn_log_er: edge function log.

    • dcdn_log_waf: WAF log.

    • dcdn_log_ipa: Layer 4 acceleration log.

    dcdn_log_er
    Status

    string

    The task status.

    online
    DeliveryType

    string

    The delivery type. Valid values:

    • sls: Log Service

    • http: HTTP service

    • aws3: Amazon S3

    • oss: OSS

    • kafka: Kafka service

    • aws3cmpt: Amazon S3-compatible service

    oss
    FieldList

    string

    A comma-separated list of fields.

    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

    RawRule

    string

    FilterVer

    string

    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": "",
  "RawRule": "",
  "FilterVer": ""
}

    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.