ジャンプ先

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

このシステム・コンポーネントの表示

get

/management/weblogic/{version}/serverConfig/systemComponents/{name}

このシステム・コンポーネントを表示します。

リクエスト

パス・パラメータ

• 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'を指定しないでください。

セキュリティ

• Admin: basic
  型: 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=machine

  マシン・リソースへのこのリソースのmachine参照。

• rel=systemComponentStart uri=/management/weblogic/{version}/serverConfig/systemComponents/{name}/systemComponentStart

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

本文()

ルート・スキーマ : システム・コンポーネント

型: object

ソースの表示

• autoRestart(optional): boolean
  デフォルト値: true

  このサーバーがクラッシュしたり予想外に停止したりしたときに、ノード・マネージャで自動的に再起動できるようにするかどうかを指定します。

• componentType(optional): string

  システム・コンポーネント・タイプを取得します。タイプの例として、OHS、Coherenceなどがあります。新しいシステム・コンポーネントが今後追加される可能性があるため、タイプのリストは静的ではありません。

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

  デフォルト値: false

  MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます

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

  このMBeanインスタンスの一意のIDを返します

• machine(optional): array マシン参照
  タイトル: Machine Reference

  マシン参照が含まれます。

  このサーバーが実行されるWebLogic Serverホスト・コンピュータ(マシン)。

  ノード・マネージャを使用してこのサーバーを起動する場合、マシンにサーバーを割り当て、ノード・マネージャ向けにマシンを構成する必要があります。

  サーバー・インスタンスがすでに実行中の場合は、この値を変更できません。

  制約

  • 再起動が必要
• name(optional): string
  読取り専用: true

  このサーバー・インスタンスの英数字からなる名前。(スペースは無効です。)

  この名前は、ドメイン内のすべての構成オブジェクトに対して一意である必要があります。ドメイン内では、各サーバー、マシン、クラスタ、JDBC接続プール、仮想ホスト、および他のすべてのタイプのリソースが一意な名前を持つ必要があり、ドメイン名と同じ名前を使用することはできません。

  このサーバー名は、サーバー上にデプロイされるアプリケーションのURLの一部に使用されるものではありません。この名前はあくまでも識別用の名前です。サーバー名は管理コンソールに表示され、WebLogic Serverコマンドライン・ユーティリティまたはAPIを使用している場合はこの名前でサーバーを識別します。

  サーバーの作成後にサーバー名を変更することはできません。かわりに、サーバーのクローンを作成し、そのクローンに新しい名前を付けます。

• notes(optional): string

  この構成の説明として任意に入力できる情報。

  WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity <)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。

  ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。

• restartDelaySeconds(optional): integer(int32)
  最小値: 0

  最大値: 2147483647

  デフォルト値: 0

  このサーバーを再起動するまでにノード・マネージャが待機する秒数。

  サーバー・プロセスの強制停止後、サーバーが使用していたTCPポートの解放に数秒かかる場合があります。管理対象サーバーのポートがアクティブな間に、ノード・マネージャが管理対象サーバーの再起動を試行した場合、起動時に障害が発生します。

  AutoMigrationが有効化されており、RestartDelaySecondsが0の場合、RestartDelaySecondsは自動的にリース期間に設定されます。これにより、以前のリースがまだ有効なときに、サーバーが移行後の起動に失敗することが回避されます。

• restartIntervalSeconds(optional): integer(int32)
  最小値: 300

  最大値: 2147483647

  デフォルト値: 3600

  このサーバーを再起動できる秒数。RestartMaxで指定された回数まで再起動できます。

• restartMax(optional): integer(int32)
  最小値: 0

  最大値: 2147483647

  デフォルト値: 2

  RestartIntervalSecondsで指定した間隔内で、ノード・マネージャがこのサーバーを再起動できる回数。

• tags(optional): array 項目
  タイトル: Items

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

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

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "autoRestart":{
            "default":true,
            "type":"boolean",
            "description":"<p> Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly. </p>"
        },
        "componentType":{
            "type":"string",
            "description":"<p>Get the system component type Examples of types may include \"OHS\", \"Coherence\". New System Components may be added in the future so the list of types is not static.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "machine":{
            "x-weblogic-restartRequired":true,
            "title":"Machine Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the machine reference. <p> The WebLogic Server host computer (machine) on which this server is meant to run. </p><p> If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager. </p><p> You cannot change this value if a server instance is already running. </p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>An alphanumeric name for this server instance. (Spaces are not valid.)</p><p>The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.</p><p>The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.</p><p>After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.</p>"
        },
        "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>"
        },
        "restartDelaySeconds":{
            "default":0,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p> The number of seconds the Node Manager should wait before restarting this server. </p><p> After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails. </p><p> If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid. </p>"
        },
        "restartIntervalSeconds":{
            "default":3600,
            "minimum":300,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p> The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax. </p>"
        },
        "restartMax":{
            "default":2,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p> The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds. </p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</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":""
}

ネストされたスキーマ: マシン参照

型: array

タイトル: Machine Reference

マシン参照が含まれます。

このサーバーが実行されるWebLogic Serverホスト・コンピュータ(マシン)。

ノード・マネージャを使用してこのサーバーを起動する場合、マシンにサーバーを割り当て、ノード・マネージャ向けにマシンを構成する必要があります。

サーバー・インスタンスがすでに実行中の場合は、この値を変更できません。

制約

• 再起動が必要

ソースの表示

• 配列: string

{
    "x-weblogic-restartRequired":true,
    "title":"Machine Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the machine reference. <p> The WebLogic Server host computer (machine) on which this server is meant to run. </p><p> If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager. </p><p> You cannot change this value if a server instance is already running. </p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

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

型: array

タイトル: Items

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

ソースの表示

• 配列: string

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

先頭に戻る