ジャンプ先

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

この動的サーバーの表示

get

/management/weblogic/{version}/serverConfig/clusters/{name}/dynamicServers

この動的サーバーを表示します。

リクエスト

パス・パラメータ

• 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=serverTemplate

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

本文()

ルート・スキーマ: 動的サーバー

型: object

ソースの表示

• calculatedListenPorts(optional): boolean
  デフォルト値: true

  リスニング・ポートが計算済みかどうかを指定します。

• calculatedMachineNames(optional): boolean
  デフォルト値: false

  CalculatedMachineNames属性は、動的クラスタのサーバー・インスタンスをマシンに割り当てる方法を制御します。属性を設定しないと、動的サーバーはマシンに割り当てられません。属性を設定すると、動的サーバーに使用するマシン・セットを選択するためにMachineNameMatchExpression属性が使用されます。

• dynamicallyCreated(optional): boolean
  読取り専用: true

  デフォルト値: false

  MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます

• dynamicClusterCooloffPeriodSeconds(optional): integer(int32)
  最小値: 0

  デフォルト値: 900

  スケール・アップまたはスケール・ダウン操作の実行中に拡張度フレームワークによって使用されるクールオフ期間(秒単位)を取得します。スケール・アップまたはスケール・ダウン操作が実行された場合、スケール・アップまたはスケール・ダウン操作に対する後続の要求は、この期間拡張度フレームワークによって無視されます。

• dynamicClusterShutdownTimeoutSeconds(optional): integer(int32)
  最小値: 0

  デフォルト値: 0

  サーバーを正常に停止する間に拡張度フレームワークによって使用されるタイムアウト期間(秒単位)を取得します。サーバーが指定されたタイムアウト期間の経過前に停止しなかった場合、強制的に停止されます。時間値が負の場合、タイムアウトは適用されません。

• dynamicClusterSize(optional): integer(int32)
  最小値: 0

  最大値: 800

  動的クラスタの現在のサイズ(作成可能な動的サーバー・インスタンス数)を取得します。指定した数のサーバー・インスタンスが実行時に動的に構成に追加され、関連付けられたServerLifeCycleRuntimeMBeansが作成されます。

• dynamicServerNames(optional): array 項目
  タイトル: Items

  読取り専用: true

  すべての動的サーバーの名前の配列を戻します。

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

  このMBeanインスタンスの一意のIDを返します

• ignoreSessionsDuringShutdown(optional): boolean
  デフォルト値: false

  サーバーのシャットダウン中に、拡張度フレームワークが処理中のHTTPセッションを無視するかどうかを指定します。

• machineMatchExpression(optional): string

  マシン名を選択する際に使用するマシン・タグの式を取得します。MachineMatchTypeがnameの場合、各値は、正確なマシン名とマッチングするか、または末尾に接尾辞'*'を指定して複数のマシン名とマッチングします。MachineMatchTypeがtagの場合、値はすべてのタグ値を含むすべてのマシンとマッチングします。

• machineMatchType(optional): string
  デフォルト値: name

  使用可能な値: [ "name", "tag" ]

  マシン名を選択する際に使用するマシン・タグの式を取得します。MachineMatchTypeがnameの場合、各値は、正確なマシン名とマッチングするか、または末尾に接尾辞'*'を指定して複数のマシン名とマッチングします。MachineMatchTypeがtagの場合、値はすべてのタグ値を含むすべてのマシンとマッチングします。

• machineNameMatchExpression(optional): string

  式は、サーバー割当てに使用するマシンを決定する際に使用します。NULLの場合は、ドメイン内のすべてのマシンが使用されます。式が指定されている場合、動的サーバーにマシン名を割り当てる際に、式と一致するドメイン内のマシンのみが使用されます。式では、カンマ区切りの値セットによって、マッチングするマシンを指定します。各値では、正確なマシン名とマッチングするか、または末尾に接尾辞'*'を指定して複数のマシン名とマッチングします。

• maxDynamicClusterSize(optional): integer(int32)
  最小値: 0

  最大値: 800

  デフォルト値: 8

  拡張度フレームワークがDynamicClusterSizeに割り当てることのできるDynamicClusterSizeに対する上限を取得します。

• minDynamicClusterSize(optional): integer(int32)
  最小値: 0

  最大値: 800

  デフォルト値: 1

  拡張度フレームワークが動的クラスタで維持しようとする実行中のサーバー・インスタンスの最小数を取得します。

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

  このMBeanインスタンスのユーザー定義の名前。

  この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています

  Name=user-specified-name

  制約

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

  この構成の説明として任意に入力できる情報。

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

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

• serverNamePrefix(optional): string

  サーバー名の接頭辞を使用して、サーバー名の作成時に命名規則を指定します。サーバー名の接頭辞が定義されている場合、サーバー名には1から始まる索引が続く指定された接頭辞で計算されます。

• serverTemplate(optional): array サーバー・テンプレート参照
  タイトル: Server Template Reference

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

  動的サーバーの作成に使用するサーバー・テンプレート。

  制約

  • 再起動が必要
• tags(optional): array 項目
  タイトル: Items

  この構成MBeanのすべてのタグを返します

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

  MBeanのタイプを戻します。

  制約

  • 収集不可
• waitForAllSessionsDuringShutdown(optional): boolean
  デフォルト値: false

  サーバーのシャットダウン中に、処理中の作業取扱いにおけるすべてのHTTPセッション(永続および非永続)を拡張度フレームワークが待機するかどうかを指定します。

{
    "type":"object",
    "properties":{
        "calculatedListenPorts":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether listen ports are calculated.</p>"
        },
        "calculatedMachineNames":{
            "default":false,
            "type":"boolean",
            "description":"<p>The CalculatedMachineNames attribute controls how server instances in a dynamic cluster are assigned to a machine. If the attribute is not set, then the dynamic servers will not be assigned to a machine. If the attribute is set, then the MachineNameMatchExpression attribute is used to select the set of machines to use for the dynamic servers.</p>"
        },
        "dynamicClusterCooloffPeriodSeconds":{
            "default":900,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the cool-off period (in seconds) used by the Elasticity Framework while performing scale up or scale down operations. If a scale up or scale down operation was performed, subsequent requests for scale up or down operations will be ignored by the Elasticity Framework during this period.</p>"
        },
        "dynamicClusterShutdownTimeoutSeconds":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the timeout period (in seconds) used by the Elasticity Framework while gracefully shutting down a server. If the server does not shut down before the specified timeout period, the server will be forcibly shut down. With a negative time value, no timeout will be applied.</p>"
        },
        "dynamicClusterSize":{
            "minimum":0,
            "maximum":800,
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the current size of the dynamic cluster (the number of dynamic server instances allowed to be created). The specified number of server instances are dynamically added to the configuration at runtime and associated ServerLifeCycleRuntimeMBeans are created.</p>"
        },
        "dynamicServerNames":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return an array of all the dynamic server names</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "ignoreSessionsDuringShutdown":{
            "default":false,
            "type":"boolean",
            "description":"<p>Indicates if the Elasticity Framework should ignore inflight HTTP sessions while shutting down servers.</p>"
        },
        "machineMatchExpression":{
            "type":"string",
            "description":"<p>Get the machine tag expression to use when selecting machine names.  If the MachineMatchType is \"name\", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is \"tag\", the values will match all of the machines that have all of the tag values.</p>"
        },
        "machineMatchType":{
            "default":"name",
            "enum":[
                "name",
                "tag"
            ],
            "type":"string",
            "description":"<p>Get the machine tag expression to use when selecting machine names.  If the MachineMatchType is \"name\", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is \"tag\", the values will match all of the machines that have all of the tag values.</p>"
        },
        "machineNameMatchExpression":{
            "type":"string",
            "description":"<p>The expression is used when determining machines to use for server assignments. If null, then all machines in the domain are used. If a expression is provided, then only the machines in the domain that match the expression will be used when assigning machine names to dynamic servers.  The expression is a comma separated set of values that specify the machines to match. Each value will either match a machine name exactly or if specified with a trailing '*' suffix, the value will match multiple machine names.</p>"
        },
        "maxDynamicClusterSize":{
            "default":8,
            "minimum":0,
            "maximum":800,
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the upper bound on the DynamicClusterSize that the Elasticity Framework is allowed to assign to DynamicClusterSize.</p>"
        },
        "minDynamicClusterSize":{
            "default":1,
            "minimum":0,
            "maximum":800,
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the minimum number of running server instances that the Elasticity Framework will attempt to keep in the dynamic cluster.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></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 configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "serverNamePrefix":{
            "type":"string",
            "description":"<p>The server name prefix is used to specify the naming convention when creating server names. When the server name prefix is defined, server names are calculated with the specified prefix followed by the index starting with 1.</p>"
        },
        "serverTemplate":{
            "x-weblogic-restartRequired":true,
            "title":"Server Template Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the server template reference. <p>The server template used to create dynamic servers.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "waitForAllSessionsDuringShutdown":{
            "default":false,
            "type":"boolean",
            "description":"<p>Indicates if the Elasticity Framework should wait for all (persisted and non-persisted) HTTP sessions during inflight work handling while shutting down servers.</p>"
        }
    },
    "description":""
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

読取り専用: true

すべての動的サーバーの名前の配列を戻します。

ソースの表示

• 配列: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return an array of all the dynamic server names</p>"
}

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

型: array

タイトル: Server Template Reference

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

動的サーバーの作成に使用するサーバー・テンプレート。

制約

• 再起動が必要

ソースの表示

• 配列: string

{
    "x-weblogic-restartRequired":true,
    "title":"Server Template Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the server template reference. <p>The server template used to create dynamic servers.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

この構成MBeanのすべてのタグを返します

ソースの表示

• 配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

先頭に戻る