ジャンプ先

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

このWLDF収集タイプの表示

get

/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/harvester/harvestedTypes/{name}

このWLDF収集タイプを表示します。

リクエスト

パス・パラメータ

• name: string
  コレクション内のインスタンスのnameプロパティ。
• version: 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

  説明: A user in the Admin security role.
• Deployer: basic
  タイプ: Basic

  説明: A user in the Deployer security role.
• Monitor: basic
  タイプ: Basic

  説明: A user in the Monitor security role.
• Operator: basic
  タイプ: Basic

  説明: A user in the Operator security role.

先頭に戻る

レスポンス

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

• application/json

200レスポンス

このWLDF収集タイプを返します。

ボディ()

ルート・スキーマ: WLDF Harvested Type

タイプ: object

ソースを表示

• enabled (オプション): boolean
  デフォルト値: true

  このタイプが有効化されるかどうかを指定します。ハーベスタ・コンポーネントが有効でない場合、タイプを有効にしても効果がないことに注意してください。

  値trueは、このタイプが収集されることを意味します。値falseは、このタイプが収集されないことを示します。

• harvestedAttributes (オプション): array Items
  タイトル: Items

  収集されたこの型の属性。属性のリストが指定されている場合、それらの属性のみが収集されます。指定されていない場合は収集できるすべての属性が収集されます。

• harvestedInstances (オプション): array Items
  タイトル: Items

  収集されたこの型のインスタンス。

  型の構成には、特定のインスタンスに対する識別子のセットを指定することもできます。このリストが指定されていると、指定されたインスタンスのみが収集されます。指定されていない場合は、この型のすべてのインスタンスが収集されます。

  インスタンスの識別子は、有効なJMX ObjectNameまたはObjectNameパターンでなければなりません。

• id (オプション): integer(int64)
  読取り専用: true

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

• knownType (オプション): boolean
  デフォルト値: false

  起動時にこのタイプが認識されるかどうかを指定します。通常、タイプが使用可能でない場合、ハーベスタはその検索を続けます。タイプが認識されると指定されている場合、タイプをすぐに解決できないとハーベスタは検証エラーを発行します。

  値trueは、このタイプが認識されることを意味します。値falseは、このタイプが認識されない可能性があることを示します。

  このフラグは、タイプ情報が常に使用可能であるWebLogic Serverタイプに有用です。この場合、フラグをtrueに設定すると、問題が早期に検出およびレポートされます。

  このフラグはオプションですが、WebLogic Serverでは推奨されます。

• name (オプション): string

  タイプ名。WebLogic ServerランタイムMBeanの場合、タイプ名は定義元インタフェースの完全修飾名です。カスタマMBeanの場合、タイプ名は完全修飾のMBean実装クラスです。

  制約

  • 有効なnull
• namespace (オプション): string
  デフォルト値: ServerRuntime

  指定可能な値: [ "ServerRuntime", "DomainRuntime" ]

  収集する型定義のネームスペース。

  制約

  • 有効なnull

{
    "type":"object",
    "properties":{
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether this type is enabled. Note that enabling a type will have no effect unless the Harvester component is also enabled.</p><p>A <code>true</code> value means that this type is harvested. A <code>false</code> value indicates that that this type is not harvested.</p>"
        },
        "harvestedAttributes":{
            "default":null,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The harvested attributes for this type. If a list of attributes is provided, only those attributes are harvested; otherwise all harvestable attributes are harvested.</p>"
        },
        "harvestedInstances":{
            "default":null,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The harvested instances of this type.</p><p>The configuration of a type can optionally provide a set of identifiers for specific instances. If this list is provided, only the provided instances are harvested; otherwise all instances of the type are harvested.</p><p>The identifier for an instance must be a valid JMX ObjectName or an ObjectName pattern.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique id of this bean instance.</p>"
        },
        "knownType":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether this type is known at startup.  Normally, if a type is not available, the Harvester will keep looking for it. If a type is designated as \"known\", the Harvester issues a validation fault if the type cannot be immediately resolved.</p><p>A <code>true</code> value means that this type is known. A <code>false</code> value indicates that this type may not be known.</p><p>This flag is useful for WebLogic Server types, where the type information is always available.  In this case, setting the flag to true results in earlier detection and reporting of problems.</p><p>This flag is optional, but is recommended for WebLogic Server types.</p>"
        },
        "name":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The type name. For WebLogic Server runtime MBeans, the type name is the fully qualified name of the defining interface. For customer MBeans, the type name is the fully qualified MBean implementation class.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "namespace":{
            "default":"ServerRuntime",
            "enum":[
                "ServerRuntime",
                "DomainRuntime"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The namespace for the harvested type definition.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        }
    },
    "description":""
}

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

タイプ: array

タイトル: Items

収集されたこの型の属性。属性のリストが指定されている場合、それらの属性のみが収集されます。指定されていない場合は収集できるすべての属性が収集されます。

デフォルト値: oracle.doceng.json.BetterJsonNull@4481bb41

ソースを表示

• 配列: string

{
    "default":null,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The harvested attributes for this type. If a list of attributes is provided, only those attributes are harvested; otherwise all harvestable attributes are harvested.</p>"
}

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

タイプ: array

タイトル: Items

収集されたこの型のインスタンス。

型の構成には、特定のインスタンスに対する識別子のセットを指定することもできます。このリストが指定されていると、指定されたインスタンスのみが収集されます。指定されていない場合は、この型のすべてのインスタンスが収集されます。

インスタンスの識別子は、有効なJMX ObjectNameまたはObjectNameパターンでなければなりません。

デフォルト値: oracle.doceng.json.BetterJsonNull@59e0cb10

ソースを表示

• 配列: string

{
    "default":null,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The harvested instances of this type.</p><p>The configuration of a type can optionally provide a set of identifiers for specific instances. If this list is provided, only the provided instances are harvested; otherwise all instances of the type are harvested.</p><p>The identifier for an instance must be a valid JMX ObjectName or an ObjectName pattern.</p>"
}

先頭に戻る