| 機能名 | 説明 |
|---|---|
| context/list | コンテキスト一覧を取得します |
| server/list | サーバー一覧を取得します |
| server/delete | サーバーを削除します |
| context/delete | コンテキストを削除します |
| statistics/image/download | フローの統計グラフをダウンロードします |
コンテキスト一覧を取得します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| GET | http://{Hostname}:{Port}/mcapi/flow/context/list |
GET /mcapi/flow/context/list HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとコンテキスト一覧が返ります。
コンテキストの情報として、次の情報が取得できます。
{
"result": {
"status": "success",
"data": {
"context": [
{
"path": "/FlowService",
"user": "",
"basicAuthentication": true,
"documentRoot": "system/htdocs",
"welcomePage": "",
"listing": false,
"includes": "**/*.html",
"excludes": "",
"maxBodySize": 1048576,
"deletable": false
},
{
"path": "/abc",
"user": "/test",
"basicAuthentication": false,
"documentRoot": "/htdocs",
"welcomePage": "",
"listing": false,
"includes": "dir1/.",
"excludes": "",
"maxBodySize": 1048576,
"deletable": true
}
]
}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 500 Internal Server Error | 5101 | 内部の通信に失敗した場合 |
| 5102 | サーバー内部にエラーが発生した場合 |
サーバー一覧を取得します。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| GET | http://{Hostname}:{Port}/mcapi/flow/server/list |
GET /mcapi/flow/server/list HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとサーバー一覧が返ります。
サーバーの情報として、次の情報が取得できます。
{
"result": {
"status": "success",
"data": {
"server": [
{
"id": "fa81528b-bab0-49a5-9a07-a63783e1c9e5",
"name": "server1",
"version": "1.0.0",
"status": "normal",
"recoveryServerId": "",
"recoveryServerName": "",
"startTime": "",
"endTime": "",
"isSelf": true
},
{
"id": "4a9812c3-9efd-4816-89eb-bfa98c7e80f1",
"name": "server2",
"version": "1.0.0",
"status": "normal",
"recoveryServerId": "fa81528b-bab0-49a5-9a07-a63783e1c9e5",
"recoveryServerName": "server1",
"startTime": "2013-01-01 17:14:45",
"endTime": "2013-01-01 17:14:45",
"isSelf": false
}
]
}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 500 Internal Server Error | 5101 | 内部の通信に失敗した場合 |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5106 | フローサービスが起動していなかった場合 |
サーバーを削除します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/flow/server/delete |
| パラメーター | 必須 | 説明 |
|---|---|---|
| id | はい | 削除するサーバーのIDを指定します。 |
| purge | いいえ | 「true」を指定した場合、サーバーを完全に削除します。 「false」または未設定の場合、サーバーを論理削除します。 |
POST /mcapi/flow/server/delete HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 51 id=4a9812c3-9efd-4816-89eb-bfa98c7e80f1&purge=false
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとサーバー一覧が返ります。
{
"result": {
"status": "success",
"data": {
"server": [
{
"id": "fa81528b-bab0-49a5-9a07-a63783e1c9e5",
"name": "server1",
"version": "1.0.0",
"status": "normal",
"recoveryServerId": "",
"recoveryServerName": "",
"startTime": "",
"endTime": "",
"isSelf": true
},
{
"id": "4a9812c3-9efd-4816-89eb-bfa98c7e80f1",
"name": "server2",
"version": "1.0.0",
"status": "delete",
"recoveryServerId": "fa81528b-bab0-49a5-9a07-a63783e1c9e5",
"recoveryServerName": "server1",
"startTime": "2013-01-01 17:14:45",
"endTime": "2013-01-01 17:14:45",
"isSelf": false
}
]
}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2002 | パラメーター id の値が設定されていなかった場合 |
| 2410 | ログインサーバーを削除しようとした場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 404 Not Found | 4014 | 指定したサーバーが存在しなかった場合 |
| 500 Internal Server Error | 5101 | 内部の通信に失敗した場合 |
| 5102 | サーバー内部にエラーが発生した場合 | |
| 5106 | フローサービスが起動していなかった場合 |
コンテキストを削除します。
administrator
| HTTPメソッド | リクエストURL |
|---|---|
| POST | http://{Hostname}:{Port}/mcapi/flow/context/delete |
| パラメーター | 必須 | 説明 |
|---|---|---|
| path | はい | コンテキストパスを指定します。 |
POST /mcapi/flow/context/delete HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 10 path=/test
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとコンテキストを削除します。
{
"result": {
"status": "success",
"data": {}
}
}
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2002 | パラメーター path の値が設定されていなかった場合 |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 404 Not Found | 4013 | パラメーター path で指定したコンテキストの情報が存在しなかった場合 |
| 500 Internal Server Error | 5101 | 内部の通信に失敗した場合 |
| 5102 | サーバー内部にエラーが発生した場合 |
フローの統計グラフをダウンロードします。パラメーター Type で指定した統計情報を１つの画像ファイル（PNGファイル）に作成し、ダウンロードします。
administrator、developer、operator
| HTTPメソッド | リクエストURL |
|---|---|
| GET | http://{Hostname}:{Port}/mcapi/flow/statistics/image/download |
| パラメーター | 必須 | 説明 |
|---|---|---|
| type | いいえ | 統計グラフのタイプを指定します。
|
| worker | いいえ | 取得するワーカーのワーカー名を指定します。
|
| endTime | いいえ | 統計グラフの日時（yyyy-MM-dd HH:mm:ss）を指定します。 指定しなかった場合現在のシステム時刻となります。 |
| range | いいえ | 統計グラフの範囲を指定します。
|
| interval | いいえ | 統計グラフの処理間隔を指定します。
|
| locale | いいえ | 統計グラフの言語を指定します。 指定しなかった場合はHTTPリクエストで指定されたロケールを使用、それもなかった場合はサーバーのデフォルトロケールを使用します。 |
GET /mcapi/flow/statistics/image/download?worker=highPriority&endTime=2013-01-01%2013:13:01&type=memory,queue,worker&range=3%20months&interval=10%20minutes HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200が返ります。
実行に成功するとバックアップファイルのzipが返ります。
HTTP/1.1 200 OK Content-Type: image/png Content-Length: 31246 Content-Disposition: filename="graph-memory_queue_worker-20130101-131301.png" [レスポンスのボディとしてpngファイルがバイナリ形式で付加されます]
下記以外のエラーについては、共通エラーコードを参照してください。
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 400 Bad Request | 2001 | パラメーター type, worker, range, interval の値が正しくなかった場合 |
| 2305 | 時刻 endTime の解析にエラーが発生した場合 | |
| 403 Forbidden | 3001 | ログインしていなかった場合 |
| 500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
| 5002 | ファイルの書き込みでエラーが発生した場合 | |
| 5003 | ファイルの解析でエラーが発生した場合 | |
| 5101 | 内部の通信に失敗した場合 | |
| 5102 | サーバー内部にエラーが発生した場合 |