ジャンプ先

• リクエスト
• レスポンス

このSAFエラー処理の表示

get

/management/weblogic/{version}/serverConfig/resourceGroupTemplates/{name}/JMSSystemResources/{name}/JMSResource/SAFErrorHandlings/{name}

このSAFエラー処理を表示します。

リクエスト

パス・パラメータ

• name: string
  コレクション内のインスタンスのnameプロパティ。
• version: string
  WebLogic RESTインタフェースのバージョン。

問合せパラメータ

• excludeFields(optional): string
  'excludeFields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前がリストにないフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('fields'問合せパラメータが指定されていない場合)。ノート: 'excludeFields'が指定されている場合、'fields'を指定しないでください。
• excludeLinks(optional): string
  'excludeLinks'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名がリストにないリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('links'問合せパラメータが指定されていない場合)。ノート: 'excludeLinks'が指定されている場合、'links'を指定しないでください。
• fields(optional): string
  'fields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前が一致するフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('excludeFields'問合せパラメータが指定されていない場合)。ノート: 'fields'が指定されている場合、'excludeFields'を指定しないでください。
• links(optional): string
  'links'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名が一致するリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('excludeLinks'問合せパラメータが指定されていない場合)。ノート: 'links'が指定されている場合、'excludeLinks'を指定しないでください。

セキュリティ

• Admin: basic
  型: Basic

  説明: A user in the Admin security role.
• デプロイヤ: 基本
  型: Basic

  説明: A user in the Deployer security role.
• モニター: 基本
  型: Basic

  説明: A user in the Monitor security role.
• オペレータ: 基本
  型: Basic

  説明: A user in the Operator security role.

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

このSAFエラー処理を返します。

このメソッドは次のリンクを返すことができます。

• rel=SAFErrorDestination

  SAF宛先リソースへのこのリソースのSAFErrorDestination参照。

本文()

ルート・スキーマ: SAFエラー処理

型: object

ソースの表示

• id(optional): integer(int64)
  読取り専用: true

  このBeanインスタンスの一意の識別子を返します。

• logFormat(optional): string

  「メッセージ処理ポリシー」が「ログ」に設定されている場合の情報のロギング方法を指定します

  このパラメータに対する変更は、受信するメッセージにのみ影響します。格納されているメッセージには影響しません。

  有効な値は、次のとおりです。

  • %header% - すべてのJMSヘッダー・フィールドがログに記録されます。

  • %properties% - すべてのユーザー定義プロパティがログに記録されます。

  • JMSDeliveryTime - このWebLogic JMS固有の拡張ヘッダー・フィールドがログに記録されます。

  • JMSRedeliveryLimit - このWebLogic JMS固有の拡張ヘッダー・フィールドがログに記録されます。

  • foo - すべての有効なJMSヘッダー・フィールドまたはユーザー定義プロパティがログに記録されます。

  複数の値を指定する場合は、値をカンマ区切りのリストとして入力します。%header%と%properties% の値では、大文字と小文字は区別されません。たとえば、すべてのJMSヘッダー・フィールドとユーザー・プロパティを指定する場合は、"%header%,%properties%"という値にします。ただし、個々のJMSヘッダー・フィールドおよびユーザー定義プロパティの列挙値では、大文字と小文字が区別されます。個別のJMSヘッダー・フィールドのみを列挙するには、"%header, name, address, city, state, zip"と指定します。

  ノート: JMSMessageIDフィールドは常にログに書き込まれ、無効にはできません。したがって、「ログ・フォーマット」が未定義(つまりnull)であるか、または空の文字列として定義されている場合は、ログ・ファイルへの出力にはメッセージのJMSMessageIDのみが含まれます。

• name(optional): string
  読取り専用: true

  このエンティティの名前。XMLでは属性として示されます。

  JMSモジュール内の要素の多くは名前付きのエンティティです。XMLファイル内で、ある型に含まれる名前付きエンティティは、すべて一意でなければなりません。これは、JMSモジュール内で特定のエンティティを区別するための識別子です。

  この属性は、モジュールの内部で参照される可能性があるため、モジュールの外から(たとえば、デプロイメント・プランで)変更することはできません。

  制約

  • 有効なnull
• notes(optional): string

  この名前付きJMSディスクリプタBeanの説明に含めることのできるオプションの情報。

  JMSモジュールはこのノートをJMSディスクリプタ・ファイルにXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity <)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。

  ノート:

  管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。

• policy(optional): string
  デフォルト値: Discard

  使用可能な値: [ "Discard", "Log", "Redirect", "Always-Forward" ]

  このSAFエラー処理リソースのエラー処理ポリシー。

  • 「破棄」- デフォルトでは、期限切れのメッセージは単にシステムから削除されます。削除はログに記録されず、メッセージは別の場所にリダイレクトされません。

  • 「ログ」- 期限切れのメッセージを削除し、メッセージがシステムから削除されたことを示すエントリをサーバー・ログ・ファイルに書き込みます。実際にログに記録される情報は、「ログ・フォーマット」フィールドで定義します。

  • 「リダイレクト」- 期限切れのメッセージを現在の位置から、インポート済みのSAF宛先に定義されているエラー宛先へ移動します。

  • 「常に転送」- インポート済みの宛先に対して設定されたSAFデフォルト存続時間と、メッセージに対して設定された存続時間を無視するので、期限が切れた後でもメッセージをリモート宛先へ転送します。

  このパラメータに対する変更は、受信するメッセージにのみ影響します。格納されているメッセージには影響しません。

  制約

  • 有効なnull
• SAFErrorDestination(optional): array SAF宛先参照
  タイトル: SAF Destination Reference

  SAF宛先参照が含まれます。

  PolicyがRedirectに設定されている場合のエラー宛先を指定します

  このパラメータに対する変更は、受信するメッセージにのみ影響します。格納されているメッセージには影響しません。

  制約

  • 再起動が必要

{
    "type":"object",
    "properties":{
        "SAFErrorDestination":{
            "x-weblogic-restartRequired":true,
            "title":"SAF Destination Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the SAF destination reference. <p>Specifies the error destination when <code>Policy</code> is set to <code>Redirect</code></p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</p>"
        },
        "logFormat":{
            "type":"string",
            "description":"<p>Specifies how information is logged when <code>Message Handling Policy</code> is set to <code>Log</code></p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p>The valid values are:</p><ul><li><p><b>%header%</b> - All JMS header fields are logged.</p></li><li><p><b>%properties%</b> - All user-defined properties are logged.</p></li><li><p><b>JMSDeliveryTime</b> - This WebLogic JMS-specific extended header field is logged.</p></li><li><p><b>JMSRedeliveryLimit</b> - This WebLogic JMS-specific extended header field is logged.</p></li><li><p><b><i>foo</i></b> - Any valid JMS header field or user-defined property is logged.</p></li></ul><p>When specifying multiple values, enter them as a comma-separated list. The <code>%header%</code> and <code>%properties% </code> values are <i>not</i> case sensitive. For example, you could use <code>\"%header%,%properties%\"</code> for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use <code>\"%header, name, address, city, state, zip\"</code></p><p><b>Note:</b> The <code>JMSMessageID</code> field is always logged and cannot be turned off. Therefore, if the Log Format is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the <code>JMSMessageID</code> of the message. </p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The name of this entity, represented in XML as an attribute.</p><p> Many of the elements within the JMS module are named entities.  All of the named entities encased by a type in the XML file must be unique.  This is the identifier used to delineate a particular entity within the JMS module. </p><p> This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially. </p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this named JMS descriptor bean.</p><p>JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><dl><dt>Note:</dt><dd><p>If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p></dd></dl>"
        },
        "policy":{
            "default":"Discard",
            "enum":[
                "Discard",
                "Log",
                "Redirect",
                "Always-Forward"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The error handling policy for this SAF error handling resource.</p><ul><li><p> Discard - By default, expired messages are simply removed from the system. The removal is not logged and the message is not redirected to another location.</p></li><li><p> Log - Removes expired messages and writes an entry to the server log file indicating that the messages were removed from the system. You define the actual information that will be logged in the Log Format field.</p></li><li><p> Redirect - Moves expired messages from their current location into the Error Destination defined for imported SAF destinations.</p></li><li><p> Always-Forward - Ignores the SAF Default Time-to-Live value set on the imported destination and the expiration time set on the message, and so forwards the message to a remote destination even after it has expired.</p></li></ul><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        }
    },
    "description":""
}

ネストされたスキーマ: SAF宛先参照

型: array

タイトル: SAF Destination Reference

SAF宛先参照が含まれます。

PolicyがRedirectに設定されている場合のエラー宛先を指定します

このパラメータに対する変更は、受信するメッセージにのみ影響します。格納されているメッセージには影響しません。

制約

• 再起動が必要

ソースの表示

• 配列: string

{
    "x-weblogic-restartRequired":true,
    "title":"SAF Destination Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the SAF destination reference. <p>Specifies the error destination when <code>Policy</code> is set to <code>Redirect</code></p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

先頭に戻る