Oracle WebLogic ServerのRESTfulドメイン構成管理インタフェース

このシングルトン・サービスの表示

get

/management/weblogic/{version}/domainConfig/singletonServices/{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'は指定できません。

セキュリティ

Admin: basic

型: basic

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

型: basic

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

型: basic

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

型: basic

説明: オペレータ・セキュリティ・ロールのユーザー。

トップに戻る

レスポンス

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

application/json

200レスポンス

このシングルトン・サービスを返します。

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

rel=cluster
クラスタ・リソースへのこのリソースのクラスタ参照。
rel=hostingServer
サーバー・リソースへのこのリソースのhostingServer参照。
rel=userPreferredServer
サーバー・リソースへのこのリソースのuserPreferredServer参照。

ルート・スキーマ: シングルトン・サービス

型: object

ソースの表示

additionalMigrationAttempts: integer(int32)

デフォルト値: 2

移行可能サービスが、構成されている可能性のあるサーバーのすべてに移行できないことがあります。この属性は、サービスが各サーバーに対して少なくとも1回ずつ移行を試みて失敗した後、さらに何回移行を試行するかを制御します。ここで指定された各試行は、構成されているすべてのサーバーを改めて一巡して移行を試行することを示しています。つまり、3サーバーのクラスタで値2が指定されている場合は、さらに4回移行が試行されます(元のサーバーは有効な移行先としてはカウントされません)
allCandidateServers: array サーバー参照

タイトル: Server References

サーバー参照の配列が含まれます。
この移行可能なターゲットにデプロイされるサービスをホストする候補サーバーのリストを戻します。ConstrainedCandidateServerリストが空の場合、クラスタ内のすべてのサーバーが戻されます。ConstrainedCandidateServerが空でない場合、指定されているサーバーのみが戻されます。ユーザーが優先するサーバーが、戻されるリスト内の最初の要素となります。
className: string
ロードし、実行するクラスの完全修飾名。クラスはサーバーのクラスパスに存在する必要があります。
たとえば、mycompany.mypackage.myclass
制約
- 有効なNULL
cluster: array クラスタ参照
タイトル: Cluster Reference
クラスタ参照が含まれます。
このシングルトン・サービスが関連付けられているクラスタを戻します。
制約
- 再起動が必要
constrainedCandidateServers: array サーバー参照
タイトル: Server References
サーバー参照の配列が含まれます。
移行可能なターゲットをホストする可能性のある、ユーザーが制限したサーバーのリストを戻します。戻されたサーバーのリストに含まれていないサーバーに、ターゲットを移行することはできません。この機能は、デュアル・ポート・ディスクに対してアクセスすることのある2つのサーバーを構成する場合などに使用します。このリスト内のすべてのサーバーは、移行可能なターゲットに関連付けられているクラスタの一部である必要があります。
制約
- 再起動が必要
dynamicallyCreated: boolean

読取り専用: true

デフォルト値: false

MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
hostingServer: array サーバー参照

タイトル: Server Reference

読取り専用: true

サーバー参照が含まれます。
シングルトン・サービスを現在ホストしているサーバーの名前を戻します。
id: integer(int64)

読取り専用: true

このMBeanインスタンスの一意のIDを返します
millisToSleepBetweenAttempts: integer(int32)

デフォルト値: 300000

getAdditionalMigrationAttempts()で示されている移行の試行間に、休止する時間の長さを制御します。この遅延は、サービスがすべてのサーバーには移行できなかった場合にのみ発生します。それ以外に、移行の試行間に遅延が発生することはありません。
name: string
読取り専用: true
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています
Name=user-specified-name
制約
- 有効なNULL
notes: string

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

タイトル: Items

この構成MBeanのすべてのタグを返します
type: string
読取り専用: true
MBeanのタイプを戻します。
制約
- unharvestable
userPreferredServer: array サーバー参照

タイトル: Server Reference

サーバー参照が含まれます。
ユーザーがシングルトン・サービスをアクティブにするように優先的に定義したサーバーを戻します。

{
    "type":"object",
    "properties":{
        "additionalMigrationAttempts":{
            "default":"2",
            "type":"integer",
            "format":"int32",
            "description":"<p>A migratable service could fail to come up on every possible configured server. This attribute controls how many further attempts, after the service has failed on every server at least once, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured servers. So for a 3-server cluster, and a value of 2, a total of 4 additional migrations will be attempted. (the original server is never a valid destination)</p>"
        },
        "allCandidateServers":{
            "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>Return a list of servers that are candidates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.</p>"
        },
        "className":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The fully qualified name of a class to load and run. The class must be on the server's classpath.</p><p>For example, <code>mycompany.mypackage.myclass</code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "cluster":{
            "x-weblogic-restartRequired":true,
            "title":"Cluster Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the cluster reference. <p>Returns the cluster this singleton service is associated with.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "constrainedCandidateServers":{
            "x-weblogic-restartRequired":true,
            "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>Returns the (user restricted) list of servers that may host the migratable target. The target will not be allowed to migrate to a server that is not in the returned list of servers. This feature is used to e.g. configure the two server that have access to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "hostingServer":{
            "readOnly":true,
            "title":"Server Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the server reference. <p>Returns the name of the server that currently hosts the singleton service.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "millisToSleepBetweenAttempts":{
            "default":"300000",
            "type":"integer",
            "format":"int32",
            "description":"<p>Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts(). Note that this delay only happens when the service has failed to come up on every server. It does not cause any sort of delay between attempts to migrate otherwise.</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>"
        },
        "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>"
        },
        "userPreferredServer":{
            "title":"Server Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the server reference. <p>Returns the server that the user prefers the singleton service to be active on.</p>"
        }
    },
    "description":""
}

ネストされたスキーマ: サーバー参照

型: array

タイトル: Server References

サーバー参照の配列が含まれます。

この移行可能なターゲットにデプロイされるサービスをホストする候補サーバーのリストを戻します。ConstrainedCandidateServerリストが空の場合、クラスタ内のすべてのサーバーが戻されます。ConstrainedCandidateServerが空でない場合、指定されているサーバーのみが戻されます。ユーザーが優先するサーバーが、戻されるリスト内の最初の要素となります。

ソースの表示

配列: object サーバー参照

タイトル: 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>Return a list of servers that are candidates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.</p>"
}

ネストされたスキーマ: クラスタ参照

型: array

タイトル: Cluster Reference

クラスタ参照が含まれます。

このシングルトン・サービスが関連付けられているクラスタを戻します。

制約

再起動が必要

ソースの表示

配列: string

{
    "x-weblogic-restartRequired":true,
    "title":"Cluster Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the cluster reference. <p>Returns the cluster this singleton service is associated with.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

ネストされたスキーマ: サーバー参照

型: array

タイトル: Server References

サーバー参照の配列が含まれます。

移行可能なターゲットをホストする可能性のある、ユーザーが制限したサーバーのリストを戻します。戻されたサーバーのリストに含まれていないサーバーに、ターゲットを移行することはできません。この機能は、デュアル・ポート・ディスクに対してアクセスすることのある2つのサーバーを構成する場合などに使用します。このリスト内のすべてのサーバーは、移行可能なターゲットに関連付けられているクラスタの一部である必要があります。

制約

再起動が必要

ソースの表示

配列: object サーバー参照

タイトル: Server Reference

サーバー参照が含まれます。

{
    "x-weblogic-restartRequired":true,
    "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>Returns the (user restricted) list of servers that may host the migratable target. The target will not be allowed to migrate to a server that is not in the returned list of servers. This feature is used to e.g. configure the two server that have access to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

ネストされたスキーマ: サーバー参照

型: array

タイトル: Server Reference

読取り専用: true

サーバー参照が含まれます。

シングルトン・サービスを現在ホストしているサーバーの名前を戻します。

ソースの表示

配列: string

{
    "readOnly":true,
    "title":"Server Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the server reference. <p>Returns the name of the server that currently hosts the singleton service.</p>"
}

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

型: array

タイトル: Items

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

ソースの表示

配列: string

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

ネストされたスキーマ: サーバー参照

型: array

タイトル: Server Reference

サーバー参照が含まれます。

ユーザーがシングルトン・サービスをアクティブにするように優先的に定義したサーバーを戻します。

ソースの表示

配列: string

{
    "title":"Server Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the server reference. <p>Returns the server that the user prefers the singleton service to be active on.</p>"
}

ネストされたスキーマ: サーバー参照

型: object

タイトル: Server Reference

サーバー参照が含まれます。

ソースの表示

identity: array アイデンティティ

タイトル: 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."
}

ネストされたスキーマ: アイデンティティ

型: 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."
}

ネストされたスキーマ: サーバー参照

型: object

タイトル: Server Reference

サーバー参照が含まれます。

ソースの表示

identity: array アイデンティティ

タイトル: 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."
}

ネストされたスキーマ: アイデンティティ

型: 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."
}

トップに戻る