ジャンプ先

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

この外部サーバー・コレクションの表示

get

/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/foreignServers

この外部サーバー・コレクションを表示します。

リクエスト

パス・パラメータ

• name: string
  コレクション内のインスタンスの名前プロパティ。
• 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

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

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

  説明: オペレータ・セキュリティ・ロールのユーザー。

トップに戻る

レスポンス

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

• application/json

200レスポンス

外部サーバー・エンティティのリストを返します。

本文 ()

ルート・スキーマ: 項目

型: array

タイトル: Items

ソースの表示

• 配列: object 外部サーバー

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Foreign Server"
    },
    "description":""
}

ネストされたスキーマ: 外部サーバー

型: object

ソースの表示

• connectionURL(optional): string

  WebLogic ServerでJNDIプロバイダへのアクセスに使用するURL。このURLの構文は使用されているJNDIプロバイダによって異なります。WebLogic JMSを使用していて同じクラスタ内のWebLogic JMSオブジェクトを参照している場合は、このフィールドを空白のままにします。

  この値は標準のJNDIプロパティjava.naming.provider.urlに対応します。

  ノート: この値を指定しない場合、この接続ファクトリがデプロイされているWebLogic Serverインスタンス内のJNDIサーバー上でルックアップが実行されます。

  制約

  • 有効なNULL
• defaultTargetingEnabled(optional): boolean
  デフォルト値: false

  このJMSリソースが、デフォルトの親モジュールのターゲット指定を行うのか、サブデプロイメントのターゲット指定メカニズムを使用するのかを指定します。

  Trueに設定すると、このリソースは暗黙的に、親モジュールのターゲット指定を継承します。Falseに設定すると、このリソースはサブデプロイメントのターゲット(指定されている場合)に基づいてターゲット指定されます。

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

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

• initialContextFactory(optional): string
  デフォルト値: weblogic.jndi.WLInitialContextFactory

  JNDIプロバイダへのアクセスのためにインスタンス化する必要のあるクラスの名前。このクラス名は、JNDIプロバイダと、使用されているベンダーによって決まります。

  この値は標準のJNDIプロパティjava.naming.factory.initialに対応します。

  ノート: この値はデフォルトではweblogic.jndi.WLInitialContextFactoryで、これはWebLogic Server用として適切な値です。

• JNDIPropertiesCredential(optional): string(password)

  JNDIプロバイダに設定する必要のある資格証明。これらの資格証明はプロパティの一部となり、JNDIプロバイダのInitialContextクラスのコンストラクタに直接渡されます。

  一部の外部プロバイダでは、初期のネーミング・コンテキストを取得しながら他のプロパティを設定する必要があります。これらのプロパティはプロパティbeanで設定できます

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

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

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

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

  制約

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

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

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

  ノート:

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

• subDeploymentName(optional): string

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

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

{
    "type":"object",
    "properties":{
        "JNDIPropertiesCredential":{
            "type":"string",
            "format":"password",
            "description":"<p>Any Credentials that must be set for the JNDI provider. These Credentials will be part of the properties will be passed directly to the constructor for the JNDI provider's InitialContext class.</p><p>Some foreign providers require other properties to be set while obtaining an initial naming context. These properties can be set with a property bean </p>"
        },
        "connectionURL":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The URL that WebLogic Server will use to contact the JNDI provider. The syntax of this URL depends on which JNDI provider is being used. For WebLogic JMS, leave this field blank if you are referencing WebLogic JMS objects within the same cluster.</p><p>This value corresponds to the standard JNDI property, <code>java.naming.provider.url</code></p><p><i>Note:</i> If this value is not specified, look-ups will be performed on the JNDI server within the WebLogic Server instance where this connection factory is deployed.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "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>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</p>"
        },
        "initialContextFactory":{
            "default":"weblogic.jndi.WLInitialContextFactory",
            "type":"string",
            "description":"<p>The name of the class that must be instantiated to access the JNDI provider. This class name depends on the JNDI provider and the vendor that are being used.</p><p>This value corresponds to the standard JNDI property, <code>java.naming.factory.initial</code></p><p><i>Note:</i> This value defaults to <code>weblogic.jndi.WLInitialContextFactory</code>, which is the correct value for WebLogic Server.</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>"
        }
    },
    "description":""
}

トップに戻る