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

このJMSサーバー・ランタイムの表示

get

/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}

このJMSサーバー・ランタイムを表示します。

リクエスト

パス・パラメータ

name(required): string

コレクション内のインスタンスの名前プロパティ。
version(required): string

WebLogic RESTインタフェースのバージョン。

問合せパラメータ

excludeFields: string

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

excludeLinks問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これはリンク関係名のカンマ区切りリストです。存在する場合は、関係名がリストにないリンクのみが返されます。存在しない場合は、すべてのリンクが返されます(links問合せパラメータが指定されている場合を除く)。ノート: excludeLinksが指定されている場合、linksは指定できません。
fields: string

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

links問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これはリンク関係名のカンマ区切りリストです。存在する場合は、関係名が一致するリンクのみが返されます。存在しない場合は、すべてのリンクが返されます(excludeLinks問合せパラメータが指定されている場合を除く)。ノート: linksが指定されている場合、excludeLinksは指定できません。

セキュリティ

管理者: 基本

タイプ: 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レスポンス

このJMSサーバー・ランタイムを返します。

このメソッドは次のリンクを返すことができます。

rel=action title=currentTransactions uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/currentTransactions
このリソースのcurrentTransactionsアクション・リソース。
rel=action title=forceCommit uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/forceCommit
このリソースのforceCommitアクション・リソース。
rel=action title=forceRollback uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/forceRollback
このリソースのforceRollbackアクション・リソース。
rel=action title=getJMSMessagesByXid uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/getJMSMessagesByXid
このリソースのgetJMSMessagesByXidアクション・リソース。
rel=action title=getTransactionStatus uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/getTransactionStatus
このリソースのgetTransactionStatusアクション・リソース。
rel=action title=pauseConsumption uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/pauseConsumption
このリソースのpauseConsumptionアクション・リソース。
rel=action title=pauseInsertion uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/pauseInsertion
このリソースのpauseInsertionアクション・リソース。
rel=action title=pauseProduction uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/pauseProduction
このリソースのpauseProductionアクション・リソース。
rel=action title=resumeConsumption uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/resumeConsumption
このリソースのresumeConsumptionアクション・リソース。
rel=action title=resumeInsertion uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/resumeInsertion
このリソースのresumeInsertionアクション・リソース。
rel=action title=resumeProduction uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/resumeProduction
このリソースのresumeProductionアクション・リソース。
rel=destinations uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/destinations
このリソースのdestinationsコレクション・リソース。
rel=logRuntime uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/logRuntime
このリソースのlogRuntimeシングルトン・リソース。
rel=sessionPoolRuntimes uri=/management/weblogic/{version}/serverRuntime/JMSRuntime/JMSServers/{name}/sessionPoolRuntimes
このリソースのsessionPoolRuntimesコレクション・リソース。

ルート・スキーマ: JMS Server Runtime

タイプ: object

ソースを表示

bytesCurrentCount: integer(int64)

読取り専用: true

このJMSサーバーに現在格納されているバイト数。
この数には保留中のバイト数は含まれません。
bytesHighCount: integer(int64)

読取り専用: true

最後のリセット以降にこのJMSサーバーに格納された最大のバイト数。
bytesPageableCurrentCount: integer(int64)

読取り専用: true

現在ページングすることができるが、まだページングされていないすべてのメッセージの総バイト数を戻します。JMSサーバーでは、この数が"MessageBufferSize"パラメータよりも常に小さくなるようにしています。
bytesPagedInTotalCount: integer(int64)

読取り専用: true

JMSサーバーの起動以降にページング・ディレクトリから読み取られた総バイト数を戻します。
bytesPagedOutTotalCount: integer(int64)

読取り専用: true

JMSサーバーの起動以降にページング・ディレクトリに書き込まれた総バイト数を戻します。
bytesPendingCount: integer(int64)

読取り専用: true

このJMSサーバーに現在格納されている保留中(未応答または未コミット)のバイト数。
保留バイトは現在のバイト数に含まれません。
bytesReceivedCount: integer(int64)

読取り専用: true

最後のリセット以降にこのJMSサーバーで受信したバイト数。
bytesThresholdTime: integer(int64)

読取り専用: true

最後にリセットしてからしきい値状態にあった時間。
consumptionPaused: boolean

読取り専用: true

JMSServerの現在の消費の休止状態をブール値で戻します。
consumptionPausedState: string

読取り専用: true

JMSServerの現在の消費の休止状態を文字列値で返します。
destinationsCurrentCount: integer(int64)

読取り専用: true

このJMSサーバーの現在の宛先の数。
destinationsHighCount: integer(int64)

読取り専用: true

最後のリセット以降の、このJMSサーバー上の宛先の最大数。
destinationsTotalCount: integer(int64)

読取り専用: true

最後のリセット以降にこのJMSサーバーでインスタンス化された宛先の数。
healthState: object Health State

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

読取り専用: true

JMSServerの現在の挿入の休止状態をブール値で戻します。
insertionPausedState: string

読取り専用: true

JMSServerの現在の挿入の休止状態を文字列値で返します。
messagesCurrentCount: integer(int64)

読取り専用: true

このJMSサーバーに現在格納されているメッセージの数。この数には保留メッセージは含まれません。
messagesHighCount: integer(int64)

読取り専用: true

最後のリセット以降にこのJMSサーバーに格納されたメッセージの最大数。
messagesPageableCurrentCount: integer(int32)

読取り専用: true

このJMSサーバーで現在ページングすることができるが、まだページングされていないメッセージの数を戻します。内部的な実装の仕組み上、この値は「PageableByteCurrentCount」がゼロの場合でもゼロになる可能性があります。
messagesPagedInTotalCount: integer(int32)

読取り専用: true

JMSサーバーの起動以降にページング・ディレクトリから読み取られたメッセージの総数を戻します。
messagesPagedOutTotalCount: integer(int32)

読取り専用: true

JMSサーバーの起動以降にページング・ディレクトリに書き込まれたメッセージの総数を戻します。
messagesPendingCount: integer(int64)

読取り専用: true

このJMSサーバーに現在格納されている保留中(未応答または未コミット)のメッセージの数。
保留メッセージは現在のメッセージ数に含まれません。
messagesReceivedCount: integer(int64)

読取り専用: true

最後のリセット以降にこの宛先で受信したメッセージの数。
messagesThresholdTime: integer(int64)

読取り専用: true

最後にリセットしてからしきい値状態にあった時間。
name: string
読取り専用: true
この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。
制約
- 収集不可
pagingAllocatedIoBufferBytes: integer(int64)

読取り専用: true

PersistentStoreRuntimeMBean.AllocatedIoBufferBytesを参照
pagingAllocatedWindowBufferBytes: integer(int64)

読取り専用: true

PersistentStoreRuntimeMBean.AllocatedWindowBufferBytesを参照
pagingPhysicalWriteCount: integer(int64)

読取り専用: true

PersistentStoreRuntimeMBean.PhysicalWriteCountを参照
pendingTransactions: array Items

タイトル: Items

読取り専用: true

このJMSサーバーに保留状態で存在するトランザクション・ブランチ(トランザクション・マネージャによって準備されたが、まだコミットまたはロール・バックされていないブランチ)を表すXidの配列を返します。
productionPaused: boolean

読取り専用: true

JMSServerの現在の生成の休止状態をブール値で戻します。
productionPausedState: string

読取り専用: true

JMSServerの現在の生成の休止状態を文字列値で返します。
sessionPoolsCurrentCount: integer(int64)

読取り専用: true

このJMSサーバーで現在インスタンス化されているセッション・プールの数。
sessionPoolsHighCount: integer(int64)

読取り専用: true

最後のリセット以降にこのJMSサーバーでインスタンス化されたセッション・プールの最大数。
sessionPoolsTotalCount: integer(int64)

読取り専用: true

最後のリセット以降にこのJMSサーバーでインスタンス化されたセッション・プールの数。
transactions: array Items

タイトル: Items

読取り専用: true

このJMSサーバーに任意の状態で存在するトランザクション・ブランチを表すXidの配列を返します。
type: string
読取り専用: true
MBeanのタイプを戻します。
制約
- 収集不可

{
    "type":"object",
    "properties":{
        "bytesCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of bytes stored on this JMS server.</p><p>This number does not include the pending bytes.</p>"
        },
        "bytesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of bytes stored in the JMS server since the last reset.</p>"
        },
        "bytesPageableCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the total number of bytes in all the messages that are currently available to be paged out, but which have not yet been paged out. The JMS server attempts to keep this number smaller than the \"MessageBufferSize\" parameter.</p>"
        },
        "bytesPagedInTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the total number of bytes that were read from the paging directory since the JMS server was started.</p>"
        },
        "bytesPagedOutTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the total number of bytes that were written to the paging directory since the JMS server was started.</p>"
        },
        "bytesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of bytes pending (unacknowledged or uncommitted) stored on this JMS server.</p><p>Pending bytes are over and above the current number of bytes.</p>"
        },
        "bytesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of bytes received on this JMS server since the last reset.</p>"
        },
        "bytesThresholdTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The amount of time in the threshold condition since the last reset.</p>"
        },
        "consumptionPaused":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns the current consumption paused state of the JMSServer as boolean value.</p>"
        },
        "consumptionPausedState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the current consumption paused state of the JMSServer as string value.</p>"
        },
        "destinationsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of destinations for this JMS server.</p>"
        },
        "destinationsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of destinations on this JMS server since the last reset.</p>"
        },
        "destinationsTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of destinations instantiated on this JMS server since the last reset.</p>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "insertionPaused":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns the current insertion paused state of the JMSServer as boolean value.</p>"
        },
        "insertionPausedState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the current insertion paused state of the JMSServer as string value.</p>"
        },
        "messagesCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of messages stored on this JMS server. This number does not include the pending messages.</p>"
        },
        "messagesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of messages stored in the JMS server since the last reset.</p>"
        },
        "messagesPageableCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the number of messages that are currently available for paging in this JMS server but have not yet been paged out. Note that due to internal implementation details, this count may be zero even if \"PageableByteCurrentCount\" is zero.</p>"
        },
        "messagesPagedInTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the total number of messages that were read from the paging directory since the JMS server was started.</p>"
        },
        "messagesPagedOutTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Return the total number of messages that were written to the paging directory since the JMS server was started.</p>"
        },
        "messagesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of messages pending (unacknowledged or uncommitted) stored on this JMS server.</p><p>Pending messages are over and above the current number of messages.</p>"
        },
        "messagesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages received on this destination since the last reset.</p>"
        },
        "messagesThresholdTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The amount of time in the threshold condition since the last reset.</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>"
        },
        "pagingAllocatedIoBufferBytes":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>See PersistentStoreRuntimeMBean.AllocatedIoBufferBytes</p>"
        },
        "pagingAllocatedWindowBufferBytes":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>See PersistentStoreRuntimeMBean.AllocatedWindowBufferBytes</p>"
        },
        "pagingPhysicalWriteCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>See PersistentStoreRuntimeMBean.PhysicalWriteCount</p>"
        },
        "pendingTransactions":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Returns an array of Xids representing transaction branches that exist onthis JMS server in the pending state, i.e. branches that have been prepared by the transaction manager but not yet committed or rolled back.</p>"
        },
        "productionPaused":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns the current production paused state of the JMSServer as boolean value.</p>"
        },
        "productionPausedState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the current production paused state of the JMSServer as string value.</p>"
        },
        "sessionPoolsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of session pools instantiated on this JMS server.</p>"
        },
        "sessionPoolsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of session pools instantiated on this JMS server since the last reset.</p>"
        },
        "sessionPoolsTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of session pools instantiated on this JMS server since the last reset.</p>"
        },
        "transactions":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Returns an array of Xids representing transaction branches that exist on this JMS server in any state.</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>"
        }
    },
    "description":""
}

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

タイプ: object

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

ソースを表示

state: string
このプロパティは、報告されたヘルス状態を次のように示します。
- OK - サービスは健全です。
- WARN - 今後サービスに問題が発生する可能性があります
- CRITICAL - サービスの障害を防止するためにすぐに対処する必要があります
- FAILED - サービスに障害が発生し、サービスを再起動する必要があります
- OVERLOADED - サービスは正常に機能していますが、負荷が大きすぎます
- UNKNOWN - サービスの状態を判断できません
subsystemName: string

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

タイトル: Items

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

{
    "type":"object",
    "properties":{
        "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

このJMSサーバーに保留状態で存在するトランザクション・ブランチ(トランザクション・マネージャによって準備されたが、まだコミットまたはロール・バックされていないブランチ)を表すXidの配列を返します。

ソースを表示

配列: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Returns an array of Xids representing transaction branches that exist onthis JMS server in the pending state, i.e. branches that have been prepared by the transaction manager but not yet committed or rolled back.</p>"
}

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

タイプ: array

タイトル: Items

読取り専用: true

このJMSサーバーに任意の状態で存在するトランザクション・ブランチを表すXidの配列を返します。

ソースを表示

配列: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Returns an array of Xids representing transaction branches that exist on this JMS server in any state.</p>"
}

ネストされたスキーマ: 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: string

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

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

このプロパティは、低、中、高の重大度レベルを示します。
type: 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レスポンス

制約

制約