ジャンプ先

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

このSAFキューの表示

get

/management/weblogic/{version}/serverConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/SAFImportedDestinations/{name}/SAFQueues/{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

  説明: Adminセキュリティ・ロールのユーザー。
• Deployer: basic
  型: basic

  説明: Deployerセキュリティ・ロールのユーザー。
• Monitor: basic
  型: basic

  説明: Monitorセキュリティ・ロールのユーザー。
• Operator: basic
  型: basic

  説明: Operatorセキュリティ・ロールのユーザー。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

このSAFキューを返します。

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

• rel=SAFErrorHandling

  SAFエラー処理リソースへのこのリソースのSAFErrorHandling参照。

• rel=messageLoggingParams uri=/management/weblogic/{version}/serverConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/SAFImportedDestinations/{name}/SAFQueues/{name}/messageLoggingParams

  このリソースのmessageLoggingParamsシングルトン・リソース。

本文 ()

ルート・スキーマ: SAF Queue

型: object

ソースを表示

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

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

• localJNDIName(optional): string

  リモート宛先のローカルJNDI名。

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

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

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

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

  制約

  • 有効なnull
• nonPersistentQos(optional): string
  デフォルト値: At-Least-Once

  指定可能な値: [ "At-Most-Once", "At-Least-Once", "Exactly-Once" ]

  非永続メッセージのサービスの品質を指定します。

  • 「必ず1回」の場合、メッセージは、サーバーのクラッシュが発生した場合を除いて、リモート側に1回のみ転送されます。

  • 「1回以上」の場合、メッセージはリモート側に1回以上転送されます。サーバーのクラッシュが発生した場合を除いて、メッセージは失われません。ただし、メッセージはリモート・エンドポイントに複数回現れる可能性があります。

  • 「最大1回」の場合、メッセージはリモート側に最大1回転送されます。メッセージがリモート・エンドポイントに複数回現れることはありません。ただし、メッセージは失われる可能性があります。

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

  制約

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

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

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

  ノート:

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

• persistentQos(optional): string
  デフォルト値: Exactly-Once

  指定可能な値: [ "At-Most-Once", "At-Least-Once", "Exactly-Once" ]

  永続メッセージのサービスの品質を指定します。

  • 「必ず1回」の場合、メッセージは、リモート側に1回のみ転送されます

  • 「1回以上」の場合、メッセージはリモート側に1回以上転送されます。メッセージはリモート・エンドポイントに複数回現れることがあります。

  • 「最大1回」の場合、メッセージはリモート側に最大1回転送されます。メッセージがリモート・エンドポイントに複数回現れることはありません。ただし、メッセージは失われる可能性があります。

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

  制約

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

  リモート宛先のリモートJNDI名。

• SAFErrorHandling(optional): array SAF Error Handling Reference
  タイトル: SAF Error Handling Reference

  SAFエラー処理参照が含まれます。

  このSAF宛先で使用するエラー処理構成を指定します。

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

  制約

  • 再起動が必要
• timeToLiveDefault(optional): integer(int64)
  最小値: -1

  インポートされるJMSメッセージのデフォルトの生存時間の値をミリ秒単位で指定します。JMSメッセージに対して設定された存続時間はこの値をオーバーライドします。ただし、SAFデフォルト存続時間の有効化フィールドがオンになっている場合は除きます。その場合は、インポートされる宛先に対するJMSメッセージの存続時間がオーバーライドされます。

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

• unitOfOrderRouting(optional): string
  指定可能な値: [ "Hash", "PathService" ]

  メッセージの順序単位機能を使用する場合、SAFエージェントの検索に使用するルーティングのタイプを指定します。

  • ハッシュの場合、プロデューサはメッセージの順序単位のハッシュ・コードを使用してSAFエージェントを検索します。

  • パス・サービスの場合、プロデューサはパス・サービスを使用してSAFエージェントを検索します。

  制約

  • 有効なnull
• useSAFTimeToLiveDefault(optional): boolean

  インポートされるJMSメッセージに対して設定された存続時間を「SAFデフォルト存続時間」フィールドで指定した値でオーバーライドするかどうかを制御します。

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

{
    "type":"object",
    "properties":{
        "SAFErrorHandling":{
            "x-weblogic-restartRequired":true,
            "title":"SAF Error Handling Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the SAF error handling reference. <p>Specifies the error handling configuration used by this SAF destination.</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>"
        },
        "localJNDIName":{
            "type":"string",
            "description":"<p>The local JNDI name of the remote destination.</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>"
        },
        "nonPersistentQos":{
            "default":"At-Least-Once",
            "enum":[
                "At-Most-Once",
                "At-Least-Once",
                "Exactly-Once"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>Specifies the quality-of-service for non-persistent messages.</p><ul><li><p><code>Exactly-Once</code> indicates that messages will be forwarded to the remote side once and only once except for any occurrence of server crashes.</p></li><li><p><code>At-Least-Once</code> indicates that messages will be forwarded to the remote side at least once. No message will be lost except for any occurrence of server crashes. However, messages may appear in the remote endpoint more than once.</p></li><li><p><code>At-Most-Once</code> indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.</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>"
        },
        "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>"
        },
        "persistentQos":{
            "default":"Exactly-Once",
            "enum":[
                "At-Most-Once",
                "At-Least-Once",
                "Exactly-Once"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>Specifies the quality-of-service for persistent messages.</p><ul><li><p><code>Exactly-Once</code> indicates that messages will be forwarded to the remote side once and only once</p></li><li><p><code>At-Least-Once</code> indicates that messages will be forwarded to the remote side at least once. Messages may appear in the remote endpoint more than once.</p></li><li><p><code>At-Most-Once</code> indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.</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>"
        },
        "remoteJNDIName":{
            "type":"string",
            "description":"<p>The remote JNDI name of the remote destination.</p>"
        },
        "timeToLiveDefault":{
            "minimum":-1,
            "type":"integer",
            "format":"int64",
            "description":"<p>Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the <code>SAF Default Time-to-Live Enabled</code> field is switched on, which then overrides the expiration time in JMS messages on imported destinations.</p><p>Any change to this value affects only incoming messages; stored messages are not affected.</p>"
        },
        "unitOfOrderRouting":{
            "enum":[
                "Hash",
                "PathService"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.</p><ul><li><p><code>Hash</code> indicates that producers use the hash code of a message Unit-of-Order to find a SAF agent.</p></li><li><p><code>PathService</code> indicates that producers use the Path Service to find a SAF agent.</p></li></ul><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "useSAFTimeToLiveDefault":{
            "type":"boolean",
            "description":"<p>Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the <code>SAF Default Time-to-Live</code> field.</p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p>"
        }
    },
    "description":""
}

ネストされたスキーマ: SAF Error Handling Reference

型: array

タイトル: SAF Error Handling Reference

SAFエラー処理参照が含まれます。

このSAF宛先で使用するエラー処理構成を指定します。

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

制約

• 再起動が必要

ソースを表示

• 配列: string

{
    "x-weblogic-restartRequired":true,
    "title":"SAF Error Handling Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the SAF error handling reference. <p>Specifies the error handling configuration used by this SAF destination.</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>"
}

先頭に戻る