Request

GET /user/:user_code/request

Read request information

Detail

Request

Body

Key	Type	Value
sacode	String	Narrow by specifying an SA code (option) multiple not permitted
status	String	Narrow by specifying a request status (option) multiple permitted

Response

See “ Request information “

Sample

Request

URL

GET https://*.sacm.jp/public-api/v1/user/tsa99990001/?sacode=tss99990001&status=successed&status=failed

Response

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"
    }
  ]
}

Shared parameters

Request information

Key	Type	Value
id	String	Request ID
sa	Object	Service adaptor information code String SA code name String SA label description String Memo distributionId String Distribution ID up boolean Whether connected or not configState String Config status initial Config unpulled or not synced pulled Config pulled pushready RS control confirmed pushed Config being operated pushconfirming RS control being confirmed
mota	String	Request type configure Reflect Running config read-storage Reference config read-status Show status ping ping traceroute traceroute reboot Reboot md-command Execute Md command clear-status Clear status
targetTime	String	Execution schedule time
status	String	Request status initial Initial proxy-run Server running sa-run Service adaptor executing canceled Canceled failed Failed successed Succeeded reinitial Retrying on different server temporary-failed Failed (process not done between some servers) temporary-successed Succeeded (process not done between some servers)
proxyStatus	String	Proxy status success Succeeded rs-side-timeout Failed due to RS timeout interrupted Interrupt failed rs-precheck-error Service adaptor status did not allow Push rs-proxy-error No response from ARMS proxy ssl-error Error caused by SSL connection-refused Connection failed due to Connection Refused connection-timeout Connection timeout due to network trouble xml-parse-error Invalid message format no-distid Distribution-ID does not exist no-password RS-SA key not registered no-tunnel Tunnel connection does not exist server-busy Server overloaded internal-error Server internal error
resultCode	String	Result code none N/A (default status) rs-not-pushready - rs-configure-timeout - success Succeeded failed-md-command Md command failed invalid-xml Invalid XML invalid-message-type Invalid message type parameter-problem Invalid parameter server-busy Server busy sa-busy Service adaptor busy server-failure Server failure sa-failure Service adaptor failure authentication-failure Authentication failure sa-standby Service adaptor is standby unit no-config Config not set too-many-transaction Transaction limit reached too-many-status Status request limit reached invalid-storage Invalid storage specified invalid-module-id Invalid module ID config-validation-failure Invalid config config-commit-failure Failed to reflect config transaction-failure Transaction failure resource-exhausted Service adaptor resources insufficient sa-rollbacked Service adaptor rolled back system-error System error invalid-hardware Unsupported hardware invalid-firmware Unsupported firmware module-sync-needed Service adaptor settings and functions do not match no-distribution-id Distribution-ID unregistered multiple-request Other requests being processed distribution-id-mismatch Distribution-ID mismatch binary-transfer-not-supported Not supported binary transfer out-of-service Out of service push-failed Push operation failed need-reboot Service adaptor reboot required address-mismatch Detected address translation not-support Service adaptor function not supported server-moved RS is unavailable invalid-type Invalid type state-mismatch Mismatched state module-syncing Reboot due to module sync

Request-based reference

• 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

Accessible API comparison chart based on request type

Request parameters that do not depend on the equipment module

API(under /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

Request parameters that depend on the equipment module

API(under /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