41.4. PutNotifier


PUT /v1/notifiers/{id}

PutNotifier は、保存された認証情報の調整を使用せずに、特定の通知機能を変更します。

41.4.1. 説明

41.4.2. パラメーター

41.4.2.1. パスパラメーター

Expand
名前説明必須デフォルトPattern

id

 

X

null

 

41.4.2.2. ボディパラメーター

Expand
名前説明必須デフォルトPattern

body

StorageNotifier

X

  

41.4.3. 戻り値のタイプ

Object

41.4.4. コンテンツタイプ

  • application/json

41.4.5. レスポンス

Expand
表41.4 HTTP 応答コード
コードメッセージデータタイプ

200

正常な応答。

Object

0

予期しないエラーの応答です。

RuntimeError

41.4.6. サンプル

41.4.7. 共通のオブジェクト参照

41.4.7.1. EmailAuthMethod

Expand
Enum 値

DISABLED

PLAIN

ログイン

41.4.7.2. JiraPriorityMapping

Expand
フィールド名必須Null 許容型説明形式

severity

  

StorageSeverity

 

UNSET_SEVERITY、LOW_SEVERITY、MEDIUM_SEVERITY、HIGH_SEVERITY、CRITICAL_SEVERITY、

priorityName

  

String

  

41.4.7.3. ProtobufAny

any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。

Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}
Copy to Clipboard Toggle word wrap

例 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());
}
Copy to Clipboard Toggle word wrap
Example 3: Pack and unpack a message in Python.
Copy to Clipboard Toggle word wrap
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Copy to Clipboard Toggle word wrap
Example 4: Pack and unpack a message in Go
Copy to Clipboard Toggle word wrap
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}
Copy to Clipboard Toggle word wrap

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.4.7.3.1. JSON 表現

Any 値の JSON 表現は、デシリアライズされた埋め込みメッセージの通常の表現を使用し、タイプ URL が含まれる追加のフィールド @type を使用します。以下に例を示します。

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

埋め込みメッセージタイプがよく知られていて、カスタム JSON 表現がある場合、その表現は埋め込みされ、@type フィールドに加えてカスタム JSON を保持するフィールド が追加されます。例(メッセージ [google.protobuf.Duration][] の場合):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Copy to Clipboard Toggle word wrap
Expand
フィールド名必須Null 許容型説明形式

typeUrl

  

String

シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( path/google.protobuf.Durationにあるように)を表す必要があります。名前は正規の形式である必要があります(たとえば、先頭 \".\" は受け入れられません)。実際には、チームは通常、バイナリーにプリコンパイルして、任意 のコンテキストで使用することを期待しているすべてのタイプにプレコンパイルします。ただし、スキーム httphttps、またはスキームを使用しない URL の場合、以下のようにタイプ URL をメッセージ定義にマップするタイプサーバーを設定できます。* スキームが指定されていない場合、https は想定されます。* URL の HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成するか、エラーを生成する必要があります。* アプリケーションは、URL に基づいてルックアップ結果をキャッシュするか、ルックアップを回避するためにバイナリーにプリコンパイルして使用できます。したがって、タイプへの変更時にバイナリー互換性を保持する必要があります。(バージョン付けされたタイプ名を使用して、重大な変更を管理します。)注記:この機能は現在、公式の protobuf リリースでは利用できないため、type.googleapis.com で始まるタイプ URL には使用されません。2023 年 5 月時点では、広く使用されているタイプサーバー実装はもう 1 つも実装する予定はありません。http 以外のスキーム、https (または空のスキーム)は、実装固有のセマンティクスで使用できます。

 

value

  

byte[]

上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。

byte

41.4.7.4. RuntimeError

Expand
フィールド名必須Null 許容型説明形式

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

ProtobufAnyのリスト

  

41.4.7.5. StorageAWSSecurityHub

Expand
フィールド名必須Null 許容型説明形式

region

  

String

  

credentials

  

StorageAWSSecurityHubCredentials

  

accountId

  

String

  

41.4.7.6. StorageAWSSecurityHubCredentials

Expand
フィールド名必須Null 許容型説明形式

accessKeyId

  

String

  

secretAccessKey

  

String

  

stsEnabled

  

Boolean

  

41.4.7.7. StorageCSCC

Expand
フィールド名必須Null 許容型説明形式

serviceAccount

  

String

インテグレーションのサービスアカウント。サーバーは、応答とログでこの認証情報の値をマスクします。

 

sourceId

  

String

  

wifEnabled

  

Boolean

  

41.4.7.8. StorageEmail

Expand
フィールド名必須Null 許容型説明形式

server

  

String

  

sender

  

String

  

username

  

String

  

password

  

String

インテグレーションのパスワード。サーバーは、応答とログでこの認証情報の値をマスクします。

 

disableTLS

  

Boolean

  

DEPRECATEDUseStartTLS

  

Boolean

  

from

  

String

  

startTLSAuthMethod

  

EmailAuthMethod

 

DISABLED、PLAIN、LOGIN

allowUnauthenticatedSmtp

  

Boolean

  

41.4.7.9. StorageGeneric

Expand
フィールド名必須Null 許容型説明形式

endpoint

  

String

  

skipTLSVerify

  

Boolean

  

caCert

  

String

  

username

  

String

  

password

  

String

インテグレーションのパスワード。サーバーは、応答とログでこの認証情報の値をマスクします。

 

headers

  

StorageKeyValuePairの一覧

  

extraFields

  

StorageKeyValuePairの一覧

  

auditLoggingEnabled

  

Boolean

  

41.4.7.10. StorageJira

Expand
フィールド名必須Null 許容型説明形式

url

  

String

  

username

  

String

  

password

  

String

インテグレーションのパスワード。サーバーは、応答とログでこの認証情報の値をマスクします。

 

issueType

  

String

  

priorityMappings

  

JiraPriorityMappingのリスト

  

defaultFieldsJson

  

String

  

disablePriority

  

Boolean

  

41.4.7.11. StorageKeyValuePair

Expand
フィールド名必須Null 許容型説明形式

key

  

String

  

value

  

String

  

41.4.7.12. StorageNotifier

Next Tag: 19
Copy to Clipboard Toggle word wrap
Expand
フィールド名必須Null 許容型説明形式

id

  

String

  

name

  

String

  

type

  

String

  

uiEndpoint

  

String

  

labelKey

  

String

  

labelDefault

  

String

  

Jira

  

StorageJira

  

email

  

StorageEmail

  

cscc

  

StorageCSCC

  

splunk

  

StorageSplunk

  

PagerDuty

  

StoragePagerDuty

  

generic

  

StorageGeneric

  

Sumologic

  

StorageSumoLogic

  

awsSecurityHub

  

StorageAWSSecurityHub

  

syslog

  

StorageSyslog

  

notifierSecret

  

String

  

traits

  

StorageTraits

  

41.4.7.13. StoragePagerDuty

Expand
フィールド名必須Null 許容型説明形式

apiKey

  

String

インテグレーションの API キー。サーバーは、応答とログでこの認証情報の値をマスクします。

 

41.4.7.14. StorageSeverity

Expand
Enum 値

UNSET_SEVERITY

LOW_SEVERITY

MEDIUM_SEVERITY

HIGH_SEVERITY

CRITICAL_SEVERITY

41.4.7.15. StorageSplunk

Expand
フィールド名必須Null 許容型説明形式

httpToken

  

String

インテグレーションの HTTP トークン。サーバーは、応答とログでこの認証情報の値をマスクします。

 

httpEndpoint

  

String

  

insecure

  

Boolean

  

truncate

  

String

 

int64

auditLoggingEnabled

  

Boolean

  

derivedSourceType

  

Boolean

  

sourceTypes

  

文字列のマップ

  

41.4.7.16. StorageSumoLogic

Expand
フィールド名必須Null 許容型説明形式

httpSourceAddress

  

String

  

skipTLSVerify

  

Boolean

  

41.4.7.17. StorageSyslog

Expand
フィールド名必須Null 許容型説明形式

localFacility

  

SyslogLocalFacility

 

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

tcpConfig

  

SyslogTCPConfig

  

extraFields

  

StorageKeyValuePairの一覧

  

messageFormat

  

SyslogMessageFormat

 

LEGACY、CEF、

41.4.7.18. StorageTraits

Expand
フィールド名必須Null 許容型説明形式

mutabilityMode

  

TraitsMutabilityMode

 

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

visibility

  

TraitsVisibility

 

VISIBLE、HIDDEN、

origin

  

TraitsOrigin

 

命令、デフォルト、宣言的、DECLARATIVE_ORPHANED

41.4.7.19. SyslogLocalFacility

Expand
Enum 値

LOCAL0

LOCAL1

LOCAL2

LOCAL3

LOCAL4

LOCAL5

LOCAL6

LOCAL7

41.4.7.20. SyslogMessageFormat

Expand
Enum 値

LEGACY

CEF

41.4.7.21. SyslogTCPConfig

Expand
フィールド名必須Null 許容型説明形式

hostname

  

String

  

port

  

Integer

 

int32

skipTlsVerify

  

Boolean

  

useTls

  

Boolean

  

41.4.7.22. TraitsMutabilityMode

実験的注記:当面は、MutabilityMode の使用を参照してください。これは今後置き換えられる予定です(ROX-14276)。MutabilityMode は、オブジェクトを変更するかどうか、およびその方法を指定します。デフォルトは ALLOW_MUTATE であり、変更制限がないことを意味します。これは、MutabilityMode 仕様がないことと同等です。ALLOW_MUTATE_FORCED は、force ビットでのオブジェクト削除以外のすべての変更操作を禁止します。

このフィールドの状態を変更するときは注意してください。たとえば、オブジェクトを ALLOW_MUTATE から ALLOW_MUTATE_FORCED に変更することは許可されますが、これを変更すると、ALLOW_MUTATE に戻すなど、それ以降の変更はできなくなります。

Expand
Enum 値

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

41.4.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 になる可能性があります。この元のオブジェクトでは、他のリソースが参照されていない直後にシステムからクリーンアップされます。それらは他のすべてのオブジェクトで参照できます。

Expand
Enum 値

命令

デフォルト

宣言的

DECLARATIVE_ORPHANED

41.4.7.24. TraitsVisibility

EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。

Expand
Enum 値

VISIBLE

HIDDEN

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat