ジャンプ先

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

このJMSSAFメッセージ・ログ・ファイルの表示

get

/management/weblogic/{version}/serverConfig/resourceGroups/{name}/SAFAgents/{name}/JMSSAFMessageLogFile

このJMSSAFメッセージ・ログ・ファイルを表示します。

リクエスト

パス・パラメータ

• 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

  説明: 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レスポンス

このJMSSAFメッセージ・ログ・ファイルを返します。

本文()

ルート・スキーマ: JMSSAFメッセージ・ログ・ファイル

型: object

ソースの表示

• bufferSizeKB(optional): integer(int32)
  デフォルト値: 8

  基になるログ・バッファ・サイズ(KB単位)を取得します

• dateFormatPattern(optional): string

  ログに日付をレンダリングするために使用する日付フォーマット・パターン。DateFormatPatternの文字列はjava.text.SimpleDateFormatクラスの仕様に準拠します。

  制約

  • 有効なnull
• dynamicallyCreated(optional): boolean
  読取り専用: true

  デフォルト値: false

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

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

  最大値: 99999

  デフォルト値: 7

  サーバーがログをローテーションする際に作成するログ・ファイルの最大数。この数には、現在のメッセージを格納するためにサーバーで使用されているファイルは含まれません。(「ファイル数制限」を有効にする必要があります。)

  制約

  • 本番モード・デフォルト: 100
• fileMinSize(optional): integer(int32)
  最小値: 1

  最大値: 2097150

  デフォルト値: 500

  サーバーがログ・メッセージを別のファイルに移すトリガーとなるサイズ(1 - 2097150KB)。デフォルトは500 KBです。ログ・ファイルが指定の最小サイズに到達すると、以後サーバーはファイル・サイズをチェックする際に現在のログ・ファイルの名前をSERVER_NAME.lognnnnnに変更し、それ以降のメッセージを保存するための新規ログ・ファイルを作成します(ファイルのローテーション・タイプの「サイズ」を指定する必要があります)。

  制約

  • 本番モード・デフォルト: 5000
• fileName(optional): string
• fileTimeSpan(optional): integer(int32)
  最小値: 1

  デフォルト値: 24

  古いログ・メッセージが別のファイルに移される間隔(単位は時間)。(ファイルのローテーション・タイプの「時間」を指定する必要があります。)

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

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

• logFileRotationDir(optional): string

  ローテーションされたログ・ファイルが格納されるディレクトリ。デフォルトでは、ローテーションされたファイルはログ・ファイルと同じディレクトリに格納されます。

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

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

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

  古いメッセージを保存するためにこのサーバー・インスタンスが作成するファイルの数を制限するかどうかを示します。(ファイルのローテーション・タイプの「サイズ」または「時間」を指定する必要があります。)

  この制限に達すると、最も古いログ・ファイルが削除され、最新の接尾辞の付いた新しいログ・ファイルが作成されます。

  このオプションを有効にしない場合、新しいファイルが無限に作成されていくため、必要に応じてこれらのファイルを削除する必要があります。

  制約

  • 本番モード・デフォルト: true
• rotateLogOnStartup(optional): boolean
  デフォルト値: true

  起動サイクル中にサーバーがログ・ファイルをローテーションするかどうかを指定します。本番モードでのデフォルト値はfalseです。

  制約

  • 本番モード・デフォルト: false
• rotationTime(optional): string
  デフォルト値: 00:00

  時間ベースのローテーション順序の開始時間(時間および分)を指定します。

  この値で指定された時間に、現在のログ・ファイル名が変更されます。以後、「ファイル・ローテーション間隔」に指定された間隔でログ・ファイル名が変更されます。

  WebLogic Serverでは、ログ・ファイルが大きくなり過ぎないように、500MBのしきい値サイズ制限を設定しており、それを超えると強制的にローテーションが行われます。

  時間はH:mmのフォーマットで指定します。

  • は、1日のうちの時間です(0-23)

  • mmは分です

• rotationType(optional): string
  デフォルト値: bySize

  使用可能な値: [ "bySize", "byTime", "none", "bySizeOrTime" ]

  古いログ・メッセージを別のログ・ファイルに移すための条件。

  • NONE メッセージは1つのファイルに蓄積されます。サイズが大きくなり過ぎた場合、ファイルの内容を消去する必要があります。WebLogic Serverでは、ログ・ファイルが大きくなり過ぎないように、500MBのしきい値サイズ制限を設定しており、それを超えると強制的にローテーションが行われます。

  • SIZE ログ・ファイルがFileMinSizeに指定したサイズに達すると、サーバーによってファイル名がSERVER_NAME.lognnnnnに変更されます

  • TIME TimeSpanに指定した間隔で、サーバーによってファイル名がSERVER_NAME.lognnnnnに変更されます

  ファイル名が変更されると、以後のメッセージはログ・ファイル名として指定された名前の新しいファイルに蓄積されます。

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

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

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

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "bufferSizeKB":{
            "default":8,
            "type":"integer",
            "format":"int32",
            "description":"<p>Gets the underlying log buffer size in kilobytes</p>"
        },
        "dateFormatPattern":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The date format pattern used for rendering dates in the  log. The DateFormatPattern string conforms to the specification of the <code>java.text.SimpleDateFormat</code> class.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "fileCount":{
            "default":7,
            "x-weblogic-productionDefault":100,
            "minimum":1,
            "maximum":99999,
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)</p><p><h5>Constraints</h5></p><ul><li>production mode default : 100</li></ul>"
        },
        "fileMinSize":{
            "default":500,
            "x-weblogic-productionDefault":5000,
            "minimum":1,
            "maximum":2097150,
            "type":"integer",
            "format":"int32",
            "description":"<p>The size (1 - 2097150 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as <code><i>SERVER_NAME</i>.log<i>nnnnn</i></code> and create a new one to store subsequent messages. (Requires that you specify a file rotation type of <code>Size</code>.)</p><p><h5>Constraints</h5></p><ul><li>production mode default : 5000</li></ul>"
        },
        "fileName":{
            "type":"string",
            "description":""
        },
        "fileTimeSpan":{
            "default":24,
            "minimum":1,
            "type":"integer",
            "format":"int32",
            "description":"<p>The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of <code>TIME</code>.)</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "logFileRotationDir":{
            "type":"string",
            "description":"<p>The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.</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>"
        },
        "numberOfFilesLimited":{
            "default":true,
            "x-weblogic-productionDefault":true,
            "type":"boolean",
            "description":"<p>Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of <code>SIZE</code> or <code>TIME</code>.)</p><p>After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.</p><p>If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.</p><p><h5>Constraints</h5></p><ul><li>production mode default : true</li></ul>"
        },
        "rotateLogOnStartup":{
            "default":true,
            "x-weblogic-productionDefault":false,
            "type":"boolean",
            "description":"<p>Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.</p><p><h5>Constraints</h5></p><ul><li>production mode default : false</li></ul>"
        },
        "rotationTime":{
            "default":"00:00",
            "type":"string",
            "description":"<p>Determines the start time (hour and minute) for a time-based rotation sequence.</p><p>At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.</p><p>Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.</p><p>Use the following format: <code>H:mm</code>, where</p><ul><li><p><code></code> is Hour in day (0-23)</p></li><li><p><code>mm</code> is the minute in hour</p></li></ul>"
        },
        "rotationType":{
            "default":"bySize",
            "enum":[
                "bySize",
                "byTime",
                "none",
                "bySizeOrTime"
            ],
            "type":"string",
            "description":"<p>Criteria for moving old log messages to a separate file.</p><ul><li><p><code>NONE</code> Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.</p></li><li><p><code>SIZE</code> When the log file reaches the size that you specify in <code>FileMinSize</code>, the server renames the file as <code><i>SERVER_NAME</i>.log<i>nnnnn</i></code></p></li><li><p><code>TIME</code> At each time interval that you specify in <code>TimeSpan</code>, the server renames the file as <code><i>SERVER_NAME</i>.log<i>nnnnn</i></code></p></li></ul><p>After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.</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

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

ソースの表示

• 配列: string

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

先頭に戻る