文档

ListDelivery - 展示接入威胁分析的日志投递状态

更新时间:

查看整个企业或者普通成员接入威胁分析的产品、日志列表,以及这些日志的数据投递情况。

调试

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

授权信息

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

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

请求参数

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

视图类型。

  • 0:当前阿里云账号视图。
  • 1:企业下所有账号的视图。
1
RoleForlong

管理员切换成其他成员视角的用户 ID。

113091674488****
RegionIdstring

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地与中国香港,选择该项。
  • ap-southeast-1:资产属于海外地域,选择该项。
cn-hangzhou

返回参数

名称类型描述示例值
object

BaseResponse

Dataobject

返回的详细内容。

ProjectNamestring

威胁分析用户侧日志服务 Project 名字,格式:aliyun-cloudsiem-data-${aliUid}-${region}。

aliyun-cloudsiem-data-127608589417****-cn-shanghai
LogStoreNamestring

威胁分析用户侧 LogStore 的名字,格式:cloud_siem。

cloud-siem
SearchUrlstring

日志分析页面中查询分析的 URL。

https://sls4service.console.aliyun.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai /logsearch/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true
DashboardUrlstring

日志分析页面中报表展示的 URL。

https://sls4service.console.aliyun.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai /dashboard/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true
DisplaySwitchOrNotboolean

是否展示投递开关,默认 true,取值:

  • true:显示投递开关
  • false:隐藏投递开关
true
ProductListobject []

产品列表。

ProductCodestring

云产品编码。取值:

  • qcloud_waf
  • qlcoud_cfw
  • hcloud_waf
  • hcloud_cfw
  • ddos
  • sas
  • cfw
  • config
  • csk
  • fc
  • rds
  • nas
  • apigateway
  • cdn
  • mongodb
  • eip
  • slb
  • vpc
  • actiontrail
  • waf
  • bastionhost
  • oss
  • polardb
sas
ProductNamestring

该参数已废弃,无需关注。

Security Center
LogMapobject

存在日志分类的日志列表,比如云安全中心,存在主机、网络等分组,分组信息为 key,分组所包含的日志为 value。

object []

分组包含的日志列表。

LogCodestring

日志编码。

cloud_siem_config_log
LogNamestring

该参数已废弃,无需关注。

audit log
LogNameEnstring

该参数已废弃,无需关注。

audit log
LogNameKeystring

日志语言编码,用于进行多语言名字的展示。

${sas.cloudsiem.prod.cloud_siem_aegis_crack_from_beaver}
Statusboolean

日志投递状态。取值:

  • true:正在投递
  • false:投递被关闭
true
CanOperateOrNotboolean

是否可以操作日志投递开关,日志投递开关只限于威胁分析委派管理员进行操作。取值:

  • true:可以操作
  • false:不可以操作
true
Topicstring

日志在 LogStore 中的 Topic,是 LogStore 的索引字段,通过该字段,能够区分不同的日志。

sas_login_event
ExtraParametersobject []

扩展参数。

Keystring

扩展参数标识。

flag
Valuestring

扩展参数值。

value
LogListobject []

没有更细分类的云产品。

LogCodestring

日志编码。

cloud_siem_config_log
LogNamestring

该参数已废弃,无需关注。

audit log
LogNameEnstring

该参数已废弃,无需关注。

audit log
LogNameKeystring

日志语言编码,用于进行多语言名字的展示。

${sas.cloudsiem.prod.cloud_siem_aegis_crack_from_beaver}
Statusboolean

日志投递状态。取值:

  • true:正在投递
  • false:投递被关闭
true
CanOperateOrNotboolean

是否可以操作日志投递开关,日志投递开关只限于威胁分析委派管理员进行操作。取值:

  • true:可以操作
  • false:不可以操作
true
Topicstring

日志在 LogStore 中的 Topic,是 LogStore 的索引字段,通过该字段,能够区分不同的日志。

sas_login_event
ExtraParametersobject []

扩展参数。

Keystring

扩展参数标识。

flag
Valuestring

扩展参数值。

value
RequestIdstring

请求消息 ID。

6276D891-58D4-55B2-87B9-74D413F7****

示例

正常返回示例

JSON格式

{
  "Data": {
    "ProjectName": "aliyun-cloudsiem-data-127608589417****-cn-shanghai",
    "LogStoreName": "cloud-siem",
    "SearchUrl": "https://sls4service.console.aliyun.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai\n/logsearch/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true",
    "DashboardUrl": "https://sls4service.console.aliyun.com/lognext/project/aliyun-cloudsiem-data-127608589417****-cn-shanghai\n/dashboard/cloud-siem?isShare=true&hideTopbar=true&hideSidebar=true&ignoreTabLocalStorage=true",
    "DisplaySwitchOrNot": true,
    "ProductList": [
      {
        "ProductCode": "sas",
        "ProductName": "Security Center",
        "LogMap": {
          "key": [
            {
              "LogCode": "cloud_siem_config_log",
              "LogName": "audit log",
              "LogNameEn": "audit log",
              "LogNameKey": "${sas.cloudsiem.prod.cloud_siem_aegis_crack_from_beaver}",
              "Status": true,
              "CanOperateOrNot": true,
              "Topic": "sas_login_event",
              "ExtraParameters": [
                {
                  "Key": "flag",
                  "Value": "value"
                }
              ]
            }
          ]
        },
        "LogList": [
          {
            "LogCode": "cloud_siem_config_log",
            "LogName": "audit log",
            "LogNameEn": "audit log\n",
            "LogNameKey": "${sas.cloudsiem.prod.cloud_siem_aegis_crack_from_beaver}",
            "Status": true,
            "CanOperateOrNot": true,
            "Topic": "sas_login_event",
            "ExtraParameters": [
              {
                "Key": "flag",
                "Value": "value"
              }
            ]
          }
        ]
      }
    ]
  },
  "RequestId": "6276D891-58D4-55B2-87B9-74D413F7****"
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.服务发生某些未知错误,请稍后再试
500SLS.Sls4Service.ErrorThe Simple Log Service about embedding console pages is unavailable.访问阿里云日志内嵌控制台服务不能访问。

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

变更历史

变更时间变更内容概要操作
2024-04-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:RoleType
    新增入参:RoleFor
2023-12-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 500 变更
    删除错误码:501
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)