ジャンプ先

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

このJMSシステム・リソースの表示

get

/management/weblogic/{version}/serverConfig/resourceGroupTemplates/{name}/JMSSystemResources/{name}

このJMSシステム・リソースを表示します。

リクエスト

パス・パラメータ

• 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

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

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

  説明: Monitorセキュリティ・ロールのユーザー。
• Operator: basic
  型: basic

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

このJMSシステム・リソースを返します。

本文 ()

ルート・スキーマ: JMS System Resource

型: object

ソースを表示

• compatibilityName(optional): string

  これは、ApplicationMBeanおよびComponentMBeanを使用して構成された8.1アプリケーションからの変換の結果作成されたBeanにのみ設定されます。

  8.1のスタンドアロン・モジュールには、ApplicationMBean名とComponentMBean名の両方があります。この属性は後者の名前を格納し、サーバーで下位互換用に一時ComponentMBeanが作成される場合に使用されます。

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• deploymentOrder(optional): integer(int32)
  デフォルト値: 100

  起動中にこのユニットがデプロイされた時を表す数値で、サーバー上の他のデプロイ可能ユニットに対する相対的な値。

  値の小さいユニットは、値の大きいユニットより先にデプロイされます。

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• deploymentPrincipalName(optional): string

  起動および停止中にファイルまたはアーカイブをデプロイするときに使用されるプリンシパルを示す文字列値。このプリンシパルは、ApplicationLifecycleListenerなどのインタフェース用のアプリケーション・コードを呼び出すときに、現在のサブジェクトを設定するために使用されます。プリンシパル名が指定されていない場合は、匿名プリンシパルが使用されます。

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• descriptorFileName(optional): string
  読取り専用: true

  モジュール構成を含むファイルの名前。デフォルトでは、ファイルはDOMAIN_DIR/config/jmsディレクトリにあります。

  モジュール・ファイルは、次のパターンを使用してBean名から名前を導出します。

  .xml

  これは、Beanの作成時にのみ設定できる読取り専用のプロパティです。

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• dynamicallyCreated(optional): boolean
  読取り専用: true

  デフォルト値: false

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

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• id(optional): integer(int64)
  読取り専用: true

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

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• moduleType(optional): string

  値は、jsr88によって定義された値と一致します。この属性は、別のMBeanに移動することができます。

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• name(optional): string
  読取り専用: true

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

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

  Name=user-specified-name

  制約

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

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

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

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

• resource(optional): array Descriptor Reference
  タイトル: Descriptor Reference

  読取り専用: true

  ディスクリプタ参照が含まれます。

  システム・リソースのディスクリプタを返します。これは、導出されたシステム・リソースによってオーバーライドされます。

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• sourcePath(optional): string

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• tags(optional): array Items
  タイトル: Items

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

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• targets(optional): array Target References
  タイトル: Target References

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

  現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。

  制約

  • ドメイン・スコープ指定MBeanには表示されません
• type(optional): string
  読取り専用: true

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "compatibilityName":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p> This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean. </p><p> Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "deploymentOrder":{
            "default":100,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.</p><p>Units with lower values are deployed before those with higher values.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "deploymentPrincipalName":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>A string value that indicates the principal that should be used when deploying the file or archive during startup and shutdown. This principal will be used to set the current subject when calling out into application code for interfaces such as ApplicationLifecycleListener. If no principal name is specified, then the anonymous principal will be used.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "descriptorFileName":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The name of the file that contains the module configuration. By default the file resides in the DOMAIN_DIR/config/jms directory.</p><p>The module file derives its name from the bean name using the following pattern:</p><p> <beanName>.xml </p><p>Note that this is a read-only property that can only be set when the bean is created.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "id":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "moduleType":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The values match those defined by jsr88. This attribute may move to another MBean.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "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>"
        },
        "resource":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Descriptor Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the descriptor reference. <p>Return the Descriptor for the system resource. This should be overridden by the derived system resources.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "sourcePath":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "tags":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "targets":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "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>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "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":""
}

ネストされたスキーマ: Descriptor Reference

型: array

タイトル: Descriptor Reference

読取り専用: true

ディスクリプタ参照が含まれます。

システム・リソースのディスクリプタを返します。これは、導出されたシステム・リソースによってオーバーライドされます。

制約

• ドメイン・スコープ指定MBeanには表示されません

ソースを表示

• 配列: string

{
    "readOnly":true,
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Descriptor Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the descriptor reference. <p>Return the Descriptor for the system resource. This should be overridden by the derived system resources.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}

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

型: array

タイトル: Items

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

制約

• ドメイン・スコープ指定MBeanには表示されません

ソースを表示

• 配列: string

{
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}

ネストされたスキーマ: Target References

型: array

タイトル: Target References

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

現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。

制約

• ドメイン・スコープ指定MBeanには表示されません

ソースを表示

• 配列: object Target Reference
  タイトル: Target Reference

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

{
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "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>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}

ネストされたスキーマ: Target Reference

型: object

タイトル: Target Reference

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

ソースを表示

• identity(optional): array Identity
  タイトル: 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."
}

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

先頭に戻る