ジャンプ先

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

このカスタム・リソースの表示

get

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

セキュリティ

• 管理者: 基本
  タイプ: 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=customResource uri=/management/weblogic/{version}/edit/customResources/{name}/customResource

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

• rel=resource

  このリソースの、ディスクリプタ・リソースに対するresource参照。

• rel=subDeploymentCreateForm uri=/management/weblogic/{version}/edit/customResources/{name}/subDeploymentCreateForm

  このリソースのsubDeploymentsコレクション・リソースの作成フォーム・リソース。

• rel=subDeployments uri=/management/weblogic/{version}/edit/customResources/{name}/subDeployments

  このリソースのsubDeploymentsコレクション・リソース。

本文()

ルート・スキーマ: Custom Resource

タイプ: object

ソースを表示

• compatibilityName(optional): string

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

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

• deploymentOrder(optional): integer(int32)
  デフォルト値: 100

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

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

• deploymentPrincipalName(optional): string

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

• descriptorBeanClass(optional): string

  #getResourceメソッドによって返されるBeanのインタフェースを返します。

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

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

  デフォルトでは、ファイル名は、次のパターンを使用してBean名から導出されます。

  .xml

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

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

  デフォルト値: false

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

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

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

• moduleType(optional): string

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

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

  このBeanインスタンスの一意な識別子。

  制約

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

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

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

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

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

  読取り専用: true

  ディスクリプタ参照を含みます。

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

• resourceClass(optional): string

  これは、リソースのライフサイクルの管理に使用されるクラスの名前です。ResourceClassのインスタンスが作成され、DescriptorBeanに渡されます。この値が設定されていない場合、リソースはデプロイメント・ライフサイクルに参加せず、単純に他のサブシステムによって使用される構成情報の配布を表します。

• sourcePath(optional): string
• tags(optional): array Items
  タイトル: Items

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

• targets(optional): array Target References
  タイトル: Target References

  ターゲット参照の配列を含みます。

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

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

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "compatibilityName":{
            "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>"
        },
        "deploymentOrder":{
            "default":100,
            "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>"
        },
        "deploymentPrincipalName":{
            "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>"
        },
        "descriptorBeanClass":{
            "type":"string",
            "description":"<p>Returns the interface of the bean that is returned by the #getResource method.</p>"
        },
        "descriptorFileName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the file that contains the module. By default the file resides in the DOMAIN_DIR/config directory.</p><p>By default, the file name is derived 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>"
        },
        "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>"
        },
        "moduleType":{
            "type":"string",
            "description":"<p>The values match those defined by jsr88. This attribute may move to another MBean.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>Unique identifier for this bean instance.</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,
            "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>"
        },
        "resourceClass":{
            "type":"string",
            "description":"<p>This is the name of the class that is used to manage the lifecycle of the resource.  An instance of the ResourceClass is created and is passed the DescriptorBean.  If this value is not set then the resource does not participate in the deployment lifecycle and simply represent a distribution of configuration information to be used by other subsystems.</p>"
        },
        "sourcePath":{
            "type":"string",
            "description":""
        },
        "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>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>"
        },
        "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

ディスクリプタ参照を含みます。

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

ソースを表示

• 配列: string

{
    "readOnly":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>"
}

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

タイプ: array

タイトル: Items

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

ソースを表示

• 配列: string

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

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

タイプ: array

タイトル: Target References

ターゲット参照の配列を含みます。

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

ソースを表示

• 配列: object Target Reference
  タイトル: 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>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>"
}

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

トップに戻る