GetSiteDeliveryTask - 获取投递任务的配置信息

更新时间:
复制 MD 格式

获取一个实时日志任务投递的相关信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

TaskName

string

任务名称。

cdn-test-task

SiteId

integer

站点 ID,可通过调用 ListSites 接口获取。

123456***

返回参数

名称

类型

描述

示例值

object

返回体参数。

RequestId

string

请求 ID。

34DCBC8A-****-****-****-6DAA11D7DDBD

TaskName

string

任务名称。

cdn-test-task

SiteName

string

站点名称。

test.***.com

SiteId

integer

站点 ID。

123456****

DiscardRate

number

丢弃率。

0.0

DataCenter

string

数据中心。取值为:枚举值:

  • cn :中国内地。

  • sg: 全球(不包含中国内地)。

cn

BusinessType

string

实时日志类型,取值:

  • dcdn_log_access_l1(默认值):访问日志。

  • dcdn_log_er:边缘函数日志。

  • dcdn_log_waf:安全防护日志。

  • dcdn_log_ipa:四层加速日志。

dcdn_log_access_l1

Status

string

任务状态

  • online:推送中。

  • offline:暂停推送。

online

DeliveryType

string

投递类型:

  • sls: 阿里云日志服务。

  • http:http 服务。

  • aws3: 亚马逊 s3 服务。

  • oss: 阿里云对象存储服务。

  • kafka: kafka 服务。

  • aws3cmpt: 亚马逊 s3 兼容服务。

sls

FieldList

string

投递字段列表。

Client,UserAgent

FilterRules

string

过滤规则。

[]

SinkConfig

any

投递配置。

{'Region': 'cn-hangzhou', 'Endpoint': 'https://***.oss-cn-hangzhou.aliyuncs.com', 'BucketPath': 'hjy-test002/online-logs'}

RawRule

string

投递任务过滤规则

说明

新版投递过滤规则

{ "where": { "or": [ { "and": [ { "key": "site", "operator": "eq", "value": "example.com" }, { "key": "status_code", "operator": "in", "value": ["200", "304"] } ] } ] } }

FilterVer

string

Filter 过滤规则版本

说明

兼容旧版本过滤规则,默认是 v1,新创建是 v2

v2

示例

正常返回示例

JSON格式

{
  "RequestId": "34DCBC8A-****-****-****-6DAA11D7DDBD",
  "TaskName": "cdn-test-task",
  "SiteName": "test.***.com",
  "SiteId": 0,
  "DiscardRate": 0,
  "DataCenter": "cn",
  "BusinessType": "dcdn_log_access_l1",
  "Status": "online",
  "DeliveryType": "sls",
  "FieldList": "Client,UserAgent",
  "FilterRules": "[]",
  "SinkConfig": "{'Region': 'cn-hangzhou', 'Endpoint': 'https://***.oss-cn-hangzhou.aliyuncs.com', 'BucketPath': 'hjy-test002/online-logs'}",
  "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"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter The specified parameter is invalid. 输入参数规范校验失败。
400 InternalError An internal exception occurred, please try again later. 触发内部异常,请稍后再试。

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

变更历史

更多信息,参考变更详情