リクエスト

GET /user/:user_code/request

リクエストの一覧情報を取得する

詳細

リクエスト

Body

Key	Type	Value
sacode	String	SAコードを指定して絞り込む (オプション) 複数指定不可
type	String	リクエスト種別を指定して絞り込む (オプション) 複数指定不可
status	String	リクエストの状態を指定して絞り込む (オプション) 複数指定可能 ※running パラメータが含まれた場合、下記の status を絞り込む "proxy-run": サーバ実行中 "sa-run": SA実行中 "reinitial": 別のサーバでリトライ中 "temporary-failed": 失敗 (一部サーバ間の処理が未完了) "temporary-successed": 成功 (一部サーバ間の処理が未完了)
limit	String	リクエストの取得件数 (オプション) 最大 100
offset	String	リクエストの開始位置 (オプション) 最小 0

レスポンス

レスポンス情報 を参照

サンプル

リクエスト

URL

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/?sacode=tss99990001&type=md-command&status=successed&status=failed&limit=50&offset=100

レスポンス

Header

Content-Type: application/json

Body

{
  "results": [
    {
      "id": "1:3",
         "sa": {
           "code": "tss99990001",
           "name": "Service adapter 001",
           "description": "MEMO",
           "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
           "configState": "initial",
           "up": true
         },
      "type": "md-command",
      "targetTime": "2012/06/25 16:44:23",
      "status": "failed",
      "proxyStatus": "connection-timeout",
      "resultCode": "success"
      },
      {
      "id": "1:1",
         "sa": {
           "code": "tss99990001",
           "name": "Service adapter 001",
           "description": "MEMO",
           "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678",
           "configState": "initial",
           "up": true
         },
      "type": "md-command",
      "targetTime": "2012/06/25 16:42:56",
      "status": "successed",
      "proxyStatus": "success",
      "resultCode": "success",
      "requestCommands": ["show system"]
    }
  ], ...
  "totalCount": 1000,
  "offset": 100,
  "limit": 50
}

共通パラメータ

レスポンス情報

Key	Type	Value
id	String	リクエストのID
sa	Object	サービスアダプタの情報 code String SAコード name String SAラベル description String メモ distributionId String Distribution ID up boolean 接続中かどうか configState String コンフィグ反映状態 initial コンフィグ未取得または同期無し pulled コンフィグ取得済み pushready 操作・コンフィグ有効 pushed コンフィグ操作中 pushconfirming 操作用接続確認中
type	String	リクエスト種別 configure 動作コンフィグ反映 read-storage コンフィグ参照 read-status ステータス参照 ping ping traceroute traceroute reboot 再起動 md-command 任意コマンド実行 clear-status ステータス初期化
targetTime	String	実行予定時間
status	String	リクエストの状態 initial 実行待ち proxy-run サーバ実行中 sa-run サービスアダプタ実行中 canceled キャンセル済み failed 失敗 successed 成功 reinitial 別のサーバでリトライ中 temporary-failed 失敗 (一部サーバ間の処理が未完了) temporary-successed 成功 (一部サーバ間の処理が未完了)
proxyStatus	String	プロキシの状態 success 成功 rs-side-timeout RSのタイムアウトで失敗した interrupted 割り込みで失敗した rs-precheck-error サービスアダプタがプッシュ操作可能な状態でなかった rs-proxy-error ARMSプロキシから応答がなかった ssl-error SSLが原因のエラー connection-refused Connection Refused で接続に失敗した connection-timeout ネットワーク障害による接続タイムアウト xml-parse-error 不正なメッセージ形式 no-distid Distribution-ID が存在しない no-password RS-SAキーが登録されていない no-tunnel 持続接続が存在しない server-busy サーバが過負荷に陥っている internal-error サーバ内部エラー
resultCode	String	結果コード none なし (初期状態) rs-not-pushready - rs-configure-timeout - success 成功 failed-md-command コマンド実行時のエラー invalid-xml XML としてパースできない invalid-message-type 不明なメッセージタイプ parameter-problem パラメータが不正 server-busy サーバが過負荷状態にある sa-busy サービスアダプタが過負荷状態にある server-failure サーバの内部エラー sa-failure サービスアダプタの内部エラー authentication-failure 不正な認証鍵 sa-standby サービスアダプタがスタンバイ機 no-config コンフィグが未登録 too-many-transaction トランザクションのリミット上限に達した too-many-status ステータスリクエストのリミット上限に達した invalid-storage 不正なストレージを指定した invalid-module-id 不正なモジュールID config-validation-failure 不正なコンフィグ config-commit-failure コンフィグの反映に失敗した transaction-failure トランザクションを続行できない resource-exhausted サービスアダプタのリソースが不足している sa-rollbacked サービスアダプタがロールバックした system-error システムエラー invalid-hardware サポートされないハードウェア invalid-firmware サポートされないファームウェア module-sync-needed サービスアダプタの設定と機能が一致していない no-distribution-id Distribution-ID が未登録 multiple-request 他の処理を実行している distribution-id-mismatch Distribution-ID が不一致 binary-transfer-not-supported バイナリ転送がサポートされていない out-of-service サービスを受ける権利がない push-failed プッシュ操作に失敗した need-reboot サービスアダプタの再起動が必要 address-mismatch アドレス変換を検出した not-support サービスアダプタに該当する機能がない server-moved RSが移設により利用できなかった invalid-type 不正なタイプ state-mismatch システムの状態が不一致 module-syncing モジュールバージョンの同期のため再起動
requestCommands	Array	タスクに紐づくコマンド文字列 type が以下の場合のみ値が入る（それ以外は空配列となる） read-status clear-status md-command
totalCount	int	リクエストの総件数
offset	int	リクエストの取得開始位置
limit	int	リクエストの取得件数

リクエスト別リファレンス

• Ping
  • POST /user/:user_code/request/ping
  • GET /user/:user_code/request/ping/:id
  • PUT /user/:user_code/request/ping/:id
• Traceroute
  • POST /user/:user_code/request/traceroute
  • GET /user/:user_code/request/traceroute/:id
  • PUT /user/:user_code/request/traceroute/:id
• Read Storage
  • POST /user/:user_code/request/read-storage
  • GET /user/:user_code/request/read-storage/:id
  • PUT /user/:user_code/request/read-storage/:id
  • GET /user/:user_code/request/read-storage/:id/result/module/:module_id/plain
  • GET /user/:user_code/request/read-storage/:id/result/module/:module_id/binary
• Reboot
  • POST /user/:user_code/request/reboot
  • GET /user/:user_code/request/reboot/:id
  • PUT /user/:user_code/request/reboot/:id
• Read Status
  • POST /user/:user_code/request/read-status
  • GET /user/:user_code/request/read-status/:id
  • PUT /user/:user_code/request/read-status/:id
  • GET /user/:user_code/request/read-status/:id/request/module/:module_id/plain
  • GET /user/:user_code/request/read-status/:id/request/module/:module_id/binary
  • GET /user/:user_code/request/read-status/:id/result/module/:module_id/plain
  • GET /user/:user_code/request/read-status/:id/result/module/:module_id/binary
• Clear Status
  • POST /user/:user_code/request/clear-status
  • GET /user/:user_code/request/clear-status/:id
  • PUT /user/:user_code/request/clear-status/:id
  • GET /user/:user_code/request/clear-status/:id/request/module/:module_id/plain
  • GET /user/:user_code/request/clear-status/:id/request/module/:module_id/binary
  • GET /user/:user_code/request/clear-status/:id/result/module/:module_id/plain
  • GET /user/:user_code/request/clear-status/:id/result/module/:module_id/binary
• Md Command
  • POST /user/:user_code/request/md-command
  • GET /user/:user_code/request/md-command/:id
  • PUT /user/:user_code/request/md-command/:id
  • GET /user/:user_code/request/md-command/:id/request/module/:module_id/plain
  • GET /user/:user_code/request/md-command/:id/request/module/:module_id/binary
  • GET /user/:user_code/request/md-command/:id/result/module/:module_id/plain
  • GET /user/:user_code/request/md-command/:id/result/module/:module_id/binary
• Configure
  • GET /user/:user_code/request/configure/:id
  • PUT /user/:user_code/request/configure/:id
  • GET /user/:user_code/request/configure/:id/error/sa/binary
  • GET /user/:user_code/request/configure/:id/error/module/:module_id/plain
  • GET /user/:user_code/request/configure/:id/error/module/:module_id/binary

リクエストタイプ別アクセス可能なAPI比較表

リクエストパラメータが機種のモジュールに依存しないもの

API(/user/:user_code/request/以下)	Ping	Traceroute	Read Storage	Reboot	Configure
POST :type	o	o	o	o	x
GET :type/:id	o	o	o	o	o
PUT :type/:id	o	o	o	o	o
GET :type/:id/request/module/:module_id/:format	x	x	x	x	x
GET :type/:id/result/module/:module_id/:format	x	x	o	x	x
GET :type/:id/error/module/:module_id/:format	x	x	x	x	o
GET :type/:id/error/sa/binary	x	x	x	x	o

リクエストパラメータが機種のモジュールに依存しているもの

API(/user/:user_code/request/以下)	Read Status	Clear Status	Md Command
POST :type	o	o	o
GET :type/:id	o	o	o
PUT :type/:id	o	o	o
GET :type/:id/request/module/:module_id/:format	o	o	o
GET :type/:id/result/module/:module_id/:format	o	o	o
GET :type/:id/error/module/:module_id/:format	x	x	x
GET :type/:id/error/sa/binary	x	x	x