移動先

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

このSAFエージェント・ランタイムの表示

GET

/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}

このSAFエージェント・ランタイムを表示します。

リクエスト

パス・パラメータ

• 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

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

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

  説明: Operatorセキュリティ・ロールのユーザー。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

このSAFエージェント・ランタイムを返します。

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

• rel=action title=pauseForwarding uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/pauseForwarding

  このリソースのpauseForwardingアクション・リソース。

• rel=action title=pauseIncoming uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/pauseIncoming

  このリソースのpauseIncomingアクション・リソース。

• rel=action title=pauseReceiving uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/pauseReceiving

  このリソースのpauseReceivingアクション・リソース。

• rel=action title=resumeForwarding uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/resumeForwarding

  このリソースのresumeForwardingアクション・リソース。

• rel=action title=resumeIncoming uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/resumeIncoming

  このリソースのresumeIncomingアクション・リソース。

• rel=action title=resumeReceiving uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/resumeReceiving

  このリソースのresumeReceivingアクション・リソース。

• rel=conversations uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/conversations

  このリソースのconversationsコレクション・リソース。

• rel=logRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/logRuntime

  このリソースのlogRuntimeシングルトン・リソース。

• rel=remoteEndpoints uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime/agents/{name}/remoteEndpoints

  このリソースのremoteEndpointsコレクション・リソース。

本文()

ルート・スキーマ: SAFエージェント・ランタイム

タイプ: object

ソースを表示

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

  現在のバイト数を戻します。この数には保留中のバイト数は含まれません。

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

  最後のリセット以降の最大バイト数を戻します。

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

  保留中のバイト数を戻します。保留バイトは現在のバイト数に含まれません。

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

  最後のリセット以降に受信したバイト数。

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

  最後のリセット以降にしきい値状態にあった時間を戻します。

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

  現在の会話数を戻します。

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

  最後のリセット以降の最大会話数。

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

  最後のリセット以降の合計会話数。

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

  最後のリセット以降に転送に失敗したメッセージの合計数を戻します。

• healthState(optional): object ヘルス状態

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

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

  現在のメッセージ数を戻します。この数には保留中のメッセージが含まれています。

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

  最後のリセット以降の最大メッセージ数を戻します。

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

  保留中のメッセージ数を戻します。保留メッセージは現在のメッセージ数に含まれません。保留中のメッセージとは、トランザクションで送信されてコミットされていないメッセージや、転送されてまだ確認応答されていないメッセージのことです。

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

  最後のリセット以降に受信したメッセージ数。

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

  最後のリセット以降にしきい値状態にあった時間を戻します。

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

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

  制約

  • 収集不可
• pausedForForwarding(optional): boolean
  読取り専用: true

  送信エージェントが現在転送を休止しているかどうかを示します。

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

  送信エージェントが現在メッセージの受信を休止しているかどうかを示します。

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

  受信エージェントが現在受信を休止しているかどうかを示します。

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

  このSAFエージェントがメッセージを格納および転送している現在のリモート・エンドポイント数。

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

  最後のリセット以降に、このSAFエージェントがメッセージを格納および転送した最大リモート・エンドポイント数。

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

  最後のリセット以降に、このSAFエージェントがメッセージを格納および転送したリモート・エンドポイント数。

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

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "bytesCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the current number of bytes. This number does not include the pending bytes.</p>"
        },
        "bytesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the peak number of bytes since the last reset.</p>"
        },
        "bytesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of pending bytes. 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 since the last reset.</p>"
        },
        "bytesThresholdTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the amount of time in the threshold condition since the last reset.</p>"
        },
        "conversationsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the current number of conversations</p>"
        },
        "conversationsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of conversations since the last reset.</p>"
        },
        "conversationsTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The total number of conversations since the last reset.</p>"
        },
        "failedMessagesTotal":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the total number of messages that have failed to be forwarded since the last reset.</p>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "messagesCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the current number of messages. This number includes the pending messages.</p>"
        },
        "messagesHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the peak number of messages since the last reset.</p>"
        },
        "messagesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the number of pending messages. Pending messages are over and above the current number of messages. A pending message is one that has either been sent in a transaction and not committed, or been forwarded but has not been acknowledged.</p>"
        },
        "messagesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages received since the last reset.</p>"
        },
        "messagesThresholdTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns 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>"
        },
        "pausedForForwarding":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether or not the sending agent is paused for forwarding at the current time.</p>"
        },
        "pausedForIncoming":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether or not the sending agent is paused for incoming messages at the current time.</p>"
        },
        "pausedForReceiving":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether or not the receiving agent is paused for receiving at the current time.</p>"
        },
        "remoteEndpointsCurrentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current number of remote endpoints to which this SAF agent has been storing and forwarding messages.</p>"
        },
        "remoteEndpointsHighCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The peak number of remote endpoints to which this SAF agent has been storing and forwarding messages since last reset.</p>"
        },
        "remoteEndpointsTotalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of remote endpoints to which this SAF agent has been storing and forwarding messages since last reset.</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":""
}

ネストされたスキーマ: ヘルス状態

タイプ: 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>"
}

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

タイプ: array

タイトル: Items

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

ソースを表示

• Array of: object 症状

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

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

ネストされたスキーマ: 症状

タイプ: 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>"
}

先頭に戻る