ジャンプ先

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

この配信失敗パラメータの表示

get

/management/weblogic/{version}/serverConfig/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/uniformDistributedQueues/{name}/deliveryFailureParams

この配信失敗パラメータを表示します。

リクエスト

パス・パラメータ

• 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レスポンス

この配信失敗パラメータを返します。

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

• rel=action title=findSubDeploymentName uri=/management/weblogic/{version}/serverConfig/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/uniformDistributedQueues/{name}/deliveryFailureParams/findSubDeploymentName

  このリソースのfindSubDeploymentNameアクション・リソース。

• rel=errorDestination

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

• rel=templateBean

  テンプレート・リソースへのこのリソースのtemplateBean参照。

本文()

ルート・スキーマ: 配信失敗パラメータ

型: object

ソースの表示

• errorDestination(optional): array 宛先参照
  タイトル: Destination Reference

  宛先参照が含まれます。

  期限切れになった、または再配信の制限に達したメッセージのターゲット・エラー宛先の名前。エラー宛先が構成されていない場合、メッセージはそのまま破棄されます。メッセージが期限切れになっている、または再配信の制限に達していて「有効期限ポリシー」が「リダイレクト」に設定されている場合、メッセージは指定された「エラー宛先」に移動します。

  スタンドアロンの宛先の場合、エラー宛先は、そのエラー宛先が定義されている宛先と同じJMSサーバーにターゲット指定される別のスタンドアロンの宛先である必要があります。共通分散宛先(UDD)の場合、エラー宛先は、現在のUDDと同じサブデプロイメント(つまりターゲット)を共有する別のUDDである必要があります。

  この属性は動的に構成できますが、新しく配信されるメッセージにのみ適用され、すでに保存されているメッセージには影響しません。

• expirationLoggingPolicy(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@6dfa9bab

  「有効期限ポリシー」が「ログ」に設定されている場合に、メッセージに関するどのような情報を記録するかを定義するポリシー。有効なロギング・ポリシーの値は次のとおりです。

  • %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のみが含まれます。

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

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

  宛先で期限切れメッセージに遭遇したときに使用するメッセージの有効期限ポリシー。有効な有効期限ポリシーは次のとおりです。

  「なし」-「破棄」ポリシーと同じ。期限切れのメッセージは単に宛先から削除されます。

  「破棄」- メッセージング・システムから期限切れのメッセージを削除します。削除はログに記録されず、メッセージは別の場所にリダイレクトされません。指定の宛先に値を定義しない場合(つまり、「なし」)、期限切れのメッセージは破棄されます。

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

  「リダイレクト」- 期限切れのメッセージを現在の位置から、宛先に定義されているエラー宛先へ移動します。メッセージの本体とすべてのプロパティは保持されます。また、次の例外を除きメッセージのヘッダー・フィールドもすべて保持されます。

  • メッセージの宛先はエラー宛先になります。

  • エラー宛先に関連するプロパティのオーバーライドは、すべてリダイレクト対象のメッセージに適用されます。

  • 「存続時間のオーバーライド」の値がエラー宛先に設定されていない場合、メッセージは新しい有効期限の値0を受け取ります(つまり、再び期限切れになりません)。

  宛先に有効なエラー宛先が定義されていない場合、「リダイレクト」ポリシーは使用できません。また、「リダイレクト」ポリシーを使用している宛先に対して、エラー宛先を削除することはできません。

  ノート: 最大メッセージ割当ては、新しいメッセージが送信される場合にのみ強制されます。「リダイレクト」ポリシーによりメッセージが移動される場合、これは無視されます。

• redeliveryLimit(optional): integer(int32)
  最小値: -1

  最大値: 2147483647

  デフォルト値: -1

  メッセージがエラー宛先に移動する前に再配信を試行できる回数。この設定は、メッセージの送信側で設定された再配信の上限をオーバーライドします。再配信の上限が構成されているものの、エラー宛先が構成されていない場合、永続および非永続メッセージは、再配信の上限に達すると、単純にドロップ(削除)されます。

  デフォルト値(-1)は、メッセージ送信側の再配信の上限設定を宛先でオーバーライドしないことを指定します。

  ノート: WebLogic Serverでは、メッセージの配信試行回数(1回目の試行を1とし、その後2、3、...と続く)を指定するJMSXDeliveryCountメッセージ・プロパティがサポートされています。配信回数の保持に最善を尽くすため、配信回数はサーバーの再起動後も1にリセットされません。

  この属性は動的に構成可能ですが、変更内容は、これから受信するメッセージにのみ影響し、すでに送信されているメッセージは、元の再配信の上限を引き続き使用します。

• templateBean(optional): array テンプレート参照
  タイトル: Template Reference

  読取り専用: true

  テンプレート参照が含まれます。

  これは、この宛先のテンプレートBeanの検索に使用します

{
    "type":"object",
    "properties":{
        "errorDestination":{
            "title":"Destination Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the destination reference. <p>The name of the target error destination for messages that have expired or reached their redelivery limit. If no error destination is configured, then such messages are simply dropped. If a message has expired or reached its redelivery limit, and the Expiration Policy is set to Redirect, then the message is moved to the specified Error Destination.</p><p>For standalone destinations, an error destination must be another standalone destination that is targeted to the same JMS server as the destinations for which the error destination is defined. For uniform distributed destinations (UDDs), the error destination must be another UDD that shares the same subdeployment (i.e., targets) as the current UDD.</p><p>This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.</p>"
        },
        "expirationLoggingPolicy":{
            "default":null,
            "type":"string",
            "description":"<p>The policy that defines what information about the message is logged when the Expiration Policy is set to Log. The valid logging policy 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 Expiration Logging Policy 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>"
        },
        "expirationPolicy":{
            "default":"Discard",
            "enum":[
                "Discard",
                "Log",
                "Redirect"
            ],
            "type":"string",
            "description":"<p>The message Expiration Policy to use when an expired message is encountered on a destination. The valid expiration policies are:</p><p><b>None</b> - Same as the Discard policy; expired messages are simply removed from the destination.</p><p><b>Discard</b> - Removes expired messages from the messaging system. The removal is not logged and the message is not redirected to another location. If no value is defined for a given destination (i.e., None), then expired messages are discarded.</p><p><b>Log</b> - Removes expired messages from the system and writes an entry to the server log file indicating that the messages have been removed from the system. The actual information that is logged is defined by the Expiration Logging Policy.</p><p><b>Redirect</b> - Moves expired messages from their current location to the Error Destination defined for the destination. The message retains its body, and all of its properties. The message also retains all of its header fields, but with the following exceptions:</p><ul><li><p> The destination for the message becomes the error destination.</p></li><li><p> All property overrides associated with the error destination are applied to the redirected message.</p></li><li><p> If there is no Time-To-Live Override value for the error destination, then the message receives a new Expiration Time of zero (indicating that it will not expire again).</p></li></ul><p>It is illegal to use the Redirect policy when there is no valid error destination defined for the destination. Similarly, it is illegal to remove the error destination for a destination that is using the Redirect policy.</p><p><b>Note:</b> The Maximum Message quota is only enforced for sending new messages. It is ignored when moving messages because of the Redirect policy.</p>"
        },
        "redeliveryLimit":{
            "default":-1,
            "minimum":-1,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of redelivery tries a message can have before it is moved to the error destination. This setting overrides any redelivery limit set by the message sender. If the redelivery limit is configured, but no error destination is configured, then persistent and non-persistent messages are simply dropped (deleted) when they reach their redelivery limit.</p><p>The default value (-1) specifies that the destination will not override the message sender's redelivery limit setting. </p><p><b>Note:</b> WebLogic Server supports the JMSXDeliveryCount message property, which specifies the number of message delivery attempts, where the first attempt is 1, the next attempt is 2, and so on. WebLogic Server makes a best effort to persist the delivery count, so that the delivery count does not reset back to 1 after a server reboot.</p><p>This attribute is dynamically configurable, but only incoming messages are impacted; previously sent messages continue to use their original redelivery limit.</p>"
        },
        "templateBean":{
            "readOnly":true,
            "title":"Template Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the template reference. <p>This is used to find the template bean for this destination</p>"
        }
    },
    "description":""
}

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

型: array

タイトル: Destination Reference

宛先参照が含まれます。

期限切れになった、または再配信の制限に達したメッセージのターゲット・エラー宛先の名前。エラー宛先が構成されていない場合、メッセージはそのまま破棄されます。メッセージが期限切れになっている、または再配信の制限に達していて「有効期限ポリシー」が「リダイレクト」に設定されている場合、メッセージは指定された「エラー宛先」に移動します。

スタンドアロンの宛先の場合、エラー宛先は、そのエラー宛先が定義されている宛先と同じJMSサーバーにターゲット指定される別のスタンドアロンの宛先である必要があります。共通分散宛先(UDD)の場合、エラー宛先は、現在のUDDと同じサブデプロイメント(つまりターゲット)を共有する別のUDDである必要があります。

この属性は動的に構成できますが、新しく配信されるメッセージにのみ適用され、すでに保存されているメッセージには影響しません。

ソースの表示

• 配列: string

{
    "title":"Destination Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the destination reference. <p>The name of the target error destination for messages that have expired or reached their redelivery limit. If no error destination is configured, then such messages are simply dropped. If a message has expired or reached its redelivery limit, and the Expiration Policy is set to Redirect, then the message is moved to the specified Error Destination.</p><p>For standalone destinations, an error destination must be another standalone destination that is targeted to the same JMS server as the destinations for which the error destination is defined. For uniform distributed destinations (UDDs), the error destination must be another UDD that shares the same subdeployment (i.e., targets) as the current UDD.</p><p>This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.</p>"
}

ネストされたスキーマ: テンプレート参照

型: array

タイトル: Template Reference

読取り専用: true

テンプレート参照が含まれます。

これは、この宛先のテンプレートBeanの検索に使用します

ソースの表示

• 配列: string

{
    "readOnly":true,
    "title":"Template Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the template reference. <p>This is used to find the template bean for this destination</p>"
}

先頭に戻る