使用GetUserDeliveryTask查询用户任务投递的配置与状态-边缘安全加速-阿里云-边缘安全加速(ESA)-阿里云帮助中心

查询指定用户的任务投递配置及状态信息。

接口说明

功能：此接口用于获取指定阿里云用户下某个任务的详细投递信息，包括任务名、丢弃率、区域、业务类型、状态、投递类型及配置、过滤规则等。
使用场景：在分析处理效率或排查问题时，需要详细了解或检查特定任务的日志处理与投递配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
esa:GetUserDeliveryTask	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
TaskName	string	是	任务名。	test_project

返回参数

名称	类型	描述	示例值
	object	返回体参数。
RequestId	string	请求 ID。	7072132a-bd3c-46a6-9e81-aba3e0e3f861
TaskName	string	任务名。	testoss11
DiscardRate	float	丢弃率。	0
DataCenter	string	数据中心。取值为： cn ：中国内地 sg：全球（不包含中国内地）	cn
BusinessType	string	业务类型，取值： dcdn_log_access_l1（默认值）：访问日志。 dcdn_log_er：边缘函数日志。 dcdn_log_waf：安全防护日志。 dcdn_log_ipa：四层加速日志。	dcdn_log_er
Status	string	任务状态。	online
DeliveryType	string	投递类型： sls：阿里云日志服务 http： http 服务 aws3：亚马逊 s3 服务 oss：阿里云对象存储服务 kafka： kafka 服务 aws3cmpt：亚马逊 s3 兼容服务	oss
FieldList	string	字段数组。	ClientRequestID,ClientRequestHost
FilterRules	string	过滤规则。	[{"ClientSSLProtocol": {"equals": ["TLSv1.3"]}}]
SinkConfig	any	投递配置。	{'Project': 'er-online-hjy-pro', 'Logstore': 'er-online-hjy-log', 'Region': 'cn-hangzhou', 'Endpoint': 'cn-hangzhou.log.aliyuncs.com', 'Aliuid': '1077912128805410'}

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is invalid.	输入参数规范校验失败。
400	InternalError	An internal exception occurred, please try again later.	触发内部异常，请稍后再试。
403	EsaService.NotOpen	ESA service has not opend.	边缘安全加速服务(ESA)未开通

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-12-26	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-10-18	OpenAPI 错误码发生变更	查看变更详情
2024-09-27	OpenAPI 错误码发生变更	查看变更详情