Oracle WebLogic Server RESTful編集管理インタフェース

このSNMPゲージ・モニターの表示

get

/management/weblogic/{version}/edit/SNMPAgent/SNMPGaugeMonitors/{name}

このSNMPゲージ・モニターを表示します。

リクエスト

パス・パラメータ

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は指定できません。

セキュリティ

管理者: 基本

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

このSNMPゲージ・モニターを返します。

ルート・スキーマ: SNMP Gauge Monitor

タイプ: object

ソースを表示

dynamicallyCreated(optional): boolean

読取り専用: true

デフォルト値: false

MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
enabledServers(optional): array Server References

タイトル: Server References

サーバー参照の配列を含みます。
この属性は、SNMPエージェントがWebLogicドメインの管理サーバー上で動作している場合にのみ適用されます。EnabledServers属性によって、ユーザーは監視対象となるデータ・ソースの範囲を指定したサーバーに制限できます。SNMAgentDeploymentMBeanが管理対象サーバーに割り当てられている場合、EnabledServersリストは無視されます。管理対象サーバーの場合、SNMPエージェントはSNMPエージェントをデプロイしているWebLogicサーバー上にあるデータのみを監視します。
MBean属性を基準とするトラップでは、SNMPエージェントは管理サーバー上で動作しているときはドメイン実行時MBeanサーバーを参照し、管理対象サーバーにデプロイされるときは実行時MBeanサーバーを参照します。
SNMPJMXMonitorMBeanおよびSNMPAttributeChangeMBeanの場合、MonitoredMBeanTypeおよびMonitoredMBeanName属性はトラップを設定するWebLogic Server MBeanのタイプと名前を指定します。タイプおよび属性の条件に一致するMBeanは、トラップをオンに設定するように修飾されています。EnabledServers属性は、SNMPエージェントが管理サーバーをターゲットとしている場合、MBeanの場所を基準として追加の条件を指定することを許可します。EnabledServersリスト内のサーバーの1つと場所が一致しているMBeanは、対応するJMX通知のために生成されるトラップに適しているとみなされます。EnabledServers属性が指定されていない場合、タイプと名前が一致するすべてのMBeanはSNMPトラップの有効なソースとみなされます。
SNMPLogFilterMBeanの場合、EnabledServers属性はエージェントが管理サーバーで動作しているときにログ・メッセージが監視されるドメイン内のサーバーを指定することを許可します。管理サーバーで動作しているエージェントでEnabledServersが指定されていない場合、ドメイン内のすべての管理対象サーバーのログ・メッセージは、送信トラップで監視されます。この属性は、SNMPエージェントが管理対象サーバーに割り当てられている場合には適用されません。この場合、トラップはエージェントがデプロイされたそれぞれの管理対象サーバーによって生成されたログ・メッセージを基準に送信されます。
id(optional): integer(int64)

読取り専用: true

このMBeanインスタンスの一意のIDを返します
monitoredAttributeName(optional): string

監視するMBean属性の名前。この属性は、WebLogic Server MIB内に存在している必要があります。
monitoredMBeanName(optional): string

監視するMBeanインスタンスの名前。この名前を未定義のままにした場合、「監視するMBeanタイプ」で指定したMBeanタイプのすべてのインスタンスが監視されます。
SNMPエージェントを個々の管理ターゲット・サーバーにターゲット指定する場合は、指定するMBeanインスタンスがターゲットの管理ターゲット・サーバー上で必ずアクティブになるようにしてください。たとえば、ServerRuntimeMBeanインスタンスの名前としてMServer1を指定した場合は、SNMPエージェントを管理サーバーかMServer1という管理対象サーバーにターゲット指定した場合にのみ、この監視が機能します
MBeanインスタンスの完全なJMXオブジェクト名を入力しないでください。かわりに、オブジェクト名のName=nameの名前と値の組合せの値のみを入力します。一意なMBeanオブジェクト名を作成するには、WebLogic Serverは各オブジェクト名として、いくつかの名前と値の組合せをエンコードします。これらの組合せの1つに、Name=nameがあります。例:
"MedRec:Name=MedRecServer
Type=ServerRuntime"
前述の例では、MBeanインスタンスの名前として、MedRecServerを指定します。
monitoredMBeanType(optional): string

監視する属性を定義するMBeanタイプ。MBeanサフィックスは付けないようにしてください。例: ServerRuntime
name(optional): string
読取り専用: true
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています
Name=user-specified-name
制約
- 有効なnull
notes(optional): string

この構成の説明として任意に入力できる情報。
WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このメモをXML PCDATAとして保存します。すべての左山カッコ(<)はXMLエンティティ<に変換されます。キャリッジ・リターンとライン・フィードは維持されます。
注意: 管理コンソールからメモを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。


            
             pollingInterval(optional): integer(int32)
            
                
                




最小値: 1





最大値: 65535











デフォルト値: 10







WebLogic Serverが属性値をチェックする周期(単位: 秒)。




                
            
            
            
             tags(optional): array  Items
            
            
                
                
タイトル: Items





















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


                
            
            
            
             thresholdHigh(optional): number(double)
            
                
                
























通知が生成される最大しきい値。監視対象の値が初めてこの値以上になると通知が生成されます。
その後に最大しきい値を超過しても、属性値が最小しきい値以下にならないかぎり、追加の通知は生成されません。




                
            
            
            
             thresholdLow(optional): number(double)
            
                
                
























通知が生成される最小しきい値。監視対象の値が初めてこの値以下になると通知が生成されます。
 その後に最小しきい値を超過しても、属性値が最大しきい値以上にならないかぎり、追加の通知は生成されません。 




                
            
            
            
             type(optional): string
            
                
                


読取り専用: true























MBeanのタイプを戻します。
制約
収集不可


        {
    "type":"object",
    "properties":{
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "enabledServers":{
            "title":"Server References",
            "type":"array",
            "items":{
                "title":"Server Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the server reference."
            },
            "description":"Contains the array of server references. <p>This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed. </p><p> For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server. </p><p> In the case of <code>SNMPJMXMonitorMBean</code> and <code>SNMPAttributeChangeMBean</code> the <code>MonitoredMBeanType</code> and <code>MonitoredMBeanName</code> attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap. </p><p> In the case of <code>SNMPLogFilterMBean</code> the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed. </p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "monitoredAttributeName":{
            "type":"string",
            "description":"<p>The name of an MBean attribute to monitor. This attribute must be in the WebLogic Server MIB.</p>"
        },
        "monitoredMBeanName":{
            "type":"string",
            "description":"<p>The name of the MBean instance that you want to monitor. If you leave the name undefined, WebLogic Server monitors all instances of the MBean type that you specify in Monitored MBean Type.</p><p>If you target SNMP agents to individual Managed Servers, make sure that the MBean instance you specify is active on the Managed Servers you have targeted. For example, if you specify <code>MServer1</code> as the name of a ServerRuntimeMBean instance, this monitor will only function if you target an SNMP agent either to the Administration Server or to a Managed Server named <code>MServer1</code></p><p>Do not enter the full JMX object name of the MBean instance. Instead, enter only the value of the object name's <code>Name=<i>name</i></code> name-value pair. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs is <code>Name=<i>name</i></code>. For example:</p><p><code>\"MedRec:<b>Name=MedRecServer</b></code><br><code>Type=ServerRuntime\"</code></p><p>In the previous example, specify <code>MedRecServer</code> as the name of the MBean instance.</p>"
        },
        "monitoredMBeanType":{
            "type":"string",
            "description":"<p>The MBean type that defines the attribute you want to monitor. Do not include the <code>MBean</code> suffix. For example, <code>ServerRuntime</code></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>"
        },
        "pollingInterval":{
            "default":10,
            "minimum":1,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>The frequency (in seconds) that WebLogic Server checks the attribute value.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "thresholdHigh":{
            "type":"number",
            "format":"double",
            "description":"<p>The high threshold at which a notification should be generated. A notification is generated the first time the monitored value is equal to or greater than this value.</p><p>Subsequent crossings of the high threshold value do not cause additional notifications unless the attribute value becomes equal to or less than the low threshold value.</p>"
        },
        "thresholdLow":{
            "type":"number",
            "format":"double",
            "description":"<p>The low threshold at which a notification should be generated. A notification is generated the first time the monitored value is less than or equal to this value.</p><p> Subsequent crossings of the low threshold value do not cause additional notifications unless the attribute value becomes equal to or greater than the high threshold value. </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":""
}



                    
                    
    ネストされたスキーマ: Server References
    
      
      タイプ: array
    

    

    
    タイトル: Server References
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    サーバー参照の配列を含みます。 この属性は、SNMPエージェントがWebLogicドメインの管理サーバー上で動作している場合にのみ適用されます。EnabledServers属性によって、ユーザーは監視対象となるデータ・ソースの範囲を指定したサーバーに制限できます。SNMAgentDeploymentMBeanが管理対象サーバーに割り当てられている場合、EnabledServersリストは無視されます。管理対象サーバーの場合、SNMPエージェントはSNMPエージェントをデプロイしているWebLogicサーバー上にあるデータのみを監視します。 
 MBean属性を基準とするトラップでは、SNMPエージェントは管理サーバー上で動作しているときはドメイン実行時MBeanサーバーを参照し、管理対象サーバーにデプロイされるときは実行時MBeanサーバーを参照します。 
 SNMPJMXMonitorMBeanおよびSNMPAttributeChangeMBeanの場合、MonitoredMBeanTypeおよびMonitoredMBeanName属性はトラップを設定するWebLogic Server MBeanのタイプと名前を指定します。タイプおよび属性の条件に一致するMBeanは、トラップをオンに設定するように修飾されています。EnabledServers属性は、SNMPエージェントが管理サーバーをターゲットとしている場合、MBeanの場所を基準として追加の条件を指定することを許可します。EnabledServersリスト内のサーバーの1つと場所が一致しているMBeanは、対応するJMX通知のために生成されるトラップに適しているとみなされます。EnabledServers属性が指定されていない場合、タイプと名前が一致するすべてのMBeanはSNMPトラップの有効なソースとみなされます。 
 SNMPLogFilterMBeanの場合、EnabledServers属性はエージェントが管理サーバーで動作しているときにログ・メッセージが監視されるドメイン内のサーバーを指定することを許可します。管理サーバーで動作しているエージェントでEnabledServersが指定されていない場合、ドメイン内のすべての管理対象サーバーのログ・メッセージは、送信トラップで監視されます。この属性は、SNMPエージェントが管理対象サーバーに割り当てられている場合には適用されません。この場合、トラップはエージェントがデプロイされたそれぞれの管理対象サーバーによって生成されたログ・メッセージを基準に送信されます。 
    

    

    

    

    
        ソースを表示
        
            
             配列: object  Server Reference
            
            
                
                
タイトル: Server Reference





















サーバー参照を含みます。


                
            
            
            
        
        {
    "title":"Server References",
    "type":"array",
    "items":{
        "title":"Server Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the server reference."
    },
    "description":"Contains the array of server references. <p>This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed. </p><p> For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server. </p><p> In the case of <code>SNMPJMXMonitorMBean</code> and <code>SNMPAttributeChangeMBean</code> the <code>MonitoredMBeanType</code> and <code>MonitoredMBeanName</code> attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap. </p><p> In the case of <code>SNMPLogFilterMBean</code> the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed. </p>"
}
    

    

    

    

    

    




                    
                    
    ネストされたスキーマ: Items
    
      
      タイプ: array
    

    

    
    タイトル: Items
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

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

    

    

    

    
        ソースを表示
        
            
             配列: string
            
            
                
                





























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

    

    

    

    

    




                    
                    
    ネストされたスキーマ: Server Reference
    
      タイプ: object
      
    

    

    
    タイトル: Server Reference
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    サーバー参照を含みます。
    

    

    

    
        ソースを表示
        
            
             identity(optional): array  Identity
            
            
                
                
タイトル: Identity





















DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。


                
            
            
            
        
        {
    "title":"Server Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the server reference."
}
    

    

    

    

    

    

    




                    
                    
    ネストされたスキーマ: Identity
    
      
      タイプ: array
    

    

    
    タイトル: Identity
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。
    

    

    

    

    
        ソースを表示
        
            
             配列: string
            
            
                
                





























                
            
            
            
        
        {
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}


                

				トップに戻る