1.41. NotifierService
1.41.1. GetNotifiers
GET /v1/notifiers
GetNotifiers 返回所有通知程序配置。
1.41.1.1. 描述
1.41.1.2. 参数
1.41.1.3. 返回类型
1.41.1.4. 内容类型
- application/json
1.41.1.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.41.1.6. Samples
1.41.1.7. 常规对象参考
1.41.1.7.1. EmailAuthMethod
Enum 值 |
---|
DISABLED |
PLAIN |
LOGIN |
1.41.1.7.2. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.41.1.7.3. JiraPriorityMapping
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
priorityName | 字符串 |
1.41.1.7.4. MicrosoftSentinelClientCertAuthConfig
client certificate which is used for authentication
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
clientCert | 字符串 | PEM 编码的 ASN.1 DER 格式。 | |||
privateKey | 字符串 | PEM 编码的 PKCS #8, ASN.1 DER 格式。 |
1.41.1.7.5. MicrosoftSentinelDataCollectionRuleConfig
DataCollectionRuleConfig 包含有关数据收集规则的信息,它们是每个通知程序类型的配置。
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
streamName | 字符串 | ||||
dataCollectionRuleId | 字符串 | ||||
enabled | 布尔值 |
1.41.1.7.6. ProtobufAny
any
包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 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/x/y.z"。
1.41.1.7.6.1. JSON 表示
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type
。Example:
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。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 |
1.41.1.7.7. StorageAWSSecurityHub
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
region | 字符串 | ||||
credentials | |||||
accountId | 字符串 |
1.41.1.7.8. StorageAWSSecurityHubCredentials
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
accessKeyId | 字符串 | ||||
secretAccessKey | 字符串 | ||||
stsEnabled | 布尔值 |
1.41.1.7.9. StorageCSCC
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
serviceAccount | 字符串 | 集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。 | |||
sourceId | 字符串 | ||||
wifEnabled | 布尔值 |
1.41.1.7.10. StorageEmail
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
server | 字符串 | ||||
sender | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
disableTLS | 布尔值 | ||||
DEPRECATEDUseStartTLS | 布尔值 | ||||
from | 字符串 | ||||
startTLSAuthMethod | DISABLED, PLAIN, LOGIN, | ||||
allowUnauthenticatedSmtp | 布尔值 |
1.41.1.7.11. StorageGeneric
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
端点 | 字符串 | ||||
skipTLSVerify | 布尔值 | ||||
caCert | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
标头 | |||||
extraFields | |||||
auditLoggingEnabled | 布尔值 |
1.41.1.7.12. StorageJIRA
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
url | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
issueType | 字符串 | ||||
priorityMappings | |||||
defaultFieldsJson | 字符串 | ||||
disablePriority | 布尔值 |
1.41.1.7.13. StorageKeyValuePair
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.41.1.7.14. StorageMicrosoftSentinel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
logIngestionEndpoint | 字符串 | log_ingestion_endpoint 是日志 ingestion 端点。 | |||
directoryTenantId | 字符串 | directory_tenant_id 包含所选租户的 Microsoft Directory ID 的 ID。 | |||
applicationClientId | 字符串 | application_client_id 包含服务主体的应用程序 ID 的 ID。 | |||
secret | 字符串 | secret 包含客户端 secret。 | |||
alertDcrConfig | |||||
auditLogDcrConfig | |||||
clientCertAuthConfig | |||||
wifEnabled | 布尔值 | 使用 Azure 管理的身份或 Azure 工作负载身份启用带有简短令牌的身份验证。存在切换信息,以便明确使用 Azure 默认凭证,而不是始终将其用作回退。显式行为与其他集成更为一致。 |
1.41.1.7.15. StorageNotifier
Next Tag: 21
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | ||||
type | 字符串 | ||||
uiEndpoint | 字符串 | ||||
labelKey | 字符串 | ||||
labelDefault | 字符串 | ||||
jira | |||||
| |||||
cscc | |||||
splunk | |||||
PagerDuty | |||||
generic | |||||
Sumologic | |||||
awsSecurityHub | |||||
syslog | |||||
microsoftSentinel | |||||
notifierSecret | 字符串 | ||||
遍历 |
1.41.1.7.16. StoragePagerDuty
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
apiKey | 字符串 | 集成的 API 密钥。服务器将在响应和日志中屏蔽此凭据的值。 |
1.41.1.7.17. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.41.1.7.18. StorageSplunk
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpToken | 字符串 | 集成的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。 | |||
httpEndpoint | 字符串 | ||||
insecure | 布尔值 | ||||
truncate | 字符串 | int64 | |||
auditLoggingEnabled | 布尔值 | ||||
derivedSourceType | 布尔值 | ||||
sourceTypes |
|
1.41.1.7.19. StorageSumoLogic
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpSourceAddress | 字符串 | ||||
skipTLSVerify | 布尔值 |
1.41.1.7.20. StorageSyslog
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
localFacility | LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7. | ||||
tcpConfig | |||||
extraFields | |||||
messageFormat | 传统、CEF、 |
1.41.1.7.21. StorageTraits
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
可见性 | 可见、隐藏、 | ||||
origin | IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
1.41.1.7.22. SyslogLocalFacility
Enum 值 |
---|
LOCAL0 |
LOCAL1 |
LOCAL2 |
LOCAL3 |
LOCAL4 |
LOCAL5 |
LOCAL6 |
LOCAL7 |
1.41.1.7.23. SyslogMessageFormat
Enum 值 |
---|
LEGACY |
CEF |
1.41.1.7.24. SyslogTCPConfig
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
hostname | 字符串 | ||||
port | 整数 | int32 | |||
skipTlsVerify | 布尔值 | ||||
useTls | 布尔值 |
1.41.1.7.25. TraitsMutabilityMode
实验性。注意:请参考在时间使用 MutabilityMode 时。它将在以后被替换(ROX-14276)。MutabilityMode 指定是否以及如何修改对象。默认为 ALLOW_MUTATE,意味着没有修改限制,这等同于没有 MutabilityMode 规格。ALLOW_MUTATE_FORCED forbids 所有修改操作,除了删除强制位的对象。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但会禁止以后更改它,包括将其修改回 ALLOW_MUTATE。
Enum 值 |
---|
EXTETE_MUTATE |
ALLOW_MUTATE_FORCED |
1.41.1.7.26. 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 |
1.41.1.7.27. TraitsVisibility
EXPERIMENTAL. visibility 允许指定对象是否应该对某些 API 可见。
Enum 值 |
---|
VISIBLE |
HIDDEN |
1.41.1.7.28. V1GetNotifiersResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
通知程序 |
1.41.2. DeleteNotifier
DELETE /v1/notifiers/{id}
DeleteNotifier 删除通知程序配置给定的 ID。
1.41.2.1. 描述
1.41.2.2. 参数
1.41.2.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
id | X | null |
1.41.2.2.2. 查询参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
force | - | null |
1.41.2.3. 返回类型
对象
1.41.2.4. 内容类型
- application/json
1.41.2.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.41.2.6. Samples
1.41.2.7. 常规对象参考
1.41.2.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.41.2.7.2. ProtobufAny
any
包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 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/x/y.z"。
1.41.2.7.2.1. JSON 表示
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type
。Example:
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。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 |
1.41.3. GetNotifier
GET /v1/notifiers/{id}
GetNotifier 返回给定 ID 的通知程序配置。
1.41.3.1. 描述
1.41.3.2. 参数
1.41.3.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
id | X | null |
1.41.3.3. 返回类型
1.41.3.4. 内容类型
- application/json
1.41.3.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.41.3.6. Samples
1.41.3.7. 常规对象参考
1.41.3.7.1. EmailAuthMethod
Enum 值 |
---|
DISABLED |
PLAIN |
LOGIN |
1.41.3.7.2. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.41.3.7.3. JiraPriorityMapping
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
priorityName | 字符串 |
1.41.3.7.4. MicrosoftSentinelClientCertAuthConfig
client certificate which is used for authentication
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
clientCert | 字符串 | PEM 编码的 ASN.1 DER 格式。 | |||
privateKey | 字符串 | PEM 编码的 PKCS #8, ASN.1 DER 格式。 |
1.41.3.7.5. MicrosoftSentinelDataCollectionRuleConfig
DataCollectionRuleConfig 包含有关数据收集规则的信息,它们是每个通知程序类型的配置。
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
streamName | 字符串 | ||||
dataCollectionRuleId | 字符串 | ||||
enabled | 布尔值 |
1.41.3.7.6. ProtobufAny
any
包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 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/x/y.z"。
1.41.3.7.6.1. JSON 表示
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type
。Example:
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。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 |
1.41.3.7.7. StorageAWSSecurityHub
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
region | 字符串 | ||||
credentials | |||||
accountId | 字符串 |
1.41.3.7.8. StorageAWSSecurityHubCredentials
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
accessKeyId | 字符串 | ||||
secretAccessKey | 字符串 | ||||
stsEnabled | 布尔值 |
1.41.3.7.9. StorageCSCC
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
serviceAccount | 字符串 | 集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。 | |||
sourceId | 字符串 | ||||
wifEnabled | 布尔值 |
1.41.3.7.10. StorageEmail
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
server | 字符串 | ||||
sender | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
disableTLS | 布尔值 | ||||
DEPRECATEDUseStartTLS | 布尔值 | ||||
from | 字符串 | ||||
startTLSAuthMethod | DISABLED, PLAIN, LOGIN, | ||||
allowUnauthenticatedSmtp | 布尔值 |
1.41.3.7.11. StorageGeneric
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
端点 | 字符串 | ||||
skipTLSVerify | 布尔值 | ||||
caCert | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
标头 | |||||
extraFields | |||||
auditLoggingEnabled | 布尔值 |
1.41.3.7.12. StorageJIRA
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
url | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
issueType | 字符串 | ||||
priorityMappings | |||||
defaultFieldsJson | 字符串 | ||||
disablePriority | 布尔值 |
1.41.3.7.13. StorageKeyValuePair
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.41.3.7.14. StorageMicrosoftSentinel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
logIngestionEndpoint | 字符串 | log_ingestion_endpoint 是日志 ingestion 端点。 | |||
directoryTenantId | 字符串 | directory_tenant_id 包含所选租户的 Microsoft Directory ID 的 ID。 | |||
applicationClientId | 字符串 | application_client_id 包含服务主体的应用程序 ID 的 ID。 | |||
secret | 字符串 | secret 包含客户端 secret。 | |||
alertDcrConfig | |||||
auditLogDcrConfig | |||||
clientCertAuthConfig | |||||
wifEnabled | 布尔值 | 使用 Azure 管理的身份或 Azure 工作负载身份启用带有简短令牌的身份验证。存在切换信息,以便明确使用 Azure 默认凭证,而不是始终将其用作回退。显式行为与其他集成更为一致。 |
1.41.3.7.15. StorageNotifier
Next Tag: 21
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | ||||
type | 字符串 | ||||
uiEndpoint | 字符串 | ||||
labelKey | 字符串 | ||||
labelDefault | 字符串 | ||||
jira | |||||
| |||||
cscc | |||||
splunk | |||||
PagerDuty | |||||
generic | |||||
Sumologic | |||||
awsSecurityHub | |||||
syslog | |||||
microsoftSentinel | |||||
notifierSecret | 字符串 | ||||
遍历 |
1.41.3.7.16. StoragePagerDuty
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
apiKey | 字符串 | 集成的 API 密钥。服务器将在响应和日志中屏蔽此凭据的值。 |
1.41.3.7.17. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.41.3.7.18. StorageSplunk
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpToken | 字符串 | 集成的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。 | |||
httpEndpoint | 字符串 | ||||
insecure | 布尔值 | ||||
truncate | 字符串 | int64 | |||
auditLoggingEnabled | 布尔值 | ||||
derivedSourceType | 布尔值 | ||||
sourceTypes |
|
1.41.3.7.19. StorageSumoLogic
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpSourceAddress | 字符串 | ||||
skipTLSVerify | 布尔值 |
1.41.3.7.20. StorageSyslog
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
localFacility | LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7. | ||||
tcpConfig | |||||
extraFields | |||||
messageFormat | 传统、CEF、 |
1.41.3.7.21. StorageTraits
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
可见性 | 可见、隐藏、 | ||||
origin | IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
1.41.3.7.22. SyslogLocalFacility
Enum 值 |
---|
LOCAL0 |
LOCAL1 |
LOCAL2 |
LOCAL3 |
LOCAL4 |
LOCAL5 |
LOCAL6 |
LOCAL7 |
1.41.3.7.23. SyslogMessageFormat
Enum 值 |
---|
LEGACY |
CEF |
1.41.3.7.24. SyslogTCPConfig
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
hostname | 字符串 | ||||
port | 整数 | int32 | |||
skipTlsVerify | 布尔值 | ||||
useTls | 布尔值 |
1.41.3.7.25. TraitsMutabilityMode
实验性。注意:请参考在时间使用 MutabilityMode 时。它将在以后被替换(ROX-14276)。MutabilityMode 指定是否以及如何修改对象。默认为 ALLOW_MUTATE,意味着没有修改限制,这等同于没有 MutabilityMode 规格。ALLOW_MUTATE_FORCED forbids 所有修改操作,除了删除强制位的对象。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但会禁止以后更改它,包括将其修改回 ALLOW_MUTATE。
Enum 值 |
---|
EXTETE_MUTATE |
ALLOW_MUTATE_FORCED |
1.41.3.7.26. 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 |
1.41.3.7.27. TraitsVisibility
EXPERIMENTAL. visibility 允许指定对象是否应该对某些 API 可见。
Enum 值 |
---|
VISIBLE |
HIDDEN |
1.41.4. PutNotifier
PUT /v1/notifiers/{id}
PutNotifier 修改给定的通知程序,而不使用存储的凭证协调。
1.41.4.1. 描述
1.41.4.2. 参数
1.41.4.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
id | X | null |
1.41.4.2.2. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.41.4.3. 返回类型
对象
1.41.4.4. 内容类型
- application/json
1.41.4.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.41.4.6. Samples
1.41.4.7. 常规对象参考
1.41.4.7.1. EmailAuthMethod
Enum 值 |
---|
DISABLED |
PLAIN |
LOGIN |
1.41.4.7.2. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.41.4.7.3. JiraPriorityMapping
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
priorityName | 字符串 |
1.41.4.7.4. MicrosoftSentinelClientCertAuthConfig
client certificate which is used for authentication
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
clientCert | 字符串 | PEM 编码的 ASN.1 DER 格式。 | |||
privateKey | 字符串 | PEM 编码的 PKCS #8, ASN.1 DER 格式。 |
1.41.4.7.5. MicrosoftSentinelDataCollectionRuleConfig
DataCollectionRuleConfig 包含有关数据收集规则的信息,它们是每个通知程序类型的配置。
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
streamName | 字符串 | ||||
dataCollectionRuleId | 字符串 | ||||
enabled | 布尔值 |
1.41.4.7.6. NotifierServicePutNotifierBody
Next Tag: 21
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
type | 字符串 | ||||
uiEndpoint | 字符串 | ||||
labelKey | 字符串 | ||||
labelDefault | 字符串 | ||||
jira | |||||
| |||||
cscc | |||||
splunk | |||||
PagerDuty | |||||
generic | |||||
Sumologic | |||||
awsSecurityHub | |||||
syslog | |||||
microsoftSentinel | |||||
notifierSecret | 字符串 | ||||
遍历 |
1.41.4.7.7. ProtobufAny
any
包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 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/x/y.z"。
1.41.4.7.7.1. JSON 表示
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type
。Example:
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。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 |
1.41.4.7.8. StorageAWSSecurityHub
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
region | 字符串 | ||||
credentials | |||||
accountId | 字符串 |
1.41.4.7.9. StorageAWSSecurityHubCredentials
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
accessKeyId | 字符串 | ||||
secretAccessKey | 字符串 | ||||
stsEnabled | 布尔值 |
1.41.4.7.10. StorageCSCC
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
serviceAccount | 字符串 | 集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。 | |||
sourceId | 字符串 | ||||
wifEnabled | 布尔值 |
1.41.4.7.11. StorageEmail
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
server | 字符串 | ||||
sender | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
disableTLS | 布尔值 | ||||
DEPRECATEDUseStartTLS | 布尔值 | ||||
from | 字符串 | ||||
startTLSAuthMethod | DISABLED, PLAIN, LOGIN, | ||||
allowUnauthenticatedSmtp | 布尔值 |
1.41.4.7.12. StorageGeneric
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
端点 | 字符串 | ||||
skipTLSVerify | 布尔值 | ||||
caCert | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
标头 | |||||
extraFields | |||||
auditLoggingEnabled | 布尔值 |
1.41.4.7.13. StorageJIRA
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
url | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
issueType | 字符串 | ||||
priorityMappings | |||||
defaultFieldsJson | 字符串 | ||||
disablePriority | 布尔值 |
1.41.4.7.14. StorageKeyValuePair
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.41.4.7.15. StorageMicrosoftSentinel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
logIngestionEndpoint | 字符串 | log_ingestion_endpoint 是日志 ingestion 端点。 | |||
directoryTenantId | 字符串 | directory_tenant_id 包含所选租户的 Microsoft Directory ID 的 ID。 | |||
applicationClientId | 字符串 | application_client_id 包含服务主体的应用程序 ID 的 ID。 | |||
secret | 字符串 | secret 包含客户端 secret。 | |||
alertDcrConfig | |||||
auditLogDcrConfig | |||||
clientCertAuthConfig | |||||
wifEnabled | 布尔值 | 使用 Azure 管理的身份或 Azure 工作负载身份启用带有简短令牌的身份验证。存在切换信息,以便明确使用 Azure 默认凭证,而不是始终将其用作回退。显式行为与其他集成更为一致。 |
1.41.4.7.16. StoragePagerDuty
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
apiKey | 字符串 | 集成的 API 密钥。服务器将在响应和日志中屏蔽此凭据的值。 |
1.41.4.7.17. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.41.4.7.18. StorageSplunk
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpToken | 字符串 | 集成的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。 | |||
httpEndpoint | 字符串 | ||||
insecure | 布尔值 | ||||
truncate | 字符串 | int64 | |||
auditLoggingEnabled | 布尔值 | ||||
derivedSourceType | 布尔值 | ||||
sourceTypes |
|
1.41.4.7.19. StorageSumoLogic
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpSourceAddress | 字符串 | ||||
skipTLSVerify | 布尔值 |
1.41.4.7.20. StorageSyslog
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
localFacility | LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7. | ||||
tcpConfig | |||||
extraFields | |||||
messageFormat | 传统、CEF、 |
1.41.4.7.21. StorageTraits
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
可见性 | 可见、隐藏、 | ||||
origin | IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
1.41.4.7.22. SyslogLocalFacility
Enum 值 |
---|
LOCAL0 |
LOCAL1 |
LOCAL2 |
LOCAL3 |
LOCAL4 |
LOCAL5 |
LOCAL6 |
LOCAL7 |
1.41.4.7.23. SyslogMessageFormat
Enum 值 |
---|
LEGACY |
CEF |
1.41.4.7.24. SyslogTCPConfig
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
hostname | 字符串 | ||||
port | 整数 | int32 | |||
skipTlsVerify | 布尔值 | ||||
useTls | 布尔值 |
1.41.4.7.25. TraitsMutabilityMode
实验性。注意:请参考在时间使用 MutabilityMode 时。它将在以后被替换(ROX-14276)。MutabilityMode 指定是否以及如何修改对象。默认为 ALLOW_MUTATE,意味着没有修改限制,这等同于没有 MutabilityMode 规格。ALLOW_MUTATE_FORCED forbids 所有修改操作,除了删除强制位的对象。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但会禁止以后更改它,包括将其修改回 ALLOW_MUTATE。
Enum 值 |
---|
EXTETE_MUTATE |
ALLOW_MUTATE_FORCED |
1.41.4.7.26. 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 |
1.41.4.7.27. TraitsVisibility
EXPERIMENTAL. visibility 允许指定对象是否应该对某些 API 可见。
Enum 值 |
---|
VISIBLE |
HIDDEN |
1.41.5. UpdateNotifier
PATCH /v1/notifiers/{notifier.id}
UpdateNotifier 修改给定的通知程序,带有可选存储的凭证协调。
1.41.5.1. 描述
1.41.5.2. 参数
1.41.5.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
notifier.id | X | null |
1.41.5.2.2. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.41.5.3. 返回类型
对象
1.41.5.4. 内容类型
- application/json
1.41.5.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.41.5.6. Samples
1.41.5.7. 常规对象参考
1.41.5.7.1. EmailAuthMethod
Enum 值 |
---|
DISABLED |
PLAIN |
LOGIN |
1.41.5.7.2. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.41.5.7.3. JiraPriorityMapping
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
priorityName | 字符串 |
1.41.5.7.4. MicrosoftSentinelClientCertAuthConfig
client certificate which is used for authentication
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
clientCert | 字符串 | PEM 编码的 ASN.1 DER 格式。 | |||
privateKey | 字符串 | PEM 编码的 PKCS #8, ASN.1 DER 格式。 |
1.41.5.7.5. MicrosoftSentinelDataCollectionRuleConfig
DataCollectionRuleConfig 包含有关数据收集规则的信息,它们是每个通知程序类型的配置。
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
streamName | 字符串 | ||||
dataCollectionRuleId | 字符串 | ||||
enabled | 布尔值 |
1.41.5.7.6. NextTag21
Next Tag: 21
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
type | 字符串 | ||||
uiEndpoint | 字符串 | ||||
labelKey | 字符串 | ||||
labelDefault | 字符串 | ||||
jira | |||||
| |||||
cscc | |||||
splunk | |||||
PagerDuty | |||||
generic | |||||
Sumologic | |||||
awsSecurityHub | |||||
syslog | |||||
microsoftSentinel | |||||
notifierSecret | 字符串 | ||||
遍历 |
1.41.5.7.7. NotifierServiceUpdateNotifierBody
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
通知程序 | |||||
updatePassword | 布尔值 | 为 false 时,使用现有通知器配置的存储凭证给定其 ID。 |
1.41.5.7.8. ProtobufAny
any
包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 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/x/y.z"。
1.41.5.7.8.1. JSON 表示
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type
。Example:
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。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 |
1.41.5.7.9. StorageAWSSecurityHub
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
region | 字符串 | ||||
credentials | |||||
accountId | 字符串 |
1.41.5.7.10. StorageAWSSecurityHubCredentials
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
accessKeyId | 字符串 | ||||
secretAccessKey | 字符串 | ||||
stsEnabled | 布尔值 |
1.41.5.7.11. StorageCSCC
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
serviceAccount | 字符串 | 集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。 | |||
sourceId | 字符串 | ||||
wifEnabled | 布尔值 |
1.41.5.7.12. StorageEmail
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
server | 字符串 | ||||
sender | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
disableTLS | 布尔值 | ||||
DEPRECATEDUseStartTLS | 布尔值 | ||||
from | 字符串 | ||||
startTLSAuthMethod | DISABLED, PLAIN, LOGIN, | ||||
allowUnauthenticatedSmtp | 布尔值 |
1.41.5.7.13. StorageGeneric
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
端点 | 字符串 | ||||
skipTLSVerify | 布尔值 | ||||
caCert | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
标头 | |||||
extraFields | |||||
auditLoggingEnabled | 布尔值 |
1.41.5.7.14. StorageJIRA
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
url | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
issueType | 字符串 | ||||
priorityMappings | |||||
defaultFieldsJson | 字符串 | ||||
disablePriority | 布尔值 |
1.41.5.7.15. StorageKeyValuePair
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.41.5.7.16. StorageMicrosoftSentinel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
logIngestionEndpoint | 字符串 | log_ingestion_endpoint 是日志 ingestion 端点。 | |||
directoryTenantId | 字符串 | directory_tenant_id 包含所选租户的 Microsoft Directory ID 的 ID。 | |||
applicationClientId | 字符串 | application_client_id 包含服务主体的应用程序 ID 的 ID。 | |||
secret | 字符串 | secret 包含客户端 secret。 | |||
alertDcrConfig | |||||
auditLogDcrConfig | |||||
clientCertAuthConfig | |||||
wifEnabled | 布尔值 | 使用 Azure 管理的身份或 Azure 工作负载身份启用带有简短令牌的身份验证。存在切换信息,以便明确使用 Azure 默认凭证,而不是始终将其用作回退。显式行为与其他集成更为一致。 |
1.41.5.7.17. StoragePagerDuty
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
apiKey | 字符串 | 集成的 API 密钥。服务器将在响应和日志中屏蔽此凭据的值。 |
1.41.5.7.18. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.41.5.7.19. StorageSplunk
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpToken | 字符串 | 集成的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。 | |||
httpEndpoint | 字符串 | ||||
insecure | 布尔值 | ||||
truncate | 字符串 | int64 | |||
auditLoggingEnabled | 布尔值 | ||||
derivedSourceType | 布尔值 | ||||
sourceTypes |
|
1.41.5.7.20. StorageSumoLogic
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpSourceAddress | 字符串 | ||||
skipTLSVerify | 布尔值 |
1.41.5.7.21. StorageSyslog
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
localFacility | LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7. | ||||
tcpConfig | |||||
extraFields | |||||
messageFormat | 传统、CEF、 |
1.41.5.7.22. StorageTraits
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
可见性 | 可见、隐藏、 | ||||
origin | IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
1.41.5.7.23. SyslogLocalFacility
Enum 值 |
---|
LOCAL0 |
LOCAL1 |
LOCAL2 |
LOCAL3 |
LOCAL4 |
LOCAL5 |
LOCAL6 |
LOCAL7 |
1.41.5.7.24. SyslogMessageFormat
Enum 值 |
---|
LEGACY |
CEF |
1.41.5.7.25. SyslogTCPConfig
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
hostname | 字符串 | ||||
port | 整数 | int32 | |||
skipTlsVerify | 布尔值 | ||||
useTls | 布尔值 |
1.41.5.7.26. TraitsMutabilityMode
实验性。注意:请参考在时间使用 MutabilityMode 时。它将在以后被替换(ROX-14276)。MutabilityMode 指定是否以及如何修改对象。默认为 ALLOW_MUTATE,意味着没有修改限制,这等同于没有 MutabilityMode 规格。ALLOW_MUTATE_FORCED forbids 所有修改操作,除了删除强制位的对象。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但会禁止以后更改它,包括将其修改回 ALLOW_MUTATE。
Enum 值 |
---|
EXTETE_MUTATE |
ALLOW_MUTATE_FORCED |
1.41.5.7.27. 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 |
1.41.5.7.28. TraitsVisibility
EXPERIMENTAL. visibility 允许指定对象是否应该对某些 API 可见。
Enum 值 |
---|
VISIBLE |
HIDDEN |
1.41.6. PostNotifier
POST /v1/notifiers
PostNotifier 创建通知程序配置。
1.41.6.1. 描述
1.41.6.2. 参数
1.41.6.2.1. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.41.6.3. 返回类型
1.41.6.4. 内容类型
- application/json
1.41.6.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.41.6.6. Samples
1.41.6.7. 常规对象参考
1.41.6.7.1. EmailAuthMethod
Enum 值 |
---|
DISABLED |
PLAIN |
LOGIN |
1.41.6.7.2. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.41.6.7.3. JiraPriorityMapping
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
priorityName | 字符串 |
1.41.6.7.4. MicrosoftSentinelClientCertAuthConfig
client certificate which is used for authentication
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
clientCert | 字符串 | PEM 编码的 ASN.1 DER 格式。 | |||
privateKey | 字符串 | PEM 编码的 PKCS #8, ASN.1 DER 格式。 |
1.41.6.7.5. MicrosoftSentinelDataCollectionRuleConfig
DataCollectionRuleConfig 包含有关数据收集规则的信息,它们是每个通知程序类型的配置。
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
streamName | 字符串 | ||||
dataCollectionRuleId | 字符串 | ||||
enabled | 布尔值 |
1.41.6.7.6. ProtobufAny
any
包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 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/x/y.z"。
1.41.6.7.6.1. JSON 表示
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type
。Example:
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。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 |
1.41.6.7.7. StorageAWSSecurityHub
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
region | 字符串 | ||||
credentials | |||||
accountId | 字符串 |
1.41.6.7.8. StorageAWSSecurityHubCredentials
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
accessKeyId | 字符串 | ||||
secretAccessKey | 字符串 | ||||
stsEnabled | 布尔值 |
1.41.6.7.9. StorageCSCC
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
serviceAccount | 字符串 | 集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。 | |||
sourceId | 字符串 | ||||
wifEnabled | 布尔值 |
1.41.6.7.10. StorageEmail
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
server | 字符串 | ||||
sender | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
disableTLS | 布尔值 | ||||
DEPRECATEDUseStartTLS | 布尔值 | ||||
from | 字符串 | ||||
startTLSAuthMethod | DISABLED, PLAIN, LOGIN, | ||||
allowUnauthenticatedSmtp | 布尔值 |
1.41.6.7.11. StorageGeneric
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
端点 | 字符串 | ||||
skipTLSVerify | 布尔值 | ||||
caCert | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
标头 | |||||
extraFields | |||||
auditLoggingEnabled | 布尔值 |
1.41.6.7.12. StorageJIRA
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
url | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
issueType | 字符串 | ||||
priorityMappings | |||||
defaultFieldsJson | 字符串 | ||||
disablePriority | 布尔值 |
1.41.6.7.13. StorageKeyValuePair
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.41.6.7.14. StorageMicrosoftSentinel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
logIngestionEndpoint | 字符串 | log_ingestion_endpoint 是日志 ingestion 端点。 | |||
directoryTenantId | 字符串 | directory_tenant_id 包含所选租户的 Microsoft Directory ID 的 ID。 | |||
applicationClientId | 字符串 | application_client_id 包含服务主体的应用程序 ID 的 ID。 | |||
secret | 字符串 | secret 包含客户端 secret。 | |||
alertDcrConfig | |||||
auditLogDcrConfig | |||||
clientCertAuthConfig | |||||
wifEnabled | 布尔值 | 使用 Azure 管理的身份或 Azure 工作负载身份启用带有简短令牌的身份验证。存在切换信息,以便明确使用 Azure 默认凭证,而不是始终将其用作回退。显式行为与其他集成更为一致。 |
1.41.6.7.15. StorageNotifier
Next Tag: 21
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | ||||
type | 字符串 | ||||
uiEndpoint | 字符串 | ||||
labelKey | 字符串 | ||||
labelDefault | 字符串 | ||||
jira | |||||
| |||||
cscc | |||||
splunk | |||||
PagerDuty | |||||
generic | |||||
Sumologic | |||||
awsSecurityHub | |||||
syslog | |||||
microsoftSentinel | |||||
notifierSecret | 字符串 | ||||
遍历 |
1.41.6.7.16. StoragePagerDuty
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
apiKey | 字符串 | 集成的 API 密钥。服务器将在响应和日志中屏蔽此凭据的值。 |
1.41.6.7.17. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.41.6.7.18. StorageSplunk
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpToken | 字符串 | 集成的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。 | |||
httpEndpoint | 字符串 | ||||
insecure | 布尔值 | ||||
truncate | 字符串 | int64 | |||
auditLoggingEnabled | 布尔值 | ||||
derivedSourceType | 布尔值 | ||||
sourceTypes |
|
1.41.6.7.19. StorageSumoLogic
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpSourceAddress | 字符串 | ||||
skipTLSVerify | 布尔值 |
1.41.6.7.20. StorageSyslog
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
localFacility | LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7. | ||||
tcpConfig | |||||
extraFields | |||||
messageFormat | 传统、CEF、 |
1.41.6.7.21. StorageTraits
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
可见性 | 可见、隐藏、 | ||||
origin | IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
1.41.6.7.22. SyslogLocalFacility
Enum 值 |
---|
LOCAL0 |
LOCAL1 |
LOCAL2 |
LOCAL3 |
LOCAL4 |
LOCAL5 |
LOCAL6 |
LOCAL7 |
1.41.6.7.23. SyslogMessageFormat
Enum 值 |
---|
LEGACY |
CEF |
1.41.6.7.24. SyslogTCPConfig
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
hostname | 字符串 | ||||
port | 整数 | int32 | |||
skipTlsVerify | 布尔值 | ||||
useTls | 布尔值 |
1.41.6.7.25. TraitsMutabilityMode
实验性。注意:请参考在时间使用 MutabilityMode 时。它将在以后被替换(ROX-14276)。MutabilityMode 指定是否以及如何修改对象。默认为 ALLOW_MUTATE,意味着没有修改限制,这等同于没有 MutabilityMode 规格。ALLOW_MUTATE_FORCED forbids 所有修改操作,除了删除强制位的对象。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但会禁止以后更改它,包括将其修改回 ALLOW_MUTATE。
Enum 值 |
---|
EXTETE_MUTATE |
ALLOW_MUTATE_FORCED |
1.41.6.7.26. 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 |
1.41.6.7.27. TraitsVisibility
EXPERIMENTAL. visibility 允许指定对象是否应该对某些 API 可见。
Enum 值 |
---|
VISIBLE |
HIDDEN |
1.41.7. TestNotifier
POST /v1/notifiers/test
TestNotifier 检查通知是否配置正确。
1.41.7.1. 描述
1.41.7.2. 参数
1.41.7.2.1. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.41.7.3. 返回类型
对象
1.41.7.4. 内容类型
- application/json
1.41.7.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.41.7.6. Samples
1.41.7.7. 常规对象参考
1.41.7.7.1. EmailAuthMethod
Enum 值 |
---|
DISABLED |
PLAIN |
LOGIN |
1.41.7.7.2. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.41.7.7.3. JiraPriorityMapping
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
priorityName | 字符串 |
1.41.7.7.4. MicrosoftSentinelClientCertAuthConfig
client certificate which is used for authentication
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
clientCert | 字符串 | PEM 编码的 ASN.1 DER 格式。 | |||
privateKey | 字符串 | PEM 编码的 PKCS #8, ASN.1 DER 格式。 |
1.41.7.7.5. MicrosoftSentinelDataCollectionRuleConfig
DataCollectionRuleConfig 包含有关数据收集规则的信息,它们是每个通知程序类型的配置。
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
streamName | 字符串 | ||||
dataCollectionRuleId | 字符串 | ||||
enabled | 布尔值 |
1.41.7.7.6. ProtobufAny
any
包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 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/x/y.z"。
1.41.7.7.6.1. JSON 表示
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type
。Example:
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。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 |
1.41.7.7.7. StorageAWSSecurityHub
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
region | 字符串 | ||||
credentials | |||||
accountId | 字符串 |
1.41.7.7.8. StorageAWSSecurityHubCredentials
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
accessKeyId | 字符串 | ||||
secretAccessKey | 字符串 | ||||
stsEnabled | 布尔值 |
1.41.7.7.9. StorageCSCC
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
serviceAccount | 字符串 | 集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。 | |||
sourceId | 字符串 | ||||
wifEnabled | 布尔值 |
1.41.7.7.10. StorageEmail
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
server | 字符串 | ||||
sender | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
disableTLS | 布尔值 | ||||
DEPRECATEDUseStartTLS | 布尔值 | ||||
from | 字符串 | ||||
startTLSAuthMethod | DISABLED, PLAIN, LOGIN, | ||||
allowUnauthenticatedSmtp | 布尔值 |
1.41.7.7.11. StorageGeneric
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
端点 | 字符串 | ||||
skipTLSVerify | 布尔值 | ||||
caCert | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
标头 | |||||
extraFields | |||||
auditLoggingEnabled | 布尔值 |
1.41.7.7.12. StorageJIRA
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
url | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
issueType | 字符串 | ||||
priorityMappings | |||||
defaultFieldsJson | 字符串 | ||||
disablePriority | 布尔值 |
1.41.7.7.13. StorageKeyValuePair
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.41.7.7.14. StorageMicrosoftSentinel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
logIngestionEndpoint | 字符串 | log_ingestion_endpoint 是日志 ingestion 端点。 | |||
directoryTenantId | 字符串 | directory_tenant_id 包含所选租户的 Microsoft Directory ID 的 ID。 | |||
applicationClientId | 字符串 | application_client_id 包含服务主体的应用程序 ID 的 ID。 | |||
secret | 字符串 | secret 包含客户端 secret。 | |||
alertDcrConfig | |||||
auditLogDcrConfig | |||||
clientCertAuthConfig | |||||
wifEnabled | 布尔值 | 使用 Azure 管理的身份或 Azure 工作负载身份启用带有简短令牌的身份验证。存在切换信息,以便明确使用 Azure 默认凭证,而不是始终将其用作回退。显式行为与其他集成更为一致。 |
1.41.7.7.15. StorageNotifier
Next Tag: 21
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | ||||
type | 字符串 | ||||
uiEndpoint | 字符串 | ||||
labelKey | 字符串 | ||||
labelDefault | 字符串 | ||||
jira | |||||
| |||||
cscc | |||||
splunk | |||||
PagerDuty | |||||
generic | |||||
Sumologic | |||||
awsSecurityHub | |||||
syslog | |||||
microsoftSentinel | |||||
notifierSecret | 字符串 | ||||
遍历 |
1.41.7.7.16. StoragePagerDuty
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
apiKey | 字符串 | 集成的 API 密钥。服务器将在响应和日志中屏蔽此凭据的值。 |
1.41.7.7.17. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.41.7.7.18. StorageSplunk
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpToken | 字符串 | 集成的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。 | |||
httpEndpoint | 字符串 | ||||
insecure | 布尔值 | ||||
truncate | 字符串 | int64 | |||
auditLoggingEnabled | 布尔值 | ||||
derivedSourceType | 布尔值 | ||||
sourceTypes |
|
1.41.7.7.19. StorageSumoLogic
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpSourceAddress | 字符串 | ||||
skipTLSVerify | 布尔值 |
1.41.7.7.20. StorageSyslog
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
localFacility | LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7. | ||||
tcpConfig | |||||
extraFields | |||||
messageFormat | 传统、CEF、 |
1.41.7.7.21. StorageTraits
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
可见性 | 可见、隐藏、 | ||||
origin | IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
1.41.7.7.22. SyslogLocalFacility
Enum 值 |
---|
LOCAL0 |
LOCAL1 |
LOCAL2 |
LOCAL3 |
LOCAL4 |
LOCAL5 |
LOCAL6 |
LOCAL7 |
1.41.7.7.23. SyslogMessageFormat
Enum 值 |
---|
LEGACY |
CEF |
1.41.7.7.24. SyslogTCPConfig
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
hostname | 字符串 | ||||
port | 整数 | int32 | |||
skipTlsVerify | 布尔值 | ||||
useTls | 布尔值 |
1.41.7.7.25. TraitsMutabilityMode
实验性。注意:请参考在时间使用 MutabilityMode 时。它将在以后被替换(ROX-14276)。MutabilityMode 指定是否以及如何修改对象。默认为 ALLOW_MUTATE,意味着没有修改限制,这等同于没有 MutabilityMode 规格。ALLOW_MUTATE_FORCED forbids 所有修改操作,除了删除强制位的对象。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但会禁止以后更改它,包括将其修改回 ALLOW_MUTATE。
Enum 值 |
---|
EXTETE_MUTATE |
ALLOW_MUTATE_FORCED |
1.41.7.7.26. 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 |
1.41.7.7.27. TraitsVisibility
EXPERIMENTAL. visibility 允许指定对象是否应该对某些 API 可见。
Enum 值 |
---|
VISIBLE |
HIDDEN |
1.41.8. TestUpdatedNotifier
POST /v1/notifiers/test/updated
TestUpdatedNotifier 检查给定通知程序是否已正确配置,并带有可选的存储的凭证协调。
1.41.8.1. 描述
1.41.8.2. 参数
1.41.8.2.1. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.41.8.3. 返回类型
对象
1.41.8.4. 内容类型
- application/json
1.41.8.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.41.8.6. Samples
1.41.8.7. 常规对象参考
1.41.8.7.1. EmailAuthMethod
Enum 值 |
---|
DISABLED |
PLAIN |
LOGIN |
1.41.8.7.2. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.41.8.7.3. JiraPriorityMapping
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
priorityName | 字符串 |
1.41.8.7.4. MicrosoftSentinelClientCertAuthConfig
client certificate which is used for authentication
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
clientCert | 字符串 | PEM 编码的 ASN.1 DER 格式。 | |||
privateKey | 字符串 | PEM 编码的 PKCS #8, ASN.1 DER 格式。 |
1.41.8.7.5. MicrosoftSentinelDataCollectionRuleConfig
DataCollectionRuleConfig 包含有关数据收集规则的信息,它们是每个通知程序类型的配置。
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
streamName | 字符串 | ||||
dataCollectionRuleId | 字符串 | ||||
enabled | 布尔值 |
1.41.8.7.6. ProtobufAny
any
包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 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/x/y.z"。
1.41.8.7.6.1. JSON 表示
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type
。Example:
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。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 |
1.41.8.7.7. StorageAWSSecurityHub
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
region | 字符串 | ||||
credentials | |||||
accountId | 字符串 |
1.41.8.7.8. StorageAWSSecurityHubCredentials
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
accessKeyId | 字符串 | ||||
secretAccessKey | 字符串 | ||||
stsEnabled | 布尔值 |
1.41.8.7.9. StorageCSCC
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
serviceAccount | 字符串 | 集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。 | |||
sourceId | 字符串 | ||||
wifEnabled | 布尔值 |
1.41.8.7.10. StorageEmail
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
server | 字符串 | ||||
sender | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
disableTLS | 布尔值 | ||||
DEPRECATEDUseStartTLS | 布尔值 | ||||
from | 字符串 | ||||
startTLSAuthMethod | DISABLED, PLAIN, LOGIN, | ||||
allowUnauthenticatedSmtp | 布尔值 |
1.41.8.7.11. StorageGeneric
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
端点 | 字符串 | ||||
skipTLSVerify | 布尔值 | ||||
caCert | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
标头 | |||||
extraFields | |||||
auditLoggingEnabled | 布尔值 |
1.41.8.7.12. StorageJIRA
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
url | 字符串 | ||||
username | 字符串 | ||||
password | 字符串 | 集成的密码。服务器将在响应和日志中屏蔽此凭据的值。 | |||
issueType | 字符串 | ||||
priorityMappings | |||||
defaultFieldsJson | 字符串 | ||||
disablePriority | 布尔值 |
1.41.8.7.13. StorageKeyValuePair
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.41.8.7.14. StorageMicrosoftSentinel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
logIngestionEndpoint | 字符串 | log_ingestion_endpoint 是日志 ingestion 端点。 | |||
directoryTenantId | 字符串 | directory_tenant_id 包含所选租户的 Microsoft Directory ID 的 ID。 | |||
applicationClientId | 字符串 | application_client_id 包含服务主体的应用程序 ID 的 ID。 | |||
secret | 字符串 | secret 包含客户端 secret。 | |||
alertDcrConfig | |||||
auditLogDcrConfig | |||||
clientCertAuthConfig | |||||
wifEnabled | 布尔值 | 使用 Azure 管理的身份或 Azure 工作负载身份启用带有简短令牌的身份验证。存在切换信息,以便明确使用 Azure 默认凭证,而不是始终将其用作回退。显式行为与其他集成更为一致。 |
1.41.8.7.15. StorageNotifier
Next Tag: 21
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | ||||
type | 字符串 | ||||
uiEndpoint | 字符串 | ||||
labelKey | 字符串 | ||||
labelDefault | 字符串 | ||||
jira | |||||
| |||||
cscc | |||||
splunk | |||||
PagerDuty | |||||
generic | |||||
Sumologic | |||||
awsSecurityHub | |||||
syslog | |||||
microsoftSentinel | |||||
notifierSecret | 字符串 | ||||
遍历 |
1.41.8.7.16. StoragePagerDuty
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
apiKey | 字符串 | 集成的 API 密钥。服务器将在响应和日志中屏蔽此凭据的值。 |
1.41.8.7.17. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.41.8.7.18. StorageSplunk
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpToken | 字符串 | 集成的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。 | |||
httpEndpoint | 字符串 | ||||
insecure | 布尔值 | ||||
truncate | 字符串 | int64 | |||
auditLoggingEnabled | 布尔值 | ||||
derivedSourceType | 布尔值 | ||||
sourceTypes |
|
1.41.8.7.19. StorageSumoLogic
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
httpSourceAddress | 字符串 | ||||
skipTLSVerify | 布尔值 |
1.41.8.7.20. StorageSyslog
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
localFacility | LOCAL0、LOCAL1、LOCAL2、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7. | ||||
tcpConfig | |||||
extraFields | |||||
messageFormat | 传统、CEF、 |
1.41.8.7.21. StorageTraits
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
可见性 | 可见、隐藏、 | ||||
origin | IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
1.41.8.7.22. SyslogLocalFacility
Enum 值 |
---|
LOCAL0 |
LOCAL1 |
LOCAL2 |
LOCAL3 |
LOCAL4 |
LOCAL5 |
LOCAL6 |
LOCAL7 |
1.41.8.7.23. SyslogMessageFormat
Enum 值 |
---|
LEGACY |
CEF |
1.41.8.7.24. SyslogTCPConfig
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
hostname | 字符串 | ||||
port | 整数 | int32 | |||
skipTlsVerify | 布尔值 | ||||
useTls | 布尔值 |
1.41.8.7.25. TraitsMutabilityMode
实验性。注意:请参考在时间使用 MutabilityMode 时。它将在以后被替换(ROX-14276)。MutabilityMode 指定是否以及如何修改对象。默认为 ALLOW_MUTATE,意味着没有修改限制,这等同于没有 MutabilityMode 规格。ALLOW_MUTATE_FORCED forbids 所有修改操作,除了删除强制位的对象。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED,但会禁止以后更改它,包括将其修改回 ALLOW_MUTATE。
Enum 值 |
---|
EXTETE_MUTATE |
ALLOW_MUTATE_FORCED |
1.41.8.7.26. 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 |
1.41.8.7.27. TraitsVisibility
EXPERIMENTAL. visibility 允许指定对象是否应该对某些 API 可见。
Enum 值 |
---|
VISIBLE |
HIDDEN |
1.41.8.7.28. V1UpdateNotifierRequest
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
通知程序 | |||||
updatePassword | 布尔值 | 为 false 时,使用现有通知器配置的存储凭证给定其 ID。 |