×

GET /v1/notifiers

GetNotifiers 返回所有通知器配置。

描述

参数

返回类型

内容类型

  • application/json

响应

表 1. HTTP 响应代码
代码 消息 数据类型

200

成功的响应。

V1GetNotifiersResponse

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

EmailAuthMethod

枚举值

DISABLED

PLAIN

LOGIN

GooglerpcStatus

字段名称 必填 可空 类型 描述 格式

code

整数

int32

message

字符串

details

ProtobufAny 列表

JiraPriorityMapping

字段名称 必填 可空 类型 描述 格式

severity

StorageSeverity

UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,

priorityName

字符串

MicrosoftSentinelClientCertAuthConfig

client certificate which is used for authentication
字段名称 必填 可空 类型 描述 格式

clientCert

字符串

PEM 编码的 ASN.1 DER 格式。

privateKey

字符串

PEM 编码的 PKCS #8,ASN.1 DER 格式。

MicrosoftSentinelDataCollectionRuleConfig

DataCollectionRuleConfig 包含有关数据收集规则的信息,这是每个通知器类型的配置。

字段名称 必填 可空 类型 描述 格式

streamName

字符串

dataCollectionRuleId

字符串

enabled

布尔值

ProtobufAny

Any 包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 URL。

Protobuf 库提供支持,可以以实用函数或 Any 类型的附加生成方法的形式打包/解包 Any 值。

示例 1:在 C++ 中打包和解包消息。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例 2:在 Java 中打包和解包消息。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

protobuf 库提供的打包方法默认使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法仅使用类型 URL 中最后一个 '/' 后面的全限定类型名称,例如 "foo.bar.com/x/y.z" 将产生类型名称 "y.z"。

JSON 表示

Any 值的 JSON 表示使用反序列化的嵌入消息的常规表示,并添加一个包含类型 URL 的附加字段 @type。示例

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

如果嵌入的消息类型是众所周知的并且具有自定义 JSON 表示,则该表示将被嵌入,除了 @type 字段外,还会添加一个包含自定义 JSON 的 value 字段。示例(对于消息 [google.protobuf.Duration][])

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
字段名称 必填 可空 类型 描述 格式

@type

字符串

唯一标识序列化协议缓冲区消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一个段必须表示类型的全限定名称(如 path/google.protobuf.Duration)。名称应采用规范形式(例如,不接受前导“.”)。实际上,团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是,对于使用方案 httphttps 或无方案的 URL,可以选择设置一个类型服务器,该服务器将类型 URL 映射到消息定义,如下所示:* 如果未提供方案,则假定为 https。* 对 URL 的 HTTP GET 必须产生二进制格式的 [google.protobuf.Type][] 值,或产生错误。* 应用程序可以根据 URL 缓存查找结果,或将其预编译到二进制文件中以避免任何查找。因此,需要在类型更改时保留二进制兼容性。(使用版本化的类型名称来管理重大更改。)注意:此功能目前在官方 protobuf 版本中不可用,并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月,没有广泛使用的类型服务器实现,也没有计划实现一个。可以使用具有特定于实现的语义的httphttps(或空方案)以外的方案。

StorageAWSSecurityHub

字段名称 必填 可空 类型 描述 格式

区域

字符串

凭据

StorageAWSSecurityHubCredentials

账户ID

字符串

StorageAWSSecurityHubCredentials

字段名称 必填 可空 类型 描述 格式

访问密钥 ID

字符串

密钥访问密钥

字符串

启用 STS

布尔值

StorageCSCC

字段名称 必填 可空 类型 描述 格式

服务账户

字符串

集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。

源 ID

字符串

启用 WIF

布尔值

StorageEmail

字段名称 必填 可空 类型 描述 格式

服务器

字符串

发件人

字符串

用户名

字符串

密码

字符串

集成的密码。服务器将在响应和日志中屏蔽此凭据的值。

禁用 TLS

布尔值

已弃用,请使用 StartTLS

布尔值

来自

字符串

StartTLS 身份验证方法

EmailAuthMethod

DISABLED、PLAIN、LOGIN、

允许未经身份验证的 SMTP

布尔值

StorageGeneric

字段名称 必填 可空 类型 描述 格式

端点

字符串

跳过 TLS 验证

布尔值

CA 证书

字符串

用户名

字符串

密码

字符串

集成的密码。服务器将在响应和日志中屏蔽此凭据的值。

StorageKeyValuePair 列表

额外字段

StorageKeyValuePair 列表

启用审计日志记录

布尔值

StorageJira

字段名称 必填 可空 类型 描述 格式

URL

字符串

用户名

字符串

密码

字符串

集成的密码。服务器将在响应和日志中屏蔽此凭据的值。

问题类型

字符串

优先级映射

JiraPriorityMapping 列表

默认字段 JSON

字符串

禁用优先级

布尔值

StorageKeyValuePair

字段名称 必填 可空 类型 描述 格式

字符串

字符串

StorageMicrosoftSentinel

字段名称 必填 可空 类型 描述 格式

日志摄取端点

字符串

log_ingestion_endpoint 是日志摄取端点。

目录租户 ID

字符串

directory_tenant_id 包含所选租户的 Microsoft 目录 ID。

应用程序客户端 ID

字符串

application_client_id 包含服务主体的应用程序 ID。

密钥

字符串

secret 包含客户端密钥。

警报 DCR 配置

MicrosoftSentinelDataCollectionRuleConfig

审计日志 DCR 配置

MicrosoftSentinelDataCollectionRuleConfig

客户端证书身份验证配置

MicrosoftSentinelClientCertAuthConfig

StorageNotifier

Next Tag: 21
字段名称 必填 可空 类型 描述 格式

ID

字符串

名称

字符串

类型

字符串

UI 端点

字符串

标签键

字符串

默认标签

字符串

Jira

StorageJira

邮件

StorageEmail

CSCC

StorageCSCC

Splunk

StorageSplunk

PagerDuty

StoragePagerDuty

通用

StorageGeneric

Sumo Logic

StorageSumoLogic

AWS Security Hub

StorageAWSSecurityHub

Syslog

StorageSyslog

Microsoft Sentinel

StorageMicrosoftSentinel

通知程序密钥

字符串

特征

StorageTraits

StoragePagerDuty

字段名称 必填 可空 类型 描述 格式

API 密钥

字符串

集成的 API 密钥。服务器将在响应和日志中屏蔽此凭据的值。

StorageSeverity

枚举值

未设置严重性

低严重性

中严重性

高严重性

严重性

StorageSplunk

字段名称 必填 可空 类型 描述 格式

HTTP 令牌

字符串

集成的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。

HTTP 端点

字符串

不安全

布尔值

截断

字符串

int64

启用审计日志记录

布尔值

派生源类型

布尔值

源类型

string 映射

StorageSumoLogic

字段名称 必填 可空 类型 描述 格式

HTTP 源地址

字符串

跳过 TLS 验证

布尔值

StorageSyslog

字段名称 必填 可空 类型 描述 格式

本地设备

SyslogLocalFacility

LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7、

TCP 配置

SyslogTCPConfig

额外字段

StorageKeyValuePair 列表

消息格式

SyslogMessageFormat

LEGACY、CEF、

StorageTraits

字段名称 必填 可空 类型 描述 格式

可变性模式

TraitsMutabilityMode

ALLOW_MUTATE、ALLOW_MUTATE_FORCED、

可见性

TraitsVisibility

VISIBLE、HIDDEN、

来源

TraitsOrigin

IMPERATIVE、DEFAULT、DECLARATIVE、DECLARATIVE_ORPHANED、

SyslogLocalFacility

枚举值

LOCAL0

LOCAL1

LOCAL2

LOCAL3

LOCAL4

LOCAL5

LOCAL6

LOCAL7

SyslogMessageFormat

枚举值

LEGACY

CEF

SyslogTCPConfig

字段名称 必填 可空 类型 描述 格式

主机名

字符串

端口

整数

int32

跳过 TLS 验证

布尔值

使用 TLS

布尔值

TraitsMutabilityMode

实验性功能。注意:目前请避免使用 MutabilityMode。未来它将被替换 (ROX-14276)。MutabilityMode 指定对象是否以及如何被修改。默认值为 ALLOW_MUTATE,表示没有修改限制;这等同于未指定 MutabilityMode。ALLOW_MUTATE_FORCED 禁止所有修改操作,除非强制删除对象。

更改此字段的状态时请谨慎。例如,允许将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但这将禁止对其进行任何进一步更改,包括将其改回 ALLOW_MUTATE。

枚举值

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

TraitsOrigin

Origin 指定对象的来源。对象可以有四种不同的来源:- IMPERATIVE:对象是通过 API 创建的。这是默认假设。- DEFAULT:对象是默认对象,例如默认角色、访问范围等。- DECLARATIVE:对象是通过声明式配置创建的。- DECLARATIVE_ORPHANED:对象是通过声明式配置创建的,然后未能成功删除(例如,因为它被另一个对象引用)。基于来源,不同的规则适用于不同的对象。不允许通过 API 修改具有 DECLARATIVE 来源的对象,只能通过声明式配置修改。此外,它们可能不会引用具有 IMPERATIVE 来源的对象。不允许通过 API 或声明式配置修改具有 DEFAULT 来源的对象。它们可以被所有其他对象引用。允许通过 API 修改具有 IMPERATIVE 来源的对象,但不能通过声明式配置修改。它们可以引用所有其他对象。不允许通过 API 或声明式配置修改具有 DECLARATIVE_ORPHANED 来源的对象。如果在声明式配置中重新定义,DECLARATIVE_ORPHANED 资源可以再次变为 DECLARATIVE。这些来源的对象在不再被其他资源引用后将立即从系统中清除。它们可以被所有其他对象引用。

枚举值

IMPERATIVE

DEFAULT

DECLARATIVE

DECLARATIVE_ORPHANED

TraitsVisibility

实验性功能。visibility 允许指定对象是否应该对某些 API 可见。

枚举值

VISIBLE

HIDDEN

V1GetNotifiersResponse

字段名称 必填 可空 类型 描述 格式

notifiers

StorageNotifier 列表