ジャンプ先

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

このリソース・グループ・コレクションの表示

get

/management/weblogic/{version}/serverConfig/resourceGroups

このリソース・グループ・コレクションを表示します。

リクエスト

パス・パラメータ

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

リソース・グループのエンティティのリストを返します。

本文()

ルート・スキーマ: 項目

型: array

タイトル: Items

ソースの表示

• 配列: object リソース・グループ

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Resource Group"
    },
    "description":""
}

ネストされたスキーマ: リソース・グループ

型: object

ソースの表示

• administrative(optional): boolean
  デフォルト値: false

  このリソース・グループに管理アプリケーションおよびリソースが含まれるかどうか。trueの場合、これは管理リソース・グループとみなされ、パーティション・ライフサイクルによって別に処理されます。具体的には、パーティションを停止すると、管理リソース・グループが実行中のままになります(停止されるのは、パーティションを中止した場合のみです)。

  このブール値はリソース・グループのターゲットに依存せず、autoTargetAdminServerブール値に依存しないことに注意してください。

• autoTargetAdminServer(optional): boolean
  デフォルト値: false

  このリソース・グループを管理サーバーに常にターゲット指定する必要があるか。trueの場合、このリソース・グループは、リソース・グループに明示的に設定されたターゲットに加え、パーティションの管理仮想ターゲット(AdminVT)を使用して、ドメインの管理サーバーにターゲット指定されます。これは、機能的にはパーティションの管理仮想ターゲットの取得およびリソース・グループのターゲット・リストへの明示的な追加と同じです。

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

  デフォルト値: false

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

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

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

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

  このMBeanインスタンスのユーザー定義の名前。

  この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています

  Name=user-specified-name

  制約

  • 有効なnull
• notes(optional): string

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

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

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

• resourceGroupTemplate(optional): array リソース・グループ・テンプレート参照
  タイトル: Resource Group Template Reference

  リソース・グループ・テンプレート参照が含まれます。

  このリソース・グループによって参照されるリソース・グループ・テンプレート。

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

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

• targets(optional): array ターゲット参照
  タイトル: Target References

  ターゲット参照の配列が含まれます。

  すべてのターゲットのリスト。

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

  MBeanのタイプを戻します。

  制約

  • 収集不可
• uploadDirectoryName(optional): string

  このリソース・グループ・テンプレートに対してアップロードされたアプリケーションが置かれる管理サーバー上のディレクトリ・パス。

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

  このリソース・グループが、リソース・グループを含むパーティションからデフォルト・ターゲットを使用するかどうかをチェックします。

{
    "type":"object",
    "properties":{
        "administrative":{
            "default":false,
            "type":"boolean",
            "description":"<p>Does this resource group contain administrative applications and resources? If true, then this is considered an administrative resource group and will be handled differently by the partition lifecycle. Specifically, an administrative resource group will be left running when a partition is shut down (it will be shut down only when the partition is halted).</p><p>Note that this Boolean is independent of the targeting of the resource group and works independently of the <code>autoTargetAdminServer</code> Boolean.</p>"
        },
        "autoTargetAdminServer":{
            "default":false,
            "type":"boolean",
            "description":"<p>Should this resource group always be targeted to the Administration Server? If true, then this resource group will be targeted to the domain's Administration Server using the partition's administrative virtual target (AdminVT) in addition to any targets explicitly set on the resource group. Functionally, this is similar to getting the partition's administrative virtual target and explicitly adding it to the list of resource group targets.</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>"
        },
        "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>"
        },
        "resourceGroupTemplate":{
            "title":"Resource Group Template Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the resource group template reference. <p>The resource group template referenced by this resource group.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "targets":{
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target 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 target reference."
            },
            "description":"Contains the array of target references. <p>A list of all the targets.</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>"
        },
        "uploadDirectoryName":{
            "type":"string",
            "description":"<p>The directory path on the Administration Server where the uploaded applications for this resource group template are placed.</p>"
        },
        "useDefaultTarget":{
            "default":true,
            "type":"boolean",
            "description":"<p>Checks whether this resource group uses the default target from the partition that contains the resource group.</p>"
        }
    },
    "description":""
}

ネストされたスキーマ: リソース・グループ・テンプレート参照

型: array

タイトル: Resource Group Template Reference

リソース・グループ・テンプレート参照が含まれます。

このリソース・グループによって参照されるリソース・グループ・テンプレート。

ソースの表示

• 配列: string

{
    "title":"Resource Group Template Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the resource group template reference. <p>The resource group template referenced by this resource group.</p>"
}

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

型: array

タイトル: Items

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

ソースの表示

• 配列: string

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

ネストされたスキーマ: ターゲット参照

型: array

タイトル: Target References

ターゲット参照の配列が含まれます。

すべてのターゲットのリスト。

ソースの表示

• 配列: object ターゲット参照
  タイトル: Target Reference

  ターゲット参照が含まれます。

{
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target 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 target reference."
    },
    "description":"Contains the array of target references. <p>A list of all the targets.</p>"
}

ネストされたスキーマ: ターゲット参照

型: object

タイトル: Target Reference

ターゲット参照が含まれます。

ソースの表示

• identity(optional): array アイデンティティ
  タイトル: Identity

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

{
    "title":"Target 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 target 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."
}

先頭に戻る