41.8. TestUpdatedNotifier
POST /v1/notifiers/test/updated
TestUpdatedNotifier は、オプションの保存された認証情報の調整を使用して、指定の通知機能が正しく設定されているかどうかを確認します。
41.8.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
41.8.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
41.8.2.1. ボディパラメーター リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | 説明 | 必須 | デフォルト | Pattern |
|---|---|---|---|---|
| body | X |
41.8.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
Object
41.8.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
41.8.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
| コード | メッセージ | データタイプ |
|---|---|---|
| 200 | 正常な応答。 |
|
| 0 | 予期しないエラーの応答です。 |
41.8.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
41.8.7. 共通のオブジェクト参照 リンクのコピーリンクがクリップボードにコピーされました!
41.8.7.1. EmailAuthMethod リンクのコピーリンクがクリップボードにコピーされました!
| Enum 値 |
|---|
| DISABLED |
| PLAIN |
| ログイン |
41.8.7.2. JiraPriorityMapping リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| severity | UNSET_SEVERITY、LOW_SEVERITY、MEDIUM_SEVERITY、HIGH_SEVERITY、CRITICAL_SEVERITY、 | ||||
| priorityName | String |
41.8.7.3. ProtobufAny リンクのコピーリンクがクリップボードにコピーされました!
any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。
Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または 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 として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。
41.8.7.3.1. 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 を保持するフィールド 値 が追加されます。例(メッセージ [google.protobuf.Duration][] の場合):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| typeUrl | String |
シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( | |||
| value | byte[] | 上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。 | byte |
41.8.7.4. RuntimeError リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | ProtobufAnyのリスト |
41.8.7.5. StorageAWSSecurityHub リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| region | String | ||||
| credentials | |||||
| accountId | String |
41.8.7.6. StorageAWSSecurityHubCredentials リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| accessKeyId | String | ||||
| secretAccessKey | String | ||||
| stsEnabled | Boolean |
41.8.7.7. StorageCSCC リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| serviceAccount | String | インテグレーションのサービスアカウント。サーバーは、応答とログでこの認証情報の値をマスクします。 | |||
| sourceId | String | ||||
| wifEnabled | Boolean |
41.8.7.8. StorageEmail リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| server | String | ||||
| sender | String | ||||
| username | String | ||||
| password | String | インテグレーションのパスワード。サーバーは、応答とログでこの認証情報の値をマスクします。 | |||
| disableTLS | Boolean | ||||
| DEPRECATEDUseStartTLS | Boolean | ||||
| from | String | ||||
| startTLSAuthMethod | DISABLED、PLAIN、LOGIN | ||||
| allowUnauthenticatedSmtp | Boolean |
41.8.7.9. StorageGeneric リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| endpoint | String | ||||
| skipTLSVerify | Boolean | ||||
| caCert | String | ||||
| username | String | ||||
| password | String | インテグレーションのパスワード。サーバーは、応答とログでこの認証情報の値をマスクします。 | |||
| headers | |||||
| extraFields | |||||
| auditLoggingEnabled | Boolean |
41.8.7.10. StorageJira リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| url | String | ||||
| username | String | ||||
| password | String | インテグレーションのパスワード。サーバーは、応答とログでこの認証情報の値をマスクします。 | |||
| issueType | String | ||||
| priorityMappings | |||||
| defaultFieldsJson | String | ||||
| disablePriority | Boolean |
41.8.7.11. StorageKeyValuePair リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| key | String | ||||
| value | String |
41.8.7.12. StorageNotifier リンクのコピーリンクがクリップボードにコピーされました!
Next Tag: 19
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| type | String | ||||
| uiEndpoint | String | ||||
| labelKey | String | ||||
| labelDefault | String | ||||
| Jira | |||||
| | |||||
| cscc | |||||
| splunk | |||||
| PagerDuty | |||||
| generic | |||||
| Sumologic | |||||
| awsSecurityHub | |||||
| syslog | |||||
| notifierSecret | String | ||||
| traits |
41.8.7.13. StoragePagerDuty リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| apiKey | String | インテグレーションの API キー。サーバーは、応答とログでこの認証情報の値をマスクします。 |
41.8.7.14. StorageSeverity リンクのコピーリンクがクリップボードにコピーされました!
| Enum 値 |
|---|
| UNSET_SEVERITY |
| LOW_SEVERITY |
| MEDIUM_SEVERITY |
| HIGH_SEVERITY |
| CRITICAL_SEVERITY |
41.8.7.15. StorageSplunk リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| httpToken | String | インテグレーションの HTTP トークン。サーバーは、応答とログでこの認証情報の値をマスクします。 | |||
| httpEndpoint | String | ||||
| insecure | Boolean | ||||
| truncate | String | int64 | |||
| auditLoggingEnabled | Boolean | ||||
| derivedSourceType | Boolean | ||||
| sourceTypes |
|
41.8.7.16. StorageSumoLogic リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| httpSourceAddress | String | ||||
| skipTLSVerify | Boolean |
41.8.7.17. StorageSyslog リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| localFacility | LOCAL0、LOCAL1、LOCAL3、LOCAL4、LOCAL5、LOCAL6、LOCAL7、 | ||||
| tcpConfig | |||||
| extraFields | |||||
| messageFormat | LEGACY、CEF、 |
41.8.7.18. StorageTraits リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
| visibility | VISIBLE、HIDDEN、 | ||||
| origin | 命令、デフォルト、宣言的、DECLARATIVE_ORPHANED |
41.8.7.19. SyslogLocalFacility リンクのコピーリンクがクリップボードにコピーされました!
| Enum 値 |
|---|
| LOCAL0 |
| LOCAL1 |
| LOCAL2 |
| LOCAL3 |
| LOCAL4 |
| LOCAL5 |
| LOCAL6 |
| LOCAL7 |
41.8.7.20. SyslogMessageFormat リンクのコピーリンクがクリップボードにコピーされました!
| Enum 値 |
|---|
| LEGACY |
| CEF |
41.8.7.21. SyslogTCPConfig リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| hostname | String | ||||
| port | Integer | int32 | |||
| skipTlsVerify | Boolean | ||||
| useTls | Boolean |
41.8.7.22. TraitsMutabilityMode リンクのコピーリンクがクリップボードにコピーされました!
実験的注記:当面は、MutabilityMode の使用を参照してください。これは今後置き換えられる予定です(ROX-14276)。MutabilityMode は、オブジェクトを変更するかどうか、およびその方法を指定します。デフォルトは ALLOW_MUTATE であり、変更制限がないことを意味します。これは、MutabilityMode 仕様がないことと同等です。ALLOW_MUTATE_FORCED は、force ビットでのオブジェクト削除以外のすべての変更操作を禁止します。
このフィールドの状態を変更するときは注意してください。たとえば、オブジェクトを ALLOW_MUTATE から ALLOW_MUTATE_FORCED に変更することは許可されますが、これを変更すると、ALLOW_MUTATE に戻すなど、それ以降の変更はできなくなります。
| Enum 値 |
|---|
| ALLOW_MUTATE |
| ALLOW_MUTATE_FORCED |
41.8.7.23. TraitsOrigin リンクのコピーリンクがクリップボードにコピーされました!
origin は、オブジェクトの発信元を指定します。オブジェクトには、発信元を 4 つ持つことができます:- IMPERATIVE: オブジェクトは API 経由で作成されました。これはデフォルトで仮定されます。- DEFAULT: オブジェクトは、デフォルトのロール、アクセススコープなどのデフォルトオブジェクトです。DECLARATIVE: オブジェクトは宣言型設定を使用して作成されます。- DECLARATIVE_ORPHANED: オブジェクトは宣言型設定によって作成され、(たとえば、別のオブジェクトで参照されるため)作成元に基づいて別のルールがオブジェクトに適用されます。DECLARATIVE オリジンを持つオブジェクトは、宣言的設定を介してのみ API 経由で変更することはできません。さらに、IMPERATIVE オリジンを使用してオブジェクトを参照することはできません。DEFAULT オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更することはできません。それらは他のすべてのオブジェクトで参照できます。IMPERATIVE オリジンを持つオブジェクトは、宣言的設定ではなく、API を介して変更できます。これらは他のすべてのオブジェクトを参照することができます。DECLARATIVE_ORPHANED オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更できません。DECLARATIVE_ORPHANED リソースは、宣言的な設定で再定義されると、DECLARATIVE が再び DECLARATIVE になる可能性があります。この元のオブジェクトでは、他のリソースが参照されていない直後にシステムからクリーンアップされます。それらは他のすべてのオブジェクトで参照できます。
| Enum 値 |
|---|
| 命令 |
| デフォルト |
| 宣言的 |
| DECLARATIVE_ORPHANED |
41.8.7.24. TraitsVisibility リンクのコピーリンクがクリップボードにコピーされました!
EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。
| Enum 値 |
|---|
| VISIBLE |
| HIDDEN |
41.8.7.25. V1UpdateNotifierRequest リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| notifier | |||||
| updatePassword | Boolean | false の場合、その ID を指定して既存のノーティファイアー設定の保存された認証情報を使用します。 |