ジャンプ先

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

この宛先キー・コレクションの表示

get

/management/weblogic/{version}/serverConfig/resourceGroupTemplates/{name}/JMSSystemResources/{name}/JMSResource/destinationKeys

この宛先キー・コレクションを表示します。

リクエスト

パス・パラメータ

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

宛先キーのエンティティのリストを返します。

本文()

ルート・スキーマ: 項目

型: array

タイトル: Items

ソースの表示

• 配列: object 宛先キー

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Destination Key"
    },
    "description":""
}

ネストされたスキーマ: 宛先キー

型: object

ソースの表示

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

  このBeanインスタンスの一意の識別子を返します。

• keyType(optional): string
  デフォルト値: String

  使用可能な値: [ "Boolean", "Byte", "Short", "Int", "Long", "Float", "Double", "String" ]

  この宛先キーの所定のプロパティのタイプ。

  「key-type」要素を取得します。

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

  このエンティティの名前。XMLでは属性として示されます。

  JMSモジュール内の要素の多くは名前付きのエンティティです。XMLファイル内で、ある型に含まれる名前付きエンティティは、すべて一意でなければなりません。これは、JMSモジュール内で特定のエンティティを区別するための識別子です。

  この属性は、モジュールの内部で参照される可能性があるため、モジュールの外から(たとえば、デプロイメント・プランで)変更することはできません。

  制約

  • 有効なnull
• notes(optional): string

  この名前付きJMSディスクリプタBeanの説明に含めることのできるオプションの情報。

  JMSモジュールはこのノートをJMSディスクリプタ・ファイルにXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity <)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。

  ノート:

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

• property(optional): string
  デフォルト値: JMSMessageID

  メッセージのプロパティ名、またはメッセージのソートの基準となるメッセージ・ヘッダー・フィールドの名前を指定します。メッセージ・ヘッダー・フィールドのキーではキーのタイプは無視され、メッセージのプロパティではなくメッセージ・ヘッダー・フィールドを参照します。

  ノート: パフォーマンス向上のためには、メッセージのプロパティではなく、メッセージ・ヘッダー・フィールドをソート・キーとして使用します。

  値の範囲:

  ソート基準になる可能性があるJMSプロパティ名(ユーザー・プロパティを含む)またはメッセージ・ヘッダー・フィールドを次に示します。

  • JMSMessageID

  • JMSTimestamp

  • JMSCorrelationID

  • JMSPriority

  • JMSExpiration

  • JMSType

  • JMSRedelivered

  • JMSDeliveryTime

  • JMS_BEA_Size

  • JMS_BEA_UnitOfOrder

  この属性は動的に構成できません。「property」要素を取得します。

• sortOrder(optional): string
  デフォルト値: Ascending

  使用可能な値: [ "Ascending", "Descending" ]

  このキーがメッセージをソートする際のソート順(「昇順」または「降順」)。

  JMSMessageIDプロパティに対して「昇順」オプションを選択した場合、FIFO (先入れ先出し)のソート順(宛先に対するデフォルト)が暗黙的に使用されます。「降順」オプションを選択すると、ソート順はLIFO (後入れ先出し)になります。

  この属性は動的に構成できません。

  「sort-order」要素を取得します。

{
    "type":"object",
    "properties":{
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</p>"
        },
        "keyType":{
            "default":"String",
            "enum":[
                "Boolean",
                "Byte",
                "Short",
                "Int",
                "Long",
                "Float",
                "Double",
                "String"
            ],
            "type":"string",
            "description":"<p>The expected property type for this destination key. </p><p>  Gets the \"key-type\" element</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The name of this entity, represented in XML as an attribute.</p><p> Many of the elements within the JMS module are named entities.  All of the named entities encased by a type in the XML file must be unique.  This is the identifier used to delineate a particular entity within the JMS module. </p><p> This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially. </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 named JMS descriptor bean.</p><p>JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><dl><dt>Note:</dt><dd><p>If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p></dd></dl>"
        },
        "property":{
            "default":"JMSMessageID",
            "type":"string",
            "description":"<p>Specifies a message property name or the name of a message header field on which to sort messages. Message header field keys ignore the key type and reference message header fields rather than message properties. </p><p><i>Note:</i> For better performance, use message header fields as sorting keys, rather than message properties. </p><p><i>Range of Values:</i></p><p>The JMS Property name (including user properties) or message header fields that can be sorted on are:</p><ul><li><p> JMSMessageID</p></li><li><p> JMSTimestamp</p></li><li><p> JMSCorrelationID</p></li><li><p> JMSPriority</p></li><li><p> JMSExpiration</p></li><li><p> JMSType</p></li><li><p> JMSRedelivered</p></li><li><p> JMSDeliveryTime</p></li><li><p> JMS_BEA_Size</p></li><li><p> JMS_BEA_UnitOfOrder</p></li></ul><p>This attribute is not dynamically configurable. Gets the \"property\" element</p>"
        },
        "sortOrder":{
            "default":"Ascending",
            "enum":[
                "Ascending",
                "Descending"
            ],
            "type":"string",
            "description":"<p>The direction (Ascending or Descending) in which this key will sort messages. </p><p>Selecting the <i>Ascending</i> option for the JMSMessageID property implies a FIFO (first in, first out) sort order (the default for destinations). Select the <i>Descending</i> option for a LIFO (last in, first out) sort order. </p><p>This attribute is not dynamically configurable. </p><p>Gets the \"sort-order\" element.</p>"
        }
    },
    "description":""
}

先頭に戻る