第 41 章 NotifierService
41.1. GetNotifiers
GET /v1/notifiers
GetNotifiers 返回所有通知程序配置。
41.1.1. 描述
41.1.2. 参数
41.1.3. 返回类型
41.1.4. 内容类型
- application/json
41.1.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
41.1.6. Samples
41.1.7. 常规对象参考
41.1.7.1. EmailAuthMethod
Enum 值 |
---|
DISABLED |
PLAIN |
LOGIN |
41.1.7.2. JiraPriorityMapping
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
priorityName | 字符串 |
41.1.7.3. ProtobufAny
any
包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 C++ 中解包信息。
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
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()); }
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.
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...
Example 4: Pack and unpack a message in Go
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 { ... }
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/x/y.z"。
41.1.7.3.1. JSON 表示
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type
。Example:
package google.profile; message Person { string first_name = 1; string last_name = 2; }
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{ "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> }
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
如果嵌入式消息类型是知名且具有自定义 JSON 表示法,则该表示将被嵌入一个字段值,该值
除 @type
字段外还包含自定义 JSON。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
typeUrl | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 | |||
value | byte[] | 必须是上述指定类型的有效序列化协议缓冲。 | BYTE |
41.1.7.4. RuntimeError
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
错误 | 字符串 | ||||
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
41.1.7.5. StorageAWSSecurityHub
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
region | 字符串 | ||||
credentials | |||||
accountId | 字符串 |
41.1.7.6. StorageAWSSecurityHubCredentials
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
accessKeyId | 字符串 | ||||
secretAccessKey | 字符串 | ||||
stsEnabled | 布尔值 |
41.1.7.7. StorageCSCC
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
serviceAccount | 字符串 | 集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。 | |||
sourceId | 字符串 | ||||
wifEnabled | 布尔值 |
41.1.7.8. StorageEmail
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
server | 字符串 | ||||
sender | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
disableTLS | 布尔值 | ||||
DEPRECATEDUseStartTLS | 布尔值 | ||||
from | 字符串 | ||||
startTLSAuthMethod | DISABLED, PLAIN, LOGIN, | ||||
allowUnauthenticatedSmtp | 布尔值 |
41.1.7.9. StorageGeneric
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
端点 | 字符串 | ||||
skipTLSVerify | 布尔值 | ||||
caCert | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
标头 | |||||
extraFields | |||||
auditLoggingEnabled | 布尔值 |
41.1.7.10. StorageJira
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
url | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
issueType | 字符串 | ||||
priorityMappings | |||||
defaultFieldsJson | 字符串 | ||||
disablePriority | 布尔值 |
41.1.7.11. StorageKeyValuePair
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
41.1.7.12. StorageNotifier
Next Tag: 19
Next Tag: 19
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
名称 | 字符串 | ||||
type | 字符串 | ||||
uiEndpoint | 字符串 | ||||
labelKey | 字符串 | ||||
labelDefault | 字符串 | ||||
jira | |||||
| |||||
cscc | |||||
splunk | |||||
PagerDuty | |||||
generic | |||||
Sumologic | |||||
awsSecurityHub | |||||
syslog | |||||
notifierSecret | 字符串 | ||||
遍历 |
41.1.7.13. StoragePagerDuty
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
apiKey | 字符串 | 集成的 API 密钥。服务器将在响应和日志中屏蔽此凭据的值。 |
41.1.7.14. StorageSeverity
Enum 值 |
---|
UNSET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
41.1.7.15. StorageSplunk
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpToken | 字符串 | 集成的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。 | |||
httpEndpoint | 字符串 | ||||
insecure | 布尔值 | ||||
truncate | 字符串 | int64 | |||
auditLoggingEnabled | 布尔值 | ||||
derivedSourceType | 布尔值 | ||||
sourceTypes |
|
41.1.7.16. StorageSumoLogic
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpSourceAddress | 字符串 | ||||
skipTLSVerify | 布尔值 |
41.1.7.17. StorageSyslog
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
localFacility | LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7. | ||||
tcpConfig | |||||
extraFields | |||||
messageFormat | 传统、CEF、 |
41.1.7.18. StorageTraits
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
可见性 | 可见、隐藏、 | ||||
origin | IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
41.1.7.19. SyslogLocalFacility
Enum 值 |
---|
LOCAL0 |
LOCAL1 |
LOCAL2 |
LOCAL3 |
LOCAL4 |
LOCAL5 |
LOCAL6 |
LOCAL7 |
41.1.7.20. SyslogMessageFormat
Enum 值 |
---|
LEGACY |
CEF |
41.1.7.21. SyslogTCPConfig
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
hostname | 字符串 | ||||
port | 整数 | int32 | |||
skipTlsVerify | 布尔值 | ||||
useTls | 布尔值 |
41.1.7.22. TraitsMutabilityMode
实验性。注意:请参考在时间使用 MutabilityMode 时。它将在以后被替换(ROX-14276)。MutabilityMode 指定是否以及如何修改对象。默认为 ALLOW_MUTATE,意味着没有修改限制,这等同于没有 MutabilityMode 规格。ALLOW_MUTATE_FORCED forbids 所有修改操作,除了删除强制位的对象。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但会禁止以后更改它,包括将其修改回 ALLOW_MUTATE。
Enum 值 |
---|
ALLOW_MUTATE |
ALLOW_MUTATE_FORCED |
41.1.7.23. TraitsOrigin
origin 指定对象的起源。对象可以有四个不同的来源: - IMPERATIVE:对象是通过 API 创建的。默认情况下会假设这个对象。- DEFAULT:对象是默认对象,如默认角色、访问范围等。- DECLARATIVE:对象通过声明性配置创建。- DECLARATIVE_ORPHANED:对象通过声明性配置创建,然后成功删除(例如,它被声明配置引用)创建。- DECLARATIVE_ORPHANED:对象通过声明性配置创建,然后取消删除(例如,它被另一个对象引用),它基于原始对象,应用到对象。不允许使用 DECLARATIVE 原始对象通过 API 修改,只能通过声明性配置进行修改。另外,它们可能无法引用带有 IMPERATIVE 原始卷的对象。不允许使用 DEFAULT origin 的对象通过 API 或声明性配置进行修改。它们可以被所有其他对象引用。允许通过 API 修改具有 IMPERATIVE 来源的对象,而不是通过声明性配置进行修改。它们可能会引用所有其他对象。不允许使用 DECLARATIVE_ORPHANED 原始对象通过 API 或声明性配置进行修改。如果资源在声明配置中重新定义,则 DECLARATIVE_ORPHANED 资源可能会再次变为 DECLARATIVE。使用此源的对象将在不再被其他资源引用后立即从系统中清理。它们可以被所有其他对象引用。
Enum 值 |
---|
IMPERATIVE |
DEFAULT |
DECLARATIVE |
DECLARATIVE_ORPHANED |
41.1.7.24. TraitsVisibility
EXPERIMENTAL. visibility 允许指定对象是否应该对某些 API 可见。
Enum 值 |
---|
VISIBLE |
HIDDEN |
41.1.7.25. V1GetNotifiersResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
通知程序 |