ジャンプ先

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

このJMSコンシューマ・ランタイムの表示

get

/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime/connections/{name}/sessions/{name}/consumers/{name}

このJMSコンシューマ・ランタイムを表示します。

リクエスト

パス・パラメータ

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

このJMSコンシューマ・ランタイムを返します。

本文()

ルート・スキーマ: JMS Consumer Runtime

タイプ: object

ソースを表示

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

  コンシューマがアクティブかどうかを示します。メッセージ・リスナーが設定されているか、または同期受信が進行中のコンシューマはアクティブです。

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

  このコンシューマによって保留中(未コミットかつ未応答)にされているバイト数。

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

  最後のリセット以降にこのコンシューマが受信したバイト数。

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

  この接続のクライアントID。

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

  この接続のClientIDPolicyまたは恒久サブスクライバ。

  有効な値:

  • weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_RESTRICTED: クラスタには、特定のClientIDの接続について、このポリシーを使用する接続がどの時点においても1つのみ存在します。

  • weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_UNRESTRICTED: このポリシーを使用して作成された接続では、すでに他の制限付きまたは制限なしの接続で同じClientIDが使用されていても、任意のClientIDを指定できます

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

  このコンシューマの宛先の名前。分散宛先の場合は、メンバー宛先ではなく分散宛先の名前になります。

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

  コンシューマが恒久的かどうかを示します。

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

  このコンシューマの宛先の名前。分散宛先の場合は、メンバー宛先の名前になります。

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

  このコンシューマによって保留中(未コミットかつ未応答)にされているメッセージの数。

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

  最後のリセット以降にこのコンシューマが受信したメッセージの数。

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

  この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

  制約

  • 収集不可
• selector(optional): string
  読取り専用: true

  このコンシューマに関連付けられているセレクタ(存在する場合)。

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

  このサブスクライバのサブスクリプション共有ポリシー。

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

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "active":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the consumer active. A consumer is active if it has a message listener set up or a synchronous receive in progress.</p>"
        },
        "bytesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of bytes pending (uncommitted and unacknowledged) by this consumer.</p>"
        },
        "bytesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of bytes received by this consumer since the last reset.</p>"
        },
        "clientID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The client ID for this connection.</p>"
        },
        "clientIDPolicy":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The ClientIDPolicy on this connection or durable subscriber.</p><p> Valid values are: </p><ul><li><p><code>weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_RESTRICTED</code>: Only one connection that uses this policy exists in a cluster at any given time for a particular <code>ClientID</code></p></li><li><p><code>weblogic.management.configuration.JMSConstants.CLIENT_ID_POLICY_UNRESTRICTED</code>:  Connections created using this policy can specify any <code>ClientID</code>, even when other restricted or unrestricted connections already use the same <code>ClientID</code></p></li></ul>"
        },
        "destinationName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the destination for this consumer. In case of a distributed destination, it is the name of the distributed destination, instead of the member destination.</p>"
        },
        "durable":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the consumer is durable.</p>"
        },
        "memberDestinationName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the destination for this consumer. In case of a distributed destination, it is the name of the member destination.</p>"
        },
        "messagesPendingCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages pending (uncommitted and unacknowledged) by this consumer.</p>"
        },
        "messagesReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of messages received by this consumer since the last reset.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "selector":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The selector associated with this consumer, if any.</p>"
        },
        "subscriptionSharingPolicy":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The Subscription Sharing Policy on this subscriber.</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":""
}

トップに戻る