Oracle WebLogic Server RESTfulサーバー・ランタイム管理インタフェース

ルート・スキーマ: Server Runtime

タイプ: object

ソースを表示

activationTime(optional): integer(int64)

読取り専用: true

サーバーが起動した時刻。
administrationPortEnabled(optional): boolean

読取り専用: true

管理ポートがサーバー上で有効になっているかどうかを示します。
administrationURL(optional): string
読取り専用: true
サーバーとそのクライアントで管理接続用に使用されるURL。
管理チャネルが有効になっていない場合、このメソッドはデフォルト・チャネルを介して接続するためのURLを返します。デフォルト・チャネルが非アクティブになっている場合、このメソッドはセキュア・チャネルのURLを返します。セキュア・チャネルが有効になっていない場合、このメソッドはnullを返します。
返されるURLは、動的なチャネル更新において一貫性が保たれます。
制約
- 収集不可
adminServer(optional): boolean

読取り専用: true

サーバーが管理サーバーかどうかを示します。
adminServerHost(optional): string

読取り専用: true

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

読取り専用: true

管理サーバーが接続をリスニングするポート。
adminServerListenPortSecure(optional): boolean

読取り専用: true

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

読取り専用: true

サーバーが起動されたディレクトリの絶対パス。
これをServerMBeanの他の相対パスと組み合せてフル・パスを計算できます。
currentMachine(optional): string

サーバーが動作しているマシンを返します。このサーバーが自動的に移行すると、実際の構成と異なる内容が表示されます。
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インスタンス内の選択されたサブシステムは、そのサブシステムに固有の条件に基づいて自身のヘルス・ステータスをモニターします。
inSitConfigState(optional): boolean

読取り専用: true

sitconfigが適用されている場合にtrueを返します。
listenPortEnabled(optional): boolean

読取り専用: true

デフォルトのリスニング・ポートがサーバー上で有効かどうかを示します。
middlewareHome(optional): string

読取り専用: true

Oracle Middlewareインストール・ディレクトリ。
name(optional): string
読取り専用: true
この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。
制約
- 収集不可
openSocketsCurrentCount(optional): integer(int32)

読取り専用: true

このサーバーでソケット多重化用に登録されている現在のソケット数。
overallHealthState(optional): object Health State

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

読取り専用: true
サーバーにインストールされたパッチの情報を文字列の配列として返します。配列の各要素は、次の形式でパッチの内容が記述されます。
BugNumber;PatchID;DateApplied;Description
制約
- 収集不可
restartRequired(optional): boolean

読取り専用: true

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

読取り専用: true

このサーバーのクラスパスを取得します。これには、自動的に取得されてクラスパスに追加されるドメイン/ライブラリ・コンテンツも含まれます。
SSLListenPortEnabled(optional): boolean

読取り専用: true

デフォルトのSSLリスニング・ポートがサーバー上で有効かどうかを示します。
state(optional): string

読取り専用: true

このサーバーの現在のライフ・サイクル状態。
たとえば、リクエストを受信して処理できるRUNNING状態や、管理リクエストのみを受信できるADMIN状態などです。
stateVal(optional): integer(int32)

読取り専用: true

サーバーの現在の状態を整数で返します。考えられるサーバー状態に関する詳細情報は、weblogic.management.runtime.ServerStatesに含まれています。
type(optional): string
読取り専用: true
MBeanのタイプを戻します。
制約
- 収集不可
weblogicHome(optional): string

読取り専用: true

WebLogic Serverインスタンス(サーバー)がインストールされている場所で、末尾に「/server」は付きません。
weblogicVersion(optional): string
読取り専用: true
このWebLogic Serverインスタンス(サーバー)のバージョン。
制約
- 収集不可

{
    "type":"object",
    "properties":{
        "SSLListenPortEnabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the default SSL listen port is enabled on the server</p>"
        },
        "activationTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The time when the server was started.</p>"
        },
        "adminServer":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the server is an Administration Server.</p>"
        },
        "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>"
        },
        "administrationPortEnabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the administration port is enabled on the server</p>"
        },
        "administrationURL":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The URL that the server and its clients use for administrative connections.</p><p>If no administration channel is enabled, then this method returns the URL for connections through the default channel. If the default channel is de-activated, this method returns the URL for a secure channel. If no secure channel is enabled, the method returns null.</p><p>The returned URL will be consistent with dynamic channel updates.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "currentDirectory":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The absolute path of the directory from which the server was started.</p><p>This may be used in conjunction with other relative paths in ServerMBean to compute full paths.</p>"
        },
        "currentMachine":{
            "type":"string",
            "description":"<p>Return the machine on which the server is running. This will be different from the configuration if the server gets migrated automatically.</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"
        },
        "inSitConfigState":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns true if sitconfig is applied.</p>"
        },
        "listenPortEnabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the default listen port is enabled on the server.</p>"
        },
        "middlewareHome":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The Oracle Middleware installation directory. </p>"
        },
        "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>"
        },
        "openSocketsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The current number of sockets registered for socket muxing on this server.</p>"
        },
        "overallHealthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "patchList":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Returns information about installed patches on the server as an array of Strings. Each element of the array describes a patch, which is of the form: </p><p>BugNumber;PatchID;DateApplied;Description</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "restartRequired":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the server must be restarted in order to activate configuration changes.</p>"
        },
        "serverClasspath":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Get the classpath for this server including domain/lib contents that are automatically picked up and appended to the classpath.</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>"
        },
        "weblogicHome":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The directory where the WebLogic Server instance (server) is installed, without the trailing \"/server\".</p>"
        },
        "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

タイトル: 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

読取り専用: true

サーバーにインストールされたパッチの情報を文字列の配列として返します。配列の各要素は、次の形式でパッチの内容が記述されます。

BugNumber;PatchID;DateApplied;Description

制約

収集不可

ソースを表示

配列: string

{
    "readOnly":true,
    "x-weblogic-unharvestable":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Returns information about installed patches on the server as an array of Strings. Each element of the array describes a patch, which is of the form: </p><p>BugNumber;PatchID;DateApplied;Description</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
}

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

タイプ: array

タイトル: Items

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

ソースを表示

配列: object Symptom

ヘルス状態に関してサービスによって報告された観察結果を表します。症状に基づいて、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>"
}

このサーバー・ランタイムの変更

リクエスト

制約

制約

制約

制約

制約

制約

制約

レスポンス

200レスポンス