ジャンプ先

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

このRESTful管理サービスの表示

get

/management/weblogic/{version}/serverConfig/restfulManagementServices

このRESTful管理サービスを表示します。

リクエスト

パス・パラメータ

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

このRESTful管理サービスを返します。

本文()

ルート・スキーマ : RESTful管理サービス

型: object

ソースの表示

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

  資格証明がCORSリクエストに許可されるかどうかを決定します。

  値がfalseの場合、レスポンスには対応するCORS HTTPヘッダーが含まれません。

• CORSAllowedHeaders(optional): string
  デフォルト値: *

  CORSリクエストに許可されるHTTPヘッダーの値を決定します。

  許可されるヘッダー値は、HTTPヘッダー名のカンマ区切りリストを含む文字列です。デフォルト設定では、すべてのヘッダーが許可されます。

  値が空であるか指定されていない場合、レスポンスには対応するCORS HTTPヘッダーが含まれません。

• CORSAllowedMethods(optional): string
  デフォルト値: *

  CORSリクエストに許可されるHTTPメソッドの値を決定します。

  許可されるメソッド値は、HTTPメソッド名のカンマ区切りリストを含む文字列です。デフォルト設定では、すべてのメソッドが許可されます。

  値が空であるか指定されていない場合、レスポンスには対応するCORS HTTPヘッダーが含まれません。

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

  CORSリクエストに許可されるオリジンのリストを決定します。リストが空であるか指定されていないときにCORSサポートが有効になっている場合、すべてのオリジンが受け入れられます。指定する場合、HTTPオリジン・ヘッダーは、許可されているように構成された値の1つと正確に一致する必要があります。

  CORSオリジン値には、プロトコルおよびドメイン名が含まれます。また、ポート番号が含まれる場合もあります。許可されるオリジンの複数のバリアントを、ブラウザで使用されたオリジンに基づいて指定することが必要な場合があります。

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

  RESTful管理サービスWebアプリケーションでのCORS (Cross-Origin Resource Sharing)処理のサポートを有効にします。

• CORSExposedHeaders(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@255ad15e

  CORSリクエストに公開されるHTTPヘッダーの値を決定します。

  公開されるヘッダー値は、HTTPヘッダー名のカンマ区切りリストを含む文字列です。デフォルト設定では、特定のヘッダーは指定されません。

  値が空であるか指定されていない場合、レスポンスには対応するCORS HTTPヘッダーが含まれません。

• CORSMaxAge(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@163e027b

  CORS処理前リクエストのブラウザ・キャッシュの秒数を決定します。

  最大期間の値は、ブラウザ・キャッシュに使用される秒数の数値を含む文字列です。デフォルト設定では、値は指定されません。

  値が空であるか指定されていない場合、レスポンスには対応するCORS HTTPヘッダーが含まれません。

• delegatedRequestConnectTimeoutMillis(optional): integer(int32)
  最小値: 0

  デフォルト値: 30000

  管理サービスWebアプリケーションが、管理サーバーから管理対象サーバーへの冪等なRESTリクエストを伝播するときの、接続タイムアウト(ミリ秒)を決定します。

  DelegatedRequestConnectTimeouttMillisがゼロの場合は、基になるJAXRSクライアントAPI接続タイムアウト(デフォルト)が使用されます。

• delegatedRequestMaxWaitMillis(optional): integer(int32)
  最小値: 0

  デフォルト値: 0

  管理サーバーから管理対象サーバーに冪等なRESTリクエストを伝播するときに、管理サービスWebアプリケーションが待機する時間(ミリ秒)を指定します。ゼロの場合は、リクエストの伝播を1回試行します。ゼロ0より大きい場合は、リクエストが終了するか制限時間の超過を検出するまで、リクエストを再試行します。

  　

  リクエストはrequestMaxWaitMillis問合せパラメータを指定することで、この値をオーバーライドできます。

• delegatedRequestMinThreads(optional): integer(int32)
  最小値: 1

  デフォルト値: 25

  大規模ドメインでの応答性の向上を図るために管理対象サーバーと相互作用するときに、管理サービスWebアプリケーション専用のスレッドの最小数を指定します。

• delegatedRequestReadTimeoutMillis(optional): integer(int32)
  最小値: 0

  デフォルト値: 10000

  管理サービスWebアプリケーションが、管理サーバーから管理対象サーバーへの冪等なRESTリクエストを伝播するときの、読込みのタイムアウト(ミリ秒)を決定します。

  DelegatedRequestReadTimeoutMillisがゼロの場合は、基になるJAXRSクライアントAPI読取りタイムアウト(デフォルト)が使用されます。

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

  デフォルト値: false

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

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

  RESTful管理サービスWebアプリケーションによるこのWebLogic Serverの監視を有効にします。

• fannedOutRequestMaxWaitMillis(optional): integer(int32)
  最小値: 0

  デフォルト値: 180000

  管理サーバーからすべての管理対象サーバーに冪等なRESTリクエストを展開するときに、管理サービスWebアプリケーションが待機する時間(ミリ秒)を指定します。ゼロの場合は、適切なタイムアウトが選択されます。

  　

  リクエストはrequestMaxWaitMillis問合せパラメータを指定することで、この値をオーバーライドできます。

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

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

• javaServiceResourcesEnabled(optional): boolean

  クラウド環境でWebLogic ServerをJavaサービスとして管理するためのRESTリソース機能を、このドメイン内で有効にするかどうかを指定します。

• 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エンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。

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

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

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

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

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "CORSAllowedCredentials":{
            "default":false,
            "type":"boolean",
            "description":"<p>Determines if credentials are allowed for CORS requests.</p><p>When the value is false, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "CORSAllowedHeaders":{
            "default":"*",
            "type":"string",
            "description":"<p>Determines the value of allowed HTTP headers for CORS requests.</p><p>The allowed headers value is a string that contains a comma separated list of HTTP header names. The default setting allows all headers.</p><p>When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "CORSAllowedMethods":{
            "default":"*",
            "type":"string",
            "description":"<p>Determines the value of allowed HTTP methods for CORS requests.</p><p>The allowed methods value is a string that contains a comma separated list of HTTP method names. The default setting allows all methods.</p><p>When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "CORSAllowedOrigins":{
            "default":null,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Determines the list of allowed origins for CORS requests. When the list is empty or not specified and CORS support is enabled then all origins are accepted. When specified the HTTP Origin header must match exactly one of the values configured as allowed.</p><p>CORS origin values include protocol and domain name, they may also contain port numbers. Multiple variants of the allowed origin may need to be specified based on the origin used by the browser.</p>"
        },
        "CORSEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Enables the support of CORS (Cross-Origin Resource Sharing) processing in the RESTful Management Services Web application.</p>"
        },
        "CORSExposedHeaders":{
            "default":null,
            "type":"string",
            "description":"<p>Determines the value of exposed HTTP headers for CORS requests.</p><p>The exposed headers value is a string that contains a comma separated list of HTTP header names. The default setting does not specify any specific headers.</p><p>When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "CORSMaxAge":{
            "default":null,
            "type":"string",
            "description":"<p>Determines the number of seconds for a browser cache of CORS preflight requests.</p><p>The max age value is a string that contains a numeric value with the number of seconds used for the browser cache. The default setting does not specify any value.</p><p>When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "delegatedRequestConnectTimeoutMillis":{
            "default":30000,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Determines the connection timeout, in milliseconds, when the Management Services Web application propagates an idempotent REST request from the admin server to a managed server.</p><p> If DelegatedRequestConnectTimeouttMillis is zero, then the default underlying JAXRS client api connection timeout will be used.</p>"
        },
        "delegatedRequestMaxWaitMillis":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Determines how long the Management Services Web application will wait, in milliseconds, when it propagates an idempotent REST request from the admin server to a managed server.  If zero, then it will try to propagate the request once. If greater than zero, then it will retry the request until it finishes or until it detects that the time limit has been exceeded.</p><p>. </p><p>A request can override this value by specifying the requestMaxWaitMillis query parameter.</p>"
        },
        "delegatedRequestMinThreads":{
            "default":25,
            "minimum":1,
            "type":"integer",
            "format":"int32",
            "description":"<p>Specifies the minimum number of threads that should be dedicated to the Management Services Web application when interacting with managed servers in parallel for improved responsiveness in large domains.</p>"
        },
        "delegatedRequestReadTimeoutMillis":{
            "default":10000,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Determines the read timeout, in milliseconds, when the Management Services Web application propagates an idempotent REST request from the admin server to a managed server.</p><p> If DelegatedRequestReadTimeoutMillis is zero, then the default underlying JAXRS client api read timeout will be used.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Enables the monitoring of this WebLogic Server domain through the RESTful Management Services Web application.</p>"
        },
        "fannedOutRequestMaxWaitMillis":{
            "default":180000,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Determines how long the Management Services Web application will wait, in milliseconds, when it fans out an idempotent REST request from the admin server to all the managed servers.  If zero, then it will choose an appropriate timeout. </p><p>. </p><p>A request can override this value by specifying the requestMaxWaitMillis query parameter.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "javaServiceResourcesEnabled":{
            "type":"boolean",
            "description":"<p>Specifies whether the REST resource features for administering WebLogic Server as a Java Service within a cloud environment should be enabled in this domain.</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>"
        }
    },
    "description":""
}

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

型: array

タイトル: Items

CORSリクエストに許可されるオリジンのリストを決定します。リストが空であるか指定されていないときにCORSサポートが有効になっている場合、すべてのオリジンが受け入れられます。指定する場合、HTTPオリジン・ヘッダーは、許可されているように構成された値の1つと正確に一致する必要があります。

CORSオリジン値には、プロトコルおよびドメイン名が含まれます。また、ポート番号が含まれる場合もあります。許可されるオリジンの複数のバリアントを、ブラウザで使用されたオリジンに基づいて指定することが必要な場合があります。

デフォルト値: oracle.doceng.json.BetterJsonNull@3261ad4

ソースの表示

• 配列: string

{
    "default":null,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Determines the list of allowed origins for CORS requests. When the list is empty or not specified and CORS support is enabled then all origins are accepted. When specified the HTTP Origin header must match exactly one of the values configured as allowed.</p><p>CORS origin values include protocol and domain name, they may also contain port numbers. Multiple variants of the allowed origin may need to be specified based on the origin used by the browser.</p>"
}

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

型: array

タイトル: Items

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

ソースの表示

• 配列: string

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

先頭に戻る