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

このコネクタ・コンポーネント・ランタイムの表示

get

/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}

このコネクタ・コンポーネント・ランタイムを表示します。

リクエスト

パス・パラメータ

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レスポンス

このコネクタ・コンポーネント・ランタイムを返します。

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

rel=action title=getConfiguration uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/getConfiguration
このリソースのgetConfigurationアクション・リソース。
rel=action title=getConnectionPool uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/getConnectionPool
このリソースのgetConnectionPoolアクション・リソース。
rel=action title=getInboundConnection uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/getInboundConnection
このリソースのgetInboundConnectionアクション・リソース。
rel=action title=getSchema uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/getSchema
このリソースのgetSchemaアクション・リソース。
rel=action title=resume uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/resume
このリソースのresumeアクション・リソース。
rel=action title=resumeAll uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/resumeAll
このリソースのresumeAllアクション・リソース。
rel=action title=suspend uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/suspend
このリソースのsuspendアクション・リソース。
rel=action title=suspendAll uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/suspendAll
このリソースのsuspendAllアクション・リソース。
rel=connectionPools uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/connectionPools
このリソースのconnectionPoolsコレクション・リソース。
rel=connectorServiceRuntime uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/connectorServiceRuntime
このリソースのconnectorServiceRuntimeシングルトン・リソース。
rel=connectorWorkManagerRuntime uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/connectorWorkManagerRuntime
このリソースのconnectorWorkManagerRuntimeシングルトン・リソース。
rel=inboundConnections uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/inboundConnections
このリソースのinboundConnectionsコレクション・リソース。
rel=workManagerRuntime uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/workManagerRuntime
このリソースのworkManagerRuntimeシングルトン・リソース。
rel=workManagerRuntimes uri=/management/weblogic/{version}/serverRuntime/connectorServiceRuntime/activeRAs/{name}/workManagerRuntimes
このリソースのworkManagerRuntimesコレクション・リソース。

ルート・スキーマ: Connector Component Runtime

タイプ: object

ソースを表示

activeVersion: boolean

読取り専用: true

このバージョンがアクティブなバージョンである場合にtrueを返します。このリソース・アダプタがバージョニングされていない場合にtrueを返します。
activeVersionId: string

読取り専用: true

アクティブ・バージョンのIDを取得します。
componentName: string
読取り専用: true
コネクタ・コンポーネントの名前を取得します。
制約
- 収集不可
configuration: string
読取り専用: true
RA構成を表すxml文字列を返します。最新のスキーマに対応するxmlが返されます。現在サポートされているバージョンは「1.0」です。
制約
- 収集不可
configurationVersion: string

読取り専用: true

最新の構成バージョンを返します。
configuredProperties: object Properties

タイトル: Properties

読取り専用: true

使用可能なその他のプロパティ: additionalProperties

リソース・アダプタ・ディスクリプタ情報のサブセットを取得します。
connectionPoolCount: integer(int32)

読取り専用: true

接続プールの数。
deploymentState: integer(int32)
読取り専用: true
モジュールの現在のデプロイ状態。
モジュールは、次のうちいずれかの状態になります。状態は、デプロイメントまたは管理者コンソールを介して変更できます。
- UNPREPARED。このモジュールは準備されておらず、アクティブにもなっていないことを示す状態。
- PREPARED。このアプリケーションのこのモジュールは準備ができているが、アクティブになっていないことを示す状態。クラスがロードされており、モジュールは検証されています。
- ACTIVATED。このモジュールは現在アクティブになっていることを示す状態。
- NEW。このモジュールの作成が終了し、初期化中であることを示す状態。
description: string
読取り専用: true
リソース・アダプタの説明を取得します。
制約
- 収集不可
descriptions: array Items
タイトル: Items

読取り専用: true
リソース・アダプタの説明を取得します。
制約
- 収集不可
EISResourceId: string
読取り専用: true
コンポーネントのEISResourceIdを返します。
制約
- 収集不可
EISType: string
読取り専用: true
EISタイプを取得します。
制約
- 収集不可
healthState: object Health State

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

読取り専用: true

リソース・アダプタのインバウンド接続の数。
jndiName: string
読取り専用: true
リソース・アダプタのJNDI名を取得します。
制約
- 収集不可
linkref: string
読取り専用: true
linkrefを取得します。
制約
- 収集不可
moduleId: string
読取り専用: true
このコンポーネントの識別子を返します。この識別子は、アプリケーション内で一意です。
一般的なモジュールでは、URIをIDとして使用します。web-uriがEAR内で一意ではない可能性があるため、Webモジュールはコンテキストルートを返します。
制約
- 収集不可
name: string
読取り専用: true
この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。
制約
- 収集不可
schema: string
読取り専用: true
RA構成の最新スキーマを取得します。
制約
- 収集不可
specVersion: string
読取り専用: true
仕様バージョンを取得します。
制約
- 収集不可
state: string

読取り専用: true

リソース・アダプタの状態を取得します。
suspendedState: integer(int32)

読取り専用: true

リソース・アダプタの一時停止状態の情報を取得します。
getState()がSUSPENDEDを返す場合、getSuspendedState()は、リソース・アダプタの一時停止している機能を示す整数を返します(INBOUND、OUTBOUND、WORK (ALL)から1つ以上、または何も一時停止していない場合は0)
type: string
読取り専用: true
MBeanのタイプを戻します。
制約
- 収集不可
vendorName: string
読取り専用: true
ベンダー名を取得します。
制約
- 収集不可
version: string
読取り専用: true
バージョンを取得します。
制約
- 収集不可
versioned: boolean

読取り専用: true

リソース・アダプタがバージョニングされているかどうかをチェックします。バージョニングされている場合はtrueを返します。
versionId: string

読取り専用: true

バージョンIDを取得します。

{
    "type":"object",
    "properties":{
        "EISResourceId":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the EISResourceId for the component.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "EISType":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the EIS type.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "activeVersion":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Return true if this version is the active version. Returns true if this resource adapter is not versioned.</p>"
        },
        "activeVersionId":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Get the active version Id.</p>"
        },
        "componentName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the name of the connector component.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "configuration":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Return the xml string representing the RA configuration. The xml corresponding to the latest schema is returned. The current supported version is \"1.0\"</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "configurationVersion":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Return the latest configuration version.</p>"
        },
        "configuredProperties":{
            "readOnly":true,
            "type":"object",
            "description":"<p> Gets a subset of the resource adapter descriptor information. </p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "connectionPoolCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of connection pools.</p>"
        },
        "deploymentState":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The current deployment state of the module.</p><p>A module can be in one and only one of the following states. State can be changed via deployment or administrator console.</p><ul><li><p>UNPREPARED. State indicating at this  module is neither  prepared or active.</p></li><li><p>PREPARED. State indicating at this module of this application is prepared, but not active. The classes have been loaded and the module has been validated.</p></li><li><p>ACTIVATED. State indicating at this module  is currently active.</p></li><li><p>NEW. State indicating this module has just been created and is being initialized.</p></li></ul>"
        },
        "description":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the Description for the resource adapter.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "descriptions":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Get the Descriptions for the resource adapter.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "inboundConnectionsCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of inbound connections for the resource adapter.</p>"
        },
        "jndiName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the Jndi name of the resource adapter.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "linkref":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the linkref.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "moduleId":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the identifier for this Component.  The identifier is unique within the application.</p><p>Typical modules will use the URI for their id.  Web Modules will return their context-root since the web-uri may not be unique within an EAR.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "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>"
        },
        "schema":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the latest schema for RA configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "specVersion":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the spec version.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Get the state of the resource adapter.</p>"
        },
        "suspendedState":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Gets the suspended state information of the resource adapter.</p><p>If getState() returns SUSPENDED then getSuspendedState() returns an integer describing which functions of the resource adapter are suspended: one or more of INBOUND, OUTBOUND or WORK (or ALL) or 0 for nothing suspended</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>"
        },
        "vendorName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the vendor name.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "version":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the version.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "versionId":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Get the version Id.</p>"
        },
        "versioned":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Check if the resource adapter is versioned. Returns true if it is.</p>"
        }
    },
    "description":""
}

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

タイプ: object

タイトル: Properties

読取り専用: true

使用可能なその他のプロパティ

ソースを表示

string

{
    "readOnly":true,
    "type":"object",
    "description":"<p> Gets a subset of the resource adapter descriptor information. </p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

リソース・アダプタ・ディスクリプタ情報のサブセットを取得します。

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

タイプ: array

タイトル: Items

読取り専用: true

リソース・アダプタの説明を取得します。

制約

収集不可

ソースを表示

配列: string

{
    "readOnly":true,
    "x-weblogic-unharvestable":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Get the Descriptions for the resource adapter.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
}

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

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

ソースを表示

配列: 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>"
}

トップに戻る