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

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
esa:GetSiteDeliveryTasknone
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

请求参数

名称类型必填描述示例值
TaskNamestring

任务名称。

cdn-test-task
SiteIdlong

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

123456***

返回参数

名称类型描述示例值
object

返回体参数。

RequestIdstring

请求 ID。

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

任务名称。

cdn-test-task
SiteNamestring

站点名称。

test.***.com
SiteIdlong

站点 ID。

123456****
DiscardRatefloat

丢弃率。

0.0
DataCenterstring

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

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

实时日志类型,取值:

  • dcdn_log_access_l1(默认值):访问日志。
  • dcdn_log_er:边缘函数日志。
  • dcdn_log_waf:安全防护日志。
  • dcdn_log_ipa:四层加速日志。
dcdn_log_access_l1
Statusstring

任务状态

  • online:推送中。

  • offline:暂停推送。

online
DeliveryTypestring

投递类型:

  • sls: 阿里云日志服务。
  • http:http 服务。
  • aws3: 亚马逊 s3 服务。
  • oss: 阿里云对象存储服务。
  • kafka: kafka 服务。
  • aws3cmpt: 亚马逊 s3 兼容服务。
sls
FieldListstring

投递字段列表。

Client,UserAgent
FilterRulesstring

过滤规则。

[]
SinkConfigany

投递配置。

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

示例

正常返回示例

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

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.输入参数规范校验失败。
400InternalErrorAn internal exception occurred, please try again later.触发内部异常,请稍后再试。

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

变更历史

变更时间变更内容概要操作
2024-09-27OpenAPI 错误码发生变更查看变更详情