Oracle WebLogic Server MTのRESTfulサーバー構成管理インタフェース(非推奨)

このメール・セッションの表示

get

/management/weblogic/{version}/serverConfig/resourceGroupTemplates/{name}/mailSessions/{name}

このメール・セッションを表示します。

リクエスト

パス・パラメータ

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

説明: Adminセキュリティ・ロールのユーザー。
Deployer: basic

型: basic

説明: Deployerセキュリティ・ロールのユーザー。
Monitor: basic

型: basic

説明: Monitorセキュリティ・ロールのユーザー。
Operator: basic

型: basic

説明: Operatorセキュリティ・ロールのユーザー。

先頭に戻る

レスポンス

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

application/json

200レスポンス

このメール・セッションを返します。

ルート・スキーマ: Mail Session

型: object

ソースを表示

deploymentOrder(optional): integer(int32)
最小値: 0

最大値: 2147483647

デフォルト値: 1000
デプロイの優先度。サーバーはこの値を使用して項目のデプロイ順を決定します。優先度は、同じタイプでデプロイ可能なアイテム間で決められます。
たとえば、サーバーではすべてのEJBを優先度に従ってデプロイしてから、起動クラスを優先度に従ってデプロイします。
「デプロイ順序」の値が小さい項目から順にデプロイされます。「デプロイ順序」の値が等しいデプロイメントの順序付けは保証されていません。クラスタ間の順序付けは保証されていません。
制約
- ドメイン・スコープ指定MBeanには表示されません
dynamicallyCreated(optional): boolean
読取り専用: true

デフォルト値: false
MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます
制約
- ドメイン・スコープ指定MBeanには表示されません
id(optional): integer(int64)
読取り専用: true
このMBeanインスタンスの一意のIDを返します
制約
- ドメイン・スコープ指定MBeanには表示されません
JNDIName(optional): string
このリソースに関連付けられているJNDI名。
制約
- 有効なnull
- ドメイン・スコープ指定MBeanには表示されません
name(optional): string
読取り専用: true
jmsserverjmshat on
このMBeanインスタンスのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています
Name=user-specified-name
制約
- 有効なnull
notes(optional): string

この構成の説明として任意に入力できる情報。
WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<)はXMLエンティティ<に変換されます。<キャリッジ・リターン/ライン・フィードは維持されます。
ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。


            
             properties(optional): object  Properties
            
            
                
                
タイトル: Properties













使用可能なその他のプロパティ: additionalProperties









このメール・セッションでメール・サーバーとの相互作用に使用する、構成オプションおよびユーザー認証のデータ。指定する各プロパティによって、JavaMail API Design Specificationで定義されているように、デフォルトのプロパティの値がオーバーライドされます。
JavaMail API Design Specificationで定義されているプロパティのみを含めるようにします。
何もプロパティを指定しない場合、このメール・セッションではJavaMailのデフォルトのプロパティ値が使用されます。
各プロパティは名前値のペアで表現します。複数のプロパティはセミコロン()で区切ります。
制約
ドメイン・スコープ指定MBeanには表示されません


                
            
            
            
             sessionPassword(optional): string(password)
            
                
                
























インメモリーでの一時的な使用のみを目的とした、復号化済JavaMailセッション・パスワード属性。この属性で返される値はメモリー内に長期間保持しないでください。
値は暗号化された形式でディスクリプタ・ファイルに格納され、暗号化された形式で管理コンソールに表示されます。
制約
ドメイン・スコープ指定MBeanには表示されません




                
            
            
            
             sessionUsername(optional): string
            
                
                
























 JavaMail Authenticatorインスタンスを使用して、認証されたJavaMailセッションの作成に使用するユーザー名を戻します。これが設定されていない場合、セッションは認証されていないとみなされます。 
制約
ドメイン・スコープ指定MBeanには表示されません




                
            
            
            
             tags(optional): array  Items
            
            
                
                
タイトル: Items





















この構成MBeanのすべてのタグを返します
制約
ドメイン・スコープ指定MBeanには表示されません


                
            
            
            
             targets(optional): array  Target References
            
            
                
                
タイトル: Target References





















ターゲット参照の配列が含まれます。 現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。
制約
ドメイン・スコープ指定MBeanには表示されません


                
            
            
            
             type(optional): string
            
                
                


読取り専用: true























MBeanのタイプを戻します。
制約
収集不可


        {
    "type":"object",
    "properties":{
        "JNDIName":{
            "x-weblogic-legalNull":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The JNDI Name associated with this resource.</p><p><h5>Constraints</h5></p><ul><li>legal null</li><li>not visible for domain scoped mbeans</li></ul>"
        },
        "deploymentOrder":{
            "default":1000,
            "minimum":0,
            "maximum":2147483647,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.</p><p>For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.</p><p>Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "id":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>jmsserverjmshat on </p><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>"
        },
        "properties":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"object",
            "description":"<p>The configuration options and user authentication data that this mail session uses to interact with a mail server. Each property that you specify overrides the default property value as defined by the JavaMail API Design Specification.</p><p>Include only the properties defined by the JavaMail API Design Specification.</p><p>If you do not specify any properties, this mail session will use the JavaMail default property values.</p><p>Express each property as a <code><i>name</i><i>value</i></code> pair. Separate multiple properties with a semicolon (<code></code>).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "sessionPassword":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "format":"password",
            "description":"<p>The decrypted JavaMail Session password attribute, for use only temporarily in-memory; the value returned by this attribute should not be held in memory long term.</p><p>The value is stored in an encrypted form in the descriptor file and when displayed in an administration console.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "sessionUsername":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p> Returns the username to be used to create an authenticated JavaMail Session, using a JavaMail <code>Authenticator</code> instance; if this is not set, it will be assumed that the Session is not to be authenticated. </p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "tags":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "targets":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the target reference."
            },
            "description":"Contains the array of target references. <p>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "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":""
}



                    
                    
    ネストされたスキーマ: Properties
    
      型: object
      
    

    

    
    タイトル: Properties
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    
       使用可能なその他のプロパティ

       ソースを表示
       
           
            string
           
           
               
               



























               
           
           
           
       
       {
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "type":"object",
    "description":"<p>The configuration options and user authentication data that this mail session uses to interact with a mail server. Each property that you specify overrides the default property value as defined by the JavaMail API Design Specification.</p><p>Include only the properties defined by the JavaMail API Design Specification.</p><p>If you do not specify any properties, this mail session will use the JavaMail default property values.</p><p>Express each property as a <code><i>name</i><i>value</i></code> pair. Separate multiple properties with a semicolon (<code></code>).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}
    
    

    

    

    

    
    このメール・セッションでメール・サーバーとの相互作用に使用する、構成オプションおよびユーザー認証のデータ。指定する各プロパティによって、JavaMail API Design Specificationで定義されているように、デフォルトのプロパティの値がオーバーライドされます。
JavaMail API Design Specificationで定義されているプロパティのみを含めるようにします。
何もプロパティを指定しない場合、このメール・セッションではJavaMailのデフォルトのプロパティ値が使用されます。
各プロパティは名前値のペアで表現します。複数のプロパティはセミコロン()で区切ります。
制約
ドメイン・スコープ指定MBeanには表示されません
    

    

    

    

    

    

    

    

    

    




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

    

    
    タイトル: Items
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    この構成MBeanのすべてのタグを返します
制約
ドメイン・スコープ指定MBeanには表示されません
    

    

    

    

    
        ソースを表示
        
            
             配列: string
            
            
                
                





























                
            
            
            
        
        {
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}
    

    

    

    

    

    




                    
                    
    ネストされたスキーマ: Target References
    
      
      型: array
    

    

    
    タイトル: Target References
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    ターゲット参照の配列が含まれます。 現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。
制約
ドメイン・スコープ指定MBeanには表示されません
    

    

    

    

    
        ソースを表示
        
            
             配列: object  Target Reference
            
            
                
                
タイトル: Target Reference





















ターゲット参照が含まれます。


                
            
            
            
        
        {
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the target reference."
    },
    "description":"Contains the array of target references. <p>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}
    

    

    

    

    

    




                    
                    
    ネストされたスキーマ: Target Reference
    
      型: object
      
    

    

    
    タイトル: Target Reference
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    ターゲット参照が含まれます。
    

    

    

    
        ソースを表示
        
            
             identity(optional): array  Identity
            
            
                
                
タイトル: Identity





















DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。


                
            
            
            
        
        {
    "title":"Target Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the target reference."
}
    

    

    

    

    

    

    




                    
                    
    ネストされたスキーマ: Identity
    
      
      型: array
    

    

    
    タイトル: Identity
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。
    

    

    

    

    
        ソースを表示
        
            
             配列: string
            
            
                
                





























                
            
            
            
        
        {
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}


                

				先頭に戻る