×

POST /v1/notifiers

PostNotifier 创建通知器配置。

描述

参数

请求体参数

名称 描述 必填 默认值 模式

请求体

StorageNotifier

返回类型

内容类型

  • application/json

响应

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

200

成功的响应。

StorageNotifier

0

意外的错误响应。

GooglerpcStatus

示例

公共对象引用

EmailAuthMethod

枚举值

DISABLED

PLAIN

LOGIN

GooglerpcStatus

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

代码

整数

int32

消息

字符串

详情

ProtobufAny 列表

JiraPriorityMapping

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

严重性

StorageSeverity

UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,

优先级名称

字符串

MicrosoftSentinelClientCertAuthConfig

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

客户端证书

字符串

PEM编码的ASN.1 DER格式。

私钥

字符串

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

MicrosoftSentinelDataCollectionRuleConfig

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

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

流名称

字符串

数据收集规则ID

字符串

启用

布尔值

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表示,则该表示将被嵌入,并添加一个字段value,该字段除了@type字段外还包含自定义JSON。示例(对于消息[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

SumoLogic

StorageSumoLogic

AWS Security Hub

StorageAWSSecurityHub

Syslog

StorageSyslog

Microsoft Sentinel

StorageMicrosoftSentinel

通知程序密钥

字符串

特性

StorageTraits

StoragePagerDuty

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

API密钥

字符串

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

StorageSeverity

枚举值

UNSET_SEVERITY

LOW_SEVERITY

MEDIUM_SEVERITY

HIGH_SEVERITY

CRITICAL_SEVERITY

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

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

主机名 (hostname)

字符串

端口 (port)

整数

int32

跳过TLS验证 (skipTlsVerify)

布尔值

使用TLS (useTls)

布尔值

特性可变性模式 (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):对象是通过声明式配置创建的,然后未能成功删除(例如,因为它被另一个对象引用)。根据来源,不同的规则适用于不同的对象。具有声明式 (DECLARATIVE) 来源的对象不允许通过API修改,只能通过声明式配置修改。此外,它们可能不会引用具有命令式 (IMPERATIVE) 来源的对象。具有默认 (DEFAULT) 来源的对象不允许通过API或声明式配置修改。它们可以被所有其他对象引用。具有命令式 (IMPERATIVE) 来源的对象允许通过API修改,不允许通过声明式配置修改。它们可以引用所有其他对象。具有声明式孤立 (DECLARATIVE_ORPHANED) 来源的对象不允许通过API或声明式配置修改。如果在声明式配置中重新定义,DECLARATIVE_ORPHANED资源可以再次变为DECLARATIVE。此来源的对象在不再被其他资源引用后将立即从系统中清除。它们可以被所有其他对象引用。

枚举值

命令式 (IMPERATIVE)

默认 (DEFAULT)

声明式 (DECLARATIVE)

声明式孤立 (DECLARATIVE_ORPHANED)

特性可见性 (TraitsVisibility)

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

枚举值

可见 (VISIBLE)

隐藏 (HIDDEN)