ジャンプ先

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

このサーバー・ランタイム・コレクションの表示

get

/management/weblogic/{version}/domainRuntime/serverRuntimes

このサーバー・ランタイム・コレクションを表示します。

ノート: WebLogic Serverドメイン内のすべての稼働中のサーバーを管理サーバーからモニターします。このリソースから、各管理対象サーバーをモニターできます。

リクエスト

パス・パラメータ

• version: string
  WebLogic RESTインタフェースのバージョン。

問合せパラメータ

• excludeFields(optional): string
  「excludeFields」問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。フィールド名のカンマ区切りリストです。存在する場合は、リストにない名前のフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます(「fields」問合せパラメータが指定されていない場合)。ノート: 「excludeFields」が指定されている場合、「fields」は指定できません。
• excludeLinks(optional): string
  「excludeLinks」問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。リンク関係名のカンマ区切りリストです。存在する場合は、リストに関係名がないリンクのみが返されます。存在しない場合は、すべてのリンクが返されます(「links」問合せパラメータが指定されていない場合)。ノート: 「excludeLinks」が指定されている場合、「links」は指定できません。
• fields(optional): string
  「fields」問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。フィールド名のカンマ区切りリストです。存在する場合は、名前が一致するフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます(「excludeFields」問合せパラメータが指定されていない場合)。ノート: 「excludeFields」が指定されている場合、「fields」は指定できません。
• links(optional): string
  「links」問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。リンク関係名のカンマ区切りリストです。存在する場合、一致する関係名を持つリンクのみが返されます。存在しない場合は、すべてのリンクが返されます(「excludeLinks」問合せパラメータが指定されていない場合)。ノート: 「links」が指定されている場合、「excludeLinks」は指定できません。

セキュリティ

• Admin: basic
  タイプ: Basic

  説明: A user in the Admin security role.
• Deployer: basic
  タイプ: Basic

  説明: A user in the Deployer security role.
• Monitor: basic
  タイプ: Basic

  説明: A user in the Monitor security role.
• Operator: basic
  タイプ: Basic

  説明: A user in the Operator security role.

先頭に戻る

レスポンス

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

• application/json

200レスポンス

サーバー・ランタイム・エンティティのリストが返されます。

本文 ()

ルート・スキーマ: Items

型: array

タイトル: Items

ソースの表示

• 配列: object サーバー・ランタイム

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

ネストされたスキーマ: Server Runtime

型: object

ソースの表示

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

  管理サーバーが接続をリスニングするアドレス。たとえば、文字列santiagoを返します

• adminServerListenPort(optional): integer(int32)
  読取り専用: true

  管理サーバーが接続をリスニングするポート。

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

  サーバーで管理トラフィックに使用するポートが、セキュアなプロトコルを使用するように構成されているかどうかを示します。

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

  クライアントがこのサーバーのデフォルト・ネットワーク・チャネルへの接続に使用するURL。

  返される値は、デフォルト・プロトコル、リスニング・アドレスおよびリスニング・ポートを示します。

  protocol://listen-addresslisten-port

  ノート: デフォルト・プロトコル、リスニング・アドレスおよびリスニング・ポートはドメインのconfig.xmlファイルに保持されますが、サーバー・インスタンスの起動時、コマンド行オプションでこれらの保持されている値をオーバーライドできます。このgetDefaultURLメソッドは現在使用されているURL値を返します。この値は必ずしもconfig.xmlに指定されている値とはかぎりません

  返されるURLは、動的チャネル更新と合致します。

  制約

  • 収集不可
• healthState(optional): object Health State

  WebLogic Serverドメイン内のサービスのヘルス状態を表します。各WebLogic Serverインスタンス内の選択されたサブシステムは、そのサブシステムに固有の条件に基づいて自身のヘルス・ステータスをモニターします。

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

  この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

  制約

  • 収集不可
• overallHealthState(optional): object ヘルス状態

  WebLogic Serverドメイン内のサービスのヘルス状態を表します。各WebLogic Serverインスタンス内の選択されたサブシステムは、そのサブシステムに固有の条件に基づいて自身のヘルス・ステータスをモニターします。

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

  構成の変更をアクティブ化するために、サーバーを再起動する必要があるかどうかを示します。

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

  このサーバーの現在のライフ・サイクル状態。

  たとえば、リクエストを受信して処理できるRUNNING状態や、管理リクエストのみを受信できるADMIN状態などです。

• stateVal(optional): integer(int32)
  読取り専用: true

  サーバーの現在の状態を整数で返します。weblogic.management.runtime.ServerStatesには、使用可能なサーバー状態の情報がより多く含まれます

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

  MBeanのタイプを戻します。

  制約

  • 収集不可
• weblogicVersion(optional): string
  読取り専用: true

  このWebLogic Serverインスタンス(サーバー)のバージョン。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "adminServerHost":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The address on which the Administration Server is listening for connections. For example, this might return the string: santiago</p>"
        },
        "adminServerListenPort":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The port on which the Administration Server is listening for connections.</p>"
        },
        "adminServerListenPortSecure":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.</p>"
        },
        "defaultURL":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The URL that clients use to connect to this server's default network channel.</p><p>The returned value indicates the default protocol, listen address and listen port:</p><p><i>protocol</i>://<i>listen-address</i><i>listen-port</i></p><p>Note: The default protocol, listen address and listen port are persisted in the domain's <code>config.xml</code> file, however when a server instance is started, command-line options can override these persisted values. This <code>getDefaultURL</code> method returns the URL values that are currently being used, not necessarily the values that are specified in <code>config.xml</code></p><p>The returned URL will be consistent with dynamic channel updates.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "overallHealthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "restartRequired":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the server must be restarted in order to activate configuration changes.</p>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current life cycle state of this server.</p><p>For example, a server can be in a RUNNING state in which it can receive and process requests or in an ADMIN state in which it can receive only administrative requests.</p>"
        },
        "stateVal":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns current state of the server as in integer. weblogic.management.runtime.ServerStates has more information about the available server states</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>"
        },
        "weblogicVersion":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The version of this WebLogic Server instance (server).</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

ネストされたスキーマ: Health State

型: object

WebLogic Serverドメイン内のサービスのヘルス状態を表します。各WebLogic Serverインスタンス内の選択されたサブシステムは、そのサブシステムに固有の条件に基づいて自身のヘルス・ステータスをモニターします。

ソースの表示

• partitionName(optional): string

  このプロパティは、ヘルス状態が報告されたパーティションの名前を示します。

• state(optional): string

  このプロパティは、報告されたヘルス状態を次のように示します。

  • OK - サービスは健全です。

  • WARN - 今後サービスに問題が発生する可能性があります

  • CRITICAL - サービスの障害を防止するためにすぐに対処する必要があります

  • FAILED - サービスに障害が発生し、サービスを再起動する必要があります

  • OVERLOADED - サービスは正常に機能していますが、負荷が大きすぎます

  • UNKNOWN - サービスの状態を判断できません

• subsystemName(optional): string

  このプロパティは、ヘルス状態が報告されたサービスを示します。

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

  このプロパティは、報告された状態の原因を示します。

{
    "type":"object",
    "properties":{
        "partitionName":{
            "type":"string",
            "description":"<p>This property indicates the partition name for which the health state is reported.</p>"
        },
        "state":{
            "type":"string",
            "description":"<p>This property indicates the reported state as:</p><ul><li><p>OK - Service is healthy.</p></li><li><p>WARN -  Service could have problems in the future</p></li><li><p>CRITICAL - Something must be done now to prevent service failure</p></li><li><p>FAILED - Service has failed and must be restarted</p></li><li><p>OVERLOADED -  Service is functioning normally but there is too much work in it</p></li><li><p>UNKNOWN - Service state cannot be determined</p></li></ul>"
        },
        "subsystemName":{
            "type":"string",
            "description":"<p>This property indicates the service for which the health state is reported.</p>"
        },
        "symptoms":{
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Symptom"
            },
            "description":"<p>This property indicates the cause of the reported state.</p>"
        }
    },
    "description":"<p>Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.</p>"
}

ネストされたスキーマ: Items

型: array

タイトル: Items

このプロパティは、報告された状態の原因を示します。

ソースの表示

• 配列: object 症状

  ヘルス状態に関してサービスによって報告された観察結果を表します。症状に基づいて、WebLogic Serverの現在のヘルス状態の原因を判別することができます。

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Symptom"
    },
    "description":"<p>This property indicates the cause of the reported state.</p>"
}

ネストされたスキーマ: Symptom

型: object

ヘルス状態に関してサービスによって報告された観察結果を表します。症状に基づいて、WebLogic Serverの現在のヘルス状態の原因を判別することができます。

ソースの表示

• info(optional): string

  症状に関する追加情報がある場合は、このプロパティによってその情報が提供されます。

• instanceId(optional): string

  このプロパティは、症状の識別子を表します。

• severity(optional): string

  このプロパティは、低、中、高の重大度レベルを示します。

• type(optional): string

  このプロパティは、症状の原因(メモリー不足、ネットワーク・エラー、スタック・スレッドなど)を表します。

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "description":"<p>This property provides additional information about the symptom if available.</p>"
        },
        "instanceId":{
            "type":"string",
            "description":"<p>This property represents an identifier for the symptom.</p>"
        },
        "severity":{
            "type":"string",
            "description":"<p>This property indicates a low, medium, or high severity level.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).</p>"
        }
    },
    "description":"<p>Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.</p>"
}

先頭に戻る