Oracle WebLogic ServerのRESTfulサーバー構成管理インタフェース

このSAFインポート済宛先の表示

get

/management/weblogic/{version}/serverConfig/resourceGroupTemplates/{name}/JMSSystemResources/{name}/JMSResource/SAFImportedDestinations/{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=SAFErrorHandling
SAFエラー処理リソースへのこのリソースのSAFErrorHandling参照。
rel=SAFQueues uri=/management/weblogic/{version}/serverConfig/resourceGroupTemplates/{name}/JMSSystemResources/{name}/JMSResource/SAFImportedDestinations/{name}/SAFQueues
このリソースのSAFQueuesコレクション・リソース。
rel=SAFRemoteContext
SAFリモート・コンテキスト・リソースへのこのリソースのSAFRemoteContext参照。
rel=SAFTopics uri=/management/weblogic/{version}/serverConfig/resourceGroupTemplates/{name}/JMSSystemResources/{name}/JMSResource/SAFImportedDestinations/{name}/SAFTopics
このリソースのSAFTopicsコレクション・リソース。
rel=messageLoggingParams uri=/management/weblogic/{version}/serverConfig/resourceGroupTemplates/{name}/JMSSystemResources/{name}/JMSResource/SAFImportedDestinations/{name}/messageLoggingParams
このリソースのmessageLoggingParamsシングルトン・リソース。

ルート・スキーマ: SAFインポート済宛先

型: object

ソースの表示

defaultTargetingEnabled(optional): boolean

デフォルト値: false

このJMSリソースが、デフォルトの親モジュールのターゲット指定を行うのか、サブデプロイメントのターゲット指定メカニズムを使用するのかを指定します。
Trueに設定すると、このリソースは暗黙的に、親モジュールのターゲット指定を継承します。Falseに設定すると、このリソースはサブデプロイメントのターゲット(指定されている場合)に基づいてターゲット指定されます。
exactlyOnceLoadBalancingPolicy(optional): string
デフォルト値: Per-Member

使用可能な値: [ "Per-Member", "Per-JVM" ]
SAFサービスにより、「必ず1回」のサービス品質(QOS)でメッセージが分散宛先に転送される際にロード・バランシングの動作を制御します。
有効な値は、次のとおりです。
- メンバー単位 - デフォルト値。ターゲット分散宛先(DD)のアクティブなすべてのメンバーがロード・バランシングの候補になります。WebLogic Server JVMで同じDDのメンバーが複数実行されている場合、これらすべてのメンバーが転送されたというメッセージを受信します。
- JVM単位 - 各WebLogic Server JVMにおいて、ターゲット分散宛先(DD)のアクティブなメンバーの1つのみが、ロード・バランシングの候補になります。クラスタのターゲットとして指定されているJMSサーバーのインスタンスに関連付けられたメンバーがDDに存在する場合、ロード・バランシング・アルゴリズムには、特定のJVMに対する自然なアフィニティまたはプリファレンスがあるため、優先メンバーが優先されます。それ以外の場合、このアルゴリズムでは、同じJVMに存在するすべての候補メンバーの中で、名前が辞書順で最後になるメンバーが優先されます。
ノート:
- 各JVMでホストしているDDのメンバーが1つのみの場合、2つのオプションの動作は同じになります。
- すべてのJMSモジュールまたは特定のJMSモジュールに定義されているSAFインポート済宛先Beanの必ず1回のロード・バランシング・ポリシーは、クラスタ内のすべてのWebLogic Serverに、システム・プロパティweblogic.jms.saf.ExactlyOnceLoadBalancingPolicyまたはweblogic.jms.saf.ExactlyOnceLoadBalancingPolicy.MODULENAMEを指定することでオーバーライドできます(2つ目のプロパティが1つ目のプロパティより優先されます)。SAFインポート済宛先がこれらのシステム・プロパティのいずれかでオーバーライドされた場合は、最初のSAFメッセージが転送されたときに、ホストWebLogic Serverで、そのSAFインポート済宛先の名前とシステム・プロパティ、そのシステム・プロパティの値が記載された情報メッセージBEA-281034が記録されます。
- この設定は、「1回以上」または「最大1回」のQOSが使用されるSAF構成には適用されません。スタンドアロンの宛先へのメッセージの転送にも、順序単位のメッセージの転送にも適用されません。
- この設定は、サーバー側のストア・アンド・フォワードでも、クライアント側のストア・アンド・フォワードでも適用されます。
- ローカルに分散されたインポート済宛先におけるメッセージのロード・バランシングを制御する類似の設定については、接続ファクトリ・ロード・バランシング・パラメータBeanのプロデューサのロード・バランシング・ポリシー属性を参照してください。
id(optional): integer(int64)

読取り専用: true

このBeanインスタンスの一意の識別子を返します。
JNDIPrefix(optional): string

リモート宛先のローカルJNDI名の先頭に付ける文字列を指定します。
この接頭辞に対する変更は、受信メッセージにのみ影響します。格納されているメッセージには影響しません。
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エンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。
ノート:
管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。


            
             SAFErrorHandling(optional): array  SAFエラー処理参照
            
            
                
                
タイトル: SAF Error Handling Reference





















SAFエラー処理参照が含まれます。 インポート済み宛先に使用されるエラー処理構成を指定します。
このパラメータに対する変更は、受信するメッセージにのみ影響します。格納されているメッセージには影響しません。
制約
再起動が必要


                
            
            
            
             SAFRemoteContext(optional): array  SAFリモート・コンテキスト参照
            
            
                
                
タイトル: SAF Remote Context Reference





















SAFリモート・コンテキスト参照が含まれます。 インポート済み宛先に使用されるリモート・コンテキストを指定します。
リモート・コンテキスト名に対する変更は、格納されているメッセージと受信するメッセージの双方に影響します。


                
            
            
            
             subDeploymentName(optional): string
            
                
                
























このエンティティをターゲットにする場合に使用するサブデプロイメントの名前を取得します。
 この名前を持つサブデプロイメントを使用してエンティティをターゲットにします。サブデプロイメントのターゲットは、このエンティティのターゲットになります。 




                
            
            
            
             timeToLiveDefault(optional): integer(int64)
            
                
                




最小値: -1















デフォルト値: 3600000







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




                
            
            
            
             unitOfOrderRouting(optional): string
            
                
                


















デフォルト値: Hash



使用可能な値: [ "Hash", "PathService" ]





メッセージの順序単位機能を使用する場合、SAFエージェントの検索に使用するルーティングのタイプを指定します。
ハッシュの場合、メッセージ・プロデューサはメッセージの順序単位のハッシュ・コードを使用してSAFエージェントを検索します。
パス・サービスの場合、メッセージ・プロデューサはパス・サービスを使用してSAFエージェントを検索します。




                
            
            
            
             useSAFTimeToLiveDefault(optional): boolean
            
                
                


















デフォルト値: false







インポートされるJMSメッセージに対して設定された存続時間を「SAFデフォルト存続時間」フィールドで指定した値でオーバーライドするかどうかを制御します。
このパラメータに対する変更は、受信するメッセージにのみ影響します。格納されているメッセージには影響しません。


        {
    "type":"object",
    "properties":{
        "JNDIPrefix":{
            "type":"string",
            "description":"<p>Specifies the string that will prefix the local JNDI name of a remote destination.</p><p>Any change to this prefix affects only incoming messages; stored messages are not affected.</p>"
        },
        "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 for the imported destinations.</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>"
        },
        "SAFRemoteContext":{
            "title":"SAF Remote Context Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the SAF remote context reference. <p>Specifies the remote context used for the imported destinations.</p><p>Changing the remote context name affects both stored messages and incoming messages.</p>"
        },
        "defaultTargetingEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.</p><p>When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified. </p>"
        },
        "exactlyOnceLoadBalancingPolicy":{
            "default":"Per-Member",
            "enum":[
                "Per-Member",
                "Per-JVM"
            ],
            "type":"string",
            "description":"<p>Controls the load balancing behavior when the SAF service forwards messages to a distributed destination with the <code>Exactly-Once</code> quality of service (QOS).</p><p> The valid values are: </p><ul><li><p><code>Per-Member</code> - The default value. All active members of the target distributed destination (DD) will be the candidates for load balancing. If there are multiple members of the same DD running on a WebLogic server JVM, these members will all receive forwarded messages.</p></li><li><p><code>Per-JVM</code> - On each WebLogic server JVM, only one of the active members of the target distributed destination(DD) will be the candidate for load balancing. When the DD has members associated with the instances of a cluster-targeted JMS server, the load balancing algorithm will bias to the \"preferred member\", which has natural affinity or preference to a particular JVM. Otherwise, the algorithm will bias to the member whose name is lexicographically smallest among all candidate members on the same JVM. </p></li></ul><p>Notes:</p><ul><li><p> When each JVM hosts only one member of a DD, the two options behave the same. </p></li><li><p> You can override the <code>Exactly Once Load Balancing Policy</code> on SAF Imported Destinations Beans defined in all JMS modules or a particular JMS module by specifying the system properties <code>weblogic.jms.saf.ExactlyOnceLoadBalancingPolicy</code> or <code>weblogic.jms.saf.ExactlyOnceLoadBalancingPolicy.MODULENAME</code> on every WebLogic Server in a cluster (the latter property takes precedence over the former). If a  SAF Imported Destinations is overridden by one of these system properties, then the host WebLogic Server will log an Info message BEA-281034 with the name of the SAF Imported Destinations, the system property, and the system property value once the first SAF message is forwarded.</p></li><li><p> The setting does not apply to the SAF configurations that use the <code>At-Last-Once</code> or <code>At-Most-Once</code> QOS. Neither does it apply to forwarding messages to a \"standalone\" destination, or forwarding unit-of-order messages. </p></li><li><p> The setting is honored in both server store-and-forward and client store-and-forward. </p></li><li><p> For a similar setting that controls the load balancing of messages on a local distributed Imported Destination, see the Producer Load Balancing Policy attribute on Connection Factory Load Balancing Params Bean. </p></li></ul>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</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>"
        },
        "subDeploymentName":{
            "type":"string",
            "description":"<p>Gets the name of the sub-deployment to use when targeting this entity</p><p> Entities are targeted using a sub-deployment with this name.  The targets of the sub-deployment will be the targets of this entity. </p>"
        },
        "timeToLiveDefault":{
            "default":3600000,
            "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":{
            "default":"Hash",
            "enum":[
                "Hash",
                "PathService"
            ],
            "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 message 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 message producers use the Path Service to find a SAF agent.</p></li></ul>"
        },
        "useSAFTimeToLiveDefault":{
            "default":false,
            "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エラー処理参照
    
      
      型: array
    

    

    
    タイトル: SAF Error Handling Reference
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    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 for the imported destinations.</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>"
}
    

    

    

    

    

    




                    
                    
    ネストされたスキーマ: SAFリモート・コンテキスト参照
    
      
      型: array
    

    

    
    タイトル: SAF Remote Context Reference
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    SAFリモート・コンテキスト参照が含まれます。 インポート済み宛先に使用されるリモート・コンテキストを指定します。
リモート・コンテキスト名に対する変更は、格納されているメッセージと受信するメッセージの双方に影響します。
    

    

    

    

    
        ソースの表示
        
            
             配列: string
            
            
                
                





























                
            
            
            
        
        {
    "title":"SAF Remote Context Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the SAF remote context reference. <p>Specifies the remote context used for the imported destinations.</p><p>Changing the remote context name affects both stored messages and incoming messages.</p>"
}


                

				先頭に戻る