Oracle WebLogic Server RESTfulサーバー・ランタイム管理インタフェース

JMSメッセージの取得

post

/management/weblogic/{version}/serverRuntime/SAFRuntime/agents/{name}/remoteEndpoints/{name}/getJMSMessages

指定されたJMSメッセージ・セレクタに一致するJMSMessageVBeanオブジェクトの配列を返します。sortOnパラメータを指定すると、配列はメッセージ・ヘッダー・フィールドで順序付けされます。

リクエスト

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

application/json

パス・パラメータ

name(required): string

コレクション内のインスタンスの名前プロパティ。
version(required): string

WebLogic RESTインタフェースのバージョン。

ヘッダー・パラメータ

X-Requested-By(required): string

X-Requested-Byヘッダーは、クロスサイト・リクエスト・フォージェリ(CSRF)攻撃からの保護に使用されます。値は、MyClientなどの任意の名前です。

次のフィールドが含まれている必要があります:

ルート・スキーマ: Arguments

タイプ: object

タイトル: Arguments

ソースを表示

ascending: array Items

タイトル: Items

ソート順が昇順か降順かを示します
max: integer(int32)

返すメッセージの最大数
selector: string

JMSメッセージ・セレクタ
sortOn: array Items

タイトル: Items

ソートするJMSヘッダー・フィールド。値には、メッセージ属性JMSMessageID、JMSTimestamp、JMSDeliveryTime、JMSType、JMSCorrelationID、JMSExpiration、JMSRedelivered、JMSPriority、JMS_BEA_Size、JMS_BEA_UnitOfOrder、JMS_BEA_Xid、JMS_BEA_State、JMS_BEA_SequenceNumber、および任意のメッセージ・プロパティ名を含めることができます。

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "ascending":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"boolean",
                "description":""
            },
            "description":"<p>Indicates whether sort order is ascending or descending</p>"
        },
        "max":{
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum number of messages to return</p>"
        },
        "selector":{
            "type":"string",
            "description":"<p>The JMS message selector</p>"
        },
        "sortOn":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The JMS header fields to sort on. Values can include message attributes JMSMessageID, JMSTimestamp, JMSDeliveryTime, JMSType, JMSCorrelationID, JMSExpiration, JMSRedelivered, JMSPriority, JMS_BEA_Size, JMS_BEA_UnitOfOrder, JMS_BEA_Xid, JMS_BEA_State, JMS_BEA_SequenceNumber, and arbitrary message property names.</p>"
        }
    },
    "description":""
}

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

タイプ: array

タイトル: Items

ソート順が昇順か降順かを示します

ソースを表示

配列: boolean

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"boolean",
        "description":""
    },
    "description":"<p>Indicates whether sort order is ascending or descending</p>"
}

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

タイプ: array

タイトル: Items

ソートするJMSヘッダー・フィールド。値には、メッセージ属性JMSMessageID、JMSTimestamp、JMSDeliveryTime、JMSType、JMSCorrelationID、JMSExpiration、JMSRedelivered、JMSPriority、JMS_BEA_Size、JMS_BEA_UnitOfOrder、JMS_BEA_Xid、JMS_BEA_State、JMS_BEA_SequenceNumber、および任意のメッセージ・プロパティ名を含めることができます。

ソースを表示

配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The JMS header fields to sort on. Values can include message attributes JMSMessageID, JMSTimestamp, JMSDeliveryTime, JMSType, JMSCorrelationID, JMSExpiration, JMSRedelivered, JMSPriority, JMS_BEA_Size, JMS_BEA_UnitOfOrder, JMS_BEA_Xid, JMS_BEA_State, JMS_BEA_SequenceNumber, and arbitrary message property names.</p>"
}

セキュリティ

管理者: 基本

タイプ: basic

説明: A user in the Admin security role.

トップに戻る

レスポンス

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

application/json

200レスポンス

次のフィールドが返されます:

ルート・スキーマ: Return

タイプ: object

タイトル: Return

ソースを表示

return: object JMS Messages V

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "$ref":"#/definitions/JMS Messages V"
        }
    },
    "description":""
}

ネストされたスキーマ: JMS Messages V

タイプ: object

ソースを表示

jmsMessages: array Items

タイトル: Items

読取り専用: true

指定されたフィルタ基準に一致するJMSメッセージを、指定された最大メッセージ数まで返します。
totalCount: integer(int64)

読取り専用: true

表示されない保留中のメッセージを含む、宛先のメッセージの総数。結果のメッセージが複数の宛先にまたがる可能性のあるJMSサーバー操作の場合、値はセレクタ基準に一致するメッセージの合計数を表します。
totalFilteredCount: integer(int64)

読取り専用: true

セレクタ基準に一致するメッセージの数。この値は、返されるメッセージ数よりも大きい場合があります。

{
    "type":"object",
    "properties":{
        "jmsMessages":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/JMS Message V"
            },
            "description":"<p>Returns the JMS messages that match the specified filter criteria, up to the maximum number of messages specified.</p>"
        },
        "totalCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The total number of messages on the destination, including pending messages that are not visible.  For JMS server operations, where the resulting messages could span multiple destinations, the value will represent the total number of messages matching the selector criteria.</p>"
        },
        "totalFilteredCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages matching the selector criteria.  Note that this value may be larger than the number of messages returned.</p>"
        }
    },
    "description":""
}

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

タイプ: array

タイトル: Items

読取り専用: true

指定されたフィルタ基準に一致するJMSメッセージを、指定された最大メッセージ数まで返します。

ソースを表示

配列: object JMS Message V

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/JMS Message V"
    },
    "description":"<p>Returns the JMS messages that match the specified filter criteria, up to the maximum number of messages specified.</p>"
}

ネストされたスキーマ: JMS Message V

タイプ: object

ソースを表示

header: object JMS Message Header V
metaData: object JMS Message Meta Data V

{
    "type":"object",
    "properties":{
        "header":{
            "readOnly":true,
            "$ref":"#/definitions/JMS Message Header V"
        },
        "metaData":{
            "readOnly":true,
            "$ref":"#/definitions/JMS Message Meta Data V"
        }
    },
    "description":""
}

ネストされたスキーマ: JMS Message Header V

タイプ: object

ソースを表示

jmsCorrelationID: string

読取り専用: true

相関IDを返します。
jmsDeliveryMode: string
読取り専用: true
次の配信モード値のいずれかを返します。
- persistent
- nonpersistent
jmsDestination: object JMS Destination V
jmsExpiration: integer(int64)

読取り専用: true

有効期限を返します。
jmsMessageID: string

読取り専用: true

メッセージIDを戻します。
jmsPriority: integer(int32)

読取り専用: true

優先順位を返します。
jmsRedelivered: boolean

読取り専用: true

再配信フラグを返します。
jmsReplyTo: object JMS Destination V
jmsTimestamp: integer(int64)

読取り専用: true

タイムスタンプを返します。
jmsType: string

読取り専用: true

タイプを返します。
properties: array Items

タイトル: Items

読取り専用: true

メッセージ・プロパティを返します

{
    "type":"object",
    "properties":{
        "jmsCorrelationID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the correlation ID.</p>"
        },
        "jmsDeliveryMode":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns one of the following delivery mode values:</p><ul><li><p>persistent</p></li><li><p>nonpersistent</p></li></ul>"
        },
        "jmsDestination":{
            "readOnly":true,
            "$ref":"#/definitions/JMS Destination V"
        },
        "jmsExpiration":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the expiration.</p>"
        },
        "jmsMessageID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the message ID.</p>"
        },
        "jmsPriority":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns the priority.</p>"
        },
        "jmsRedelivered":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Returns the redelivered flag.</p>"
        },
        "jmsReplyTo":{
            "readOnly":true,
            "$ref":"#/definitions/JMS Destination V"
        },
        "jmsTimestamp":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the timestamp.</p>"
        },
        "jmsType":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the type.</p>"
        },
        "properties":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/JMS Message Property V"
            },
            "description":"<p>Returns the message properties</p>"
        }
    },
    "description":""
}

ネストされたスキーマ: JMS Message Meta Data V

タイプ: object

ソースを表示

consumerID: string

読取り専用: true

コンシューマIDを返します。
destinationName: string

読取り専用: true

宛先の修飾された名前を返します。
messageSize: integer(int64)

読取り専用: true

メッセージのサイズをバイト単位で返します。
messageType: string
読取り専用: true
メッセージのタイプを返します。値は次のとおりです。
- bytes
- map
- object
- stream
- text
- xml
sequenceNumber: integer(int64)

読取り専用: true

内部シーケンス番号を返します。
state: string
読取り専用: true
1つ以上のスペース区切りの状態文字列で構成される文字列表現でメッセージ状態を返します。状態値には、次の1つ以上が含まれます。
- visible
- send
- receive
- transaction
- ordered
- delayed
- expired
- redelivery-count-exceeded
- paused
- sequenced
- unit-of-work-component
xid: string

読取り専用: true

関連付けられたグローバル・トランザクションのXidまたはnullを返します。

{
    "type":"object",
    "properties":{
        "consumerID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the consumer ID.</p>"
        },
        "destinationName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the decorated name of the destination.</p>"
        },
        "messageSize":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the size of the message in bytes.</p>"
        },
        "messageType":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the type of message.  The values include:</p><ul><li><p>bytes</p></li><li><p>map</p></li><li><p>object</p></li><li><p>stream</p></li><li><p>text</p></li><li><p>xml</p></li></ul>"
        },
        "sequenceNumber":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the internal sequence number.</p>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the message state in string representation consisting of one or more space-delimited state strings.  State values include one or more of the following:</p><ul><li><p>visible</p></li><li><p>send</p></li><li><p>receive</p></li><li><p>transaction</p></li><li><p>ordered</p></li><li><p>delayed</p></li><li><p>expired</p></li><li><p>redelivery-count-exceeded</p></li><li><p>paused</p></li><li><p>sequenced</p></li><li><p>unit-of-work-component</p></li></ul>"
        },
        "xid":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the Xid of associated global transaction or null.</p>"
        }
    },
    "description":""
}

ネストされたスキーマ: JMS Destination V

タイプ: object

ソースを表示

name: string

読取り専用: true

修飾された宛先名を返します。
serverName: string

読取り専用: true

JMSサーバー名を返します。
type: string

読取り専用: true

宛先のタイプ(キュー、トピックまたは匿名)を返します

{
    "type":"object",
    "properties":{
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the decorated destination name.</p>"
        },
        "serverName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the JMS server name.</p>"
        },
        "type":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the destination type (queue, topic or anonymous)</p>"
        }
    },
    "description":""
}

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

タイプ: array

タイトル: Items

読取り専用: true

メッセージ・プロパティを返します

ソースを表示

配列: object JMS Message Property V

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/JMS Message Property V"
    },
    "description":"<p>Returns the message properties</p>"
}

ネストされたスキーマ: JMS Message Property V

タイプ: object

ソースを表示

name: string

読取り専用: true

プロパティ名を返します。
type: string

読取り専用: true

プロパティの型を返します。型の値には、boolean、byte、short、int、long、float、double、Stringが含まれます。
value: string

読取り専用: true

プロパティ値を返します。

{
    "type":"object",
    "properties":{
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the property name.</p>"
        },
        "type":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the property type.  Type values include boolean, byte, short, int, long, float, double, and String.</p>"
        },
        "value":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the proeprty value.</p>"
        }
    },
    "description":""
}

トップに戻る