移動先

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

セッションのリスト

get

/essbase/rest/v1/sessions

ユーザーまたはリクエストの現在アクティブなセッションのリストを返します。

リクエスト

問合せパラメータ

• application: string

  アプリケーション名。

• database: string

  データベース名。

• userId: string

  アクティブなセッションを返すユーザーのID。指定しない場合は、すべてのセッションが取得されます。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

セッションの詳細が正常に返されました。

本体()

ルート・スキーマ : SessionAttributes

型: object

ソースの表示

• application: string

  アクティブなアプリケーションの名前

• connectionSource: string

  接続済サービスのホスト名

• database: string

  アクティブなデータベースの名前

• dbConnectTimeInSeconds: string

  データベースがアクティブに設定されてからの秒数

• loginTimeInSeconds: string

  セッションが開始してからの秒数

• request: string

  進行中のアクティブ・リクエストのタイプ(計算、データ・ロードまたは再構築などがあります)。この情報は、長いセッション中に何が発生しているかについての詳細を把握するのに役立ちます。

• requestState: string

  アクティブ・リクエストの状態

• requestTimeInSeconds: string

  アクティブなリクエストが実行されていた秒数。

• sessionId: string

  数値のセッションID。

• userId: string

  ログイン・ユーザー名

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "description":"<p>Logged in user name.</p>"
        },
        "sessionId":{
            "type":"string",
            "description":"<p>Numeric session ID.</p>"
        },
        "loginTimeInSeconds":{
            "type":"string",
            "description":"<p>Number of seconds ago the session began.</p>"
        },
        "application":{
            "type":"string",
            "description":"<p>Name of active application.</p>"
        },
        "database":{
            "type":"string",
            "description":"<p>Name of active database.</p>"
        },
        "dbConnectTimeInSeconds":{
            "type":"string",
            "description":"<p>Number of seconds ago the database was set active.</p>"
        },
        "request":{
            "type":"string",
            "description":"<p>Type of active request in progress; for example, calculation, data load, or restructure. This information can help you get details about what is occurring during lengthy sessions.</p>"
        },
        "requestTimeInSeconds":{
            "type":"string",
            "description":"<p>Number of seconds the active request has been running.</p>"
        },
        "connectionSource":{
            "type":"string",
            "description":"<p>Host name of the connected service.</p>"
        },
        "requestState":{
            "type":"string",
            "description":"<p>The status of the active request.</p>"
        }
    }
}

400 レスポンス

不正なリクエスト

Essbaseまたはプラットフォームのセキュリティ例外です。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、Essbaseサーバー上のすべてのアクティブなユーザー・セッションをリストする方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/sessions?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

レスポンス本体の例

[ {
  "userId" : "admin",
  "sessionId" : "2790260182",
  "loginTimeInSeconds" : "200",
  "connectionSource" : "https://myserver.example.com"
}, {
  "userId" : "user1",
  "sessionId" : "4178574804",
  "loginTimeInSeconds" : "72",
  "connectionSource" : "https://myserver.example.com"
}, {
  "userId" : "power1",
  "sessionId" : "3468688851",
  "loginTimeInSeconds" : "4",
  "connectionSource" : "https://myserver.example.com"
} ]

先頭に戻る