hpc-v1.md

5/17/2023

HPC REST API v1.0.0
Scroll down for example requests and responses.

Limitations
Maximum number of concurrent connections is 10 per system. When number of concurrent
connections exceeds the limit, API responds with status 500 (InternalServerError).
Base URLs:
https://jp-east-1.hpc-api.api.nifcloud.com

Authentication
API Key (SigV4)
Parameter Name: Authorization, in: header.

jobs
jobs_get
GET /jobs
Get Job List

Get Job List
This API allows an user to get a list of jobs is still running.
This API is available for authenticated users.

Parameters
Name

In

Type

Required

Description

X-Amz-Dateheaderstringtrue

YYYYMMDD'T'HHMMSS'Z' (ISO 8601).

Example responses
200 Response[{"job_id": "6291500","job_name": "job1.sh",1 / 30hpc-v1.md

5/17/2023"status": "RNA","user": "a03010","group": "rccs-aot","start_date": "2021-04-12T11:25:00","elapse_time": "0000:00:00","node_require": "12","priority": "127","accept": "2021-04-12T11:25:50","queue": "small","Fugaku:elapse_limit": "0000:01:00","Fugaku:md": "NM","Fugaku:vnode": "-",
"Fugaku:core": "-",
"Fugaku:v_mem": "-",
"Fugaku:v_pol": "-",
"Fugaku:e_pol": "-",
"Fugaku:rank": "bychip","Fugaku:lst": "QUE","Fugaku:ec": "0","Fugaku:pc": "0","Fugaku:sn": "0","Fugaku:reason": "-"},{"job_id": "6291501","job_name": "job1.sh","status": "RNA","user": "a03010","group": "rccs-aot","start_date": "2021-04-12T11:25:00","elapse_time": "0000:00:00","node_require": "12","priority": "127","accept": "2021-04-12T11:25:51","queue": "small","Fugaku:elapse_limit": "0000:01:00","Fugaku:md": "NM","Fugaku:vnode": "-",
"Fugaku:core": "-",
"Fugaku:v_mem": "-",
"Fugaku:v_pol": "-",
"Fugaku:e_pol": "-",
"Fugaku:rank": "bychip","Fugaku:lst": "QUE","Fugaku:ec": "0","Fugaku:pc": "0","Fugaku:sn": "0","Fugaku:reason": "-"}]400 Response
2 / 30hpc-v1.md

5/17/2023{"code": "GeneralError","message": "Operation failed."}

Unauthorized{"code": "Client.AuthFailurePermission","message": "Authentication API abended."}{"code": "Client.AuthFailureRequired.AccessKey","message": "No access key was provided."}{"code": "Client.AuthFailureRequired.Signature","message": "No signature was provided."}{"code": "Client.AuthFailureExpired","message": "The signature for this request is expired."}403 Response{"code": "Client.AuthFailurePermission.MultiAccount","message": "You don't have enough rights to operate this API."}404 Response{"code": "Client.URLNotFound",3 / 30hpc-v1.md

5/17/2023"message": "A specified URL is not found."}

405 Response{"code": "Client.InvalidParameterNotAllowed.Method","message": "A specified HTTP method is not allowed."}

500 Response{"code": "Server.InternalServerError","message": "An internal error has occurred. Please try your query again
at a later time."}

Service Unavailable{"code": "Server.ServiceUnavailable","message": "This service is temporarily unavailable. Please try again
later."}{"code": "Server.Maintenance","message": "The system is in maintenance now."}

Responses
StatusMeaning

Description

Schema200

OK

Successful Response

Inline400

Bad Request

General Error

CommonErrorFormat

401

Unauthorized

UnauthorizedCommonErrorFormat

403

Forbidden

Forbidden

CommonErrorFormat

404

Not Found

Not Found

CommonErrorFormat
4 / 30hpc-v1.md

5/17/2023

StatusMeaning

Description

Schema405

Method Not Allowed

Method Not Allowed

CommonErrorFormat

500

Internal Server Error

Internal Server Error

CommonErrorFormat

503

Service Unavailable

Service Unavailable

CommonErrorFormat

Response Schema
Status Code 200
Name

Type

Required

Restrictions

Description

anonymous[jobs_get_200_response_inner]

false

none

none

» job_idstring

true

none

none

» job_namestring

true

none

none

» status

string

true

none

none

» userstring

true

none

none

» groupstring

true

none

none

» start_date

string

true

none

none

» elapse_time

string

false

none

none

» node_require

string

true

none

none

» priority

string

true

none

none

» accept

string

true

none

none

» queuestring

true

none

none

» Fugaku:elapse_limit

string

true

none

none

» Fugaku:md

string

true

none

none

» Fugaku:vnode

string

true

none

none

» Fugaku:core

string

true

none

none

» Fugaku:v_mem

string

true

none

none

» Fugaku:v_pol

string

true

none

none

» Fugaku:e_pol

string

true

none

none

» Fugaku:rank

string

true

none

none

» Fugaku:lst

string

true

none

none

» Fugaku:ec

string

true

none

none

» Fugaku:pc

string

true

none

none

5 / 30hpc-v1.md

5/17/2023

Name

Type

Required

Restrictions

Description» Fugaku:sn

string

true

none

none

» Fugaku:reason

string

true

none

none

To perform this operation, you must be authenticated by means of one of the following methods: SigV4

jobs_post
POST /jobs
Submit a Job

Submit a Job
This API allows an user to submit a job. Post body consists as following:{"jobfile": "scripts/job1.sh","qopt": "-v"}Job script file is given by jobfile. qopt is reserved for future extension.
On Successful job commitment, job resource is returend with Location header.
This API is available for authenticated users.
Body parameter{"jobfile": "string","qopt": "string"}Parameters
Name

In

Type

Required

Description

X-Amz-Dateheaderstringtrue

YYYYMMDD'T'HHMMSS'Z' (ISO 8601).

Content-Type

headerstringtrue

application/json;charset=utf-8

body

body

jobs_post_request

true

none

Enumerated Values

6 / 30hpc-v1.md

5/17/2023

Parameter

Value

Content-Typeapplication/json;charset=utf-8

Example responses
201 Response{"job_id": 6291500}

General Error{"code": "GeneralError","message": "Operation failed."}{"code": "GeneralError","message": "Invalid Content-Type."}{"code": "GeneralError","message": "Invalid Request Body."}

Unauthorized{"code": "Client.AuthFailurePermission","message": "Authentication API abended."}{"code": "Client.AuthFailureRequired.AccessKey","message": "No access key was provided."}

7 / 30hpc-v1.md

5/17/2023{"code": "Client.AuthFailureRequired.Signature","message": "No signature was provided."}{"code": "Client.AuthFailureExpired","message": "The signature for this request is expired."}403 Response{"code": "Client.AuthFailurePermission.MultiAccount","message": "You don't have enough rights to operate this API."}404 Response{"code": "Client.URLNotFound","message": "A specified URL is not found."}

405 Response{"code": "Client.InvalidParameterNotAllowed.Method","message": "A specified HTTP method is not allowed."}

422 Response{"detail": [{"loc": ["string"],"msg": "string","type": "string"}8 / 30hpc-v1.md

5/17/2023]}

500 Response{"code": "Server.InternalServerError","message": "An internal error has occurred. Please try your query again
at a later time."}

Service Unavailable{"code": "Server.ServiceUnavailable","message": "This service is temporarily unavailable. Please try again
later."}{"code": "Server.Maintenance","message": "The system is in maintenance now."}

Responses
StatusMeaning

Description

Schema201

CreatedSuccessful Response

jobs_post_201_response

400

Bad Request

General Error

CommonErrorFormat

401

Unauthorized

UnauthorizedCommonErrorFormat

403

Forbidden

Forbidden

CommonErrorFormat

404

Not Found

Not Found

CommonErrorFormat

405

Method Not Allowed

Method Not Allowed

CommonErrorFormat

422

Unprocessable Entity

Validation Error

HTTPValidationError

500

Internal Server Error

Internal Server Error

CommonErrorFormat

503

Service Unavailable

Service Unavailable

CommonErrorFormat

Response Headers
9 / 30hpc-v1.md

5/17/2023

StatusHeaderType

201

LocationstringFormatDescription
On Successful job commitment, job resource is returend with
Location header.

To perform this operation, you must be authenticated by means of one of the following methods: SigV4

jobs_jobid_delete
DELETE /jobs/{jobid}
Cancel a Job

Cancel a Job
This API allows an user to cancel a running job.
This API is available for authenticated users.

Parameters
Name

In

Type

Required

Description

X-Amz-Dateheaderstringtrue

YYYYMMDD'T'HHMMSS'Z' (ISO 8601).

jobid

path

integertrue

job_id.

Example responses
400 Response{"code": "GeneralError","message": "Operation Failed."}

Unauthorized{"code": "Client.AuthFailurePermission","message": "Authentication API abended."}{"code": "Client.AuthFailureRequired.AccessKey","message": "No access key was provided."}
10 / 30

hpc-v1.md

5/17/2023{"code": "Client.AuthFailureRequired.Signature","message": "No signature was provided."}{"code": "Client.AuthFailureExpired","message": "The signature for this request is expired."}403 Response{"code": "Client.AuthFailurePermission.MultiAccount","message": "You don't have enough rights to operate this API."}

Not Found{"code": "Client.URLNotFound","message": "A specified URL is not found."}{"code": "GeneralError","message": "Operation not permitted."}

405 Response{"code": "Client.InvalidParameterNotAllowed.Method","message": "A specified HTTP method is not allowed."}

500 Response

11 / 30

hpc-v1.md

5/17/2023{"code": "Server.InternalServerError","message": "An internal error has occurred. Please try your query again
at a later time."}

Service Unavailable{"code": "Server.ServiceUnavailable","message": "This service is temporarily unavailable. Please try again
later."}{"code": "Server.Maintenance","message": "The system is in maintenance now."}

Responses
StatusMeaning

Description

Schema204

No Content

Successful Response

None

400

Bad Request

General Error

CommonErrorFormat

401

Unauthorized

UnauthorizedCommonErrorFormat

403

Forbidden

Forbidden

CommonErrorFormat

404

Not Found

Not Found

CommonErrorFormat

405

Method Not Allowed

Method Not Allowed

CommonErrorFormat

500

Internal Server Error

Internal Server Error

CommonErrorFormat

503

Service Unavailable

Service Unavailable

CommonErrorFormat

To perform this operation, you must be authenticated by means of one of the following methods: SigV4

jobs_jobid_get
GET /jobs/{jobid}
Get Job Detail

Get Job Detail
12 / 30

hpc-v1.md

5/17/2023

This API allows an user to view a running job's detail.
This API is available for authenticated users.

Parameters
Name

In

Type

Required

Description

X-Amz-Dateheaderstringtrue

YYYYMMDD'T'HHMMSS'Z' (ISO 8601).

jobid

path

integertrue

job_id.

Example responses
200 Response{"Fugaku:sn": "0","Fugaku:vnode": "-",
"Fugaku:ec": "0","Fugaku:reason": "-",
"Fugaku:v_mem": "-",
"priority": "127","accept": "2021-04-12T11:25:50","Fugaku:rank": "bychip","Fugaku:core": "-",
"Fugaku:v_pol": "-",
"Fugaku:lst": "QUE","Fugaku:e_pol": "-",
"job_name": "job1.sh","job_id": "6291500","elapse_time": "0000:00:00","node_require": "12","Fugaku:pc": "0","user": "a03010","queue": "small","status": "RNA","group": "rccs-aot","start_date": "2021-04-12T11:25:00","Fugaku:elapse_limit": "0000:01:00","Fugaku:md": "NM"}400 Response{"code": "GeneralError","message": "Operation Failed."}

13 / 30

hpc-v1.md

5/17/2023

Unauthorized{"code": "Client.AuthFailurePermission","message": "Authentication API abended."}{"code": "Client.AuthFailureRequired.AccessKey","message": "No access key was provided."}{"code": "Client.AuthFailureRequired.Signature","message": "No signature was provided."}{"code": "Client.AuthFailureExpired","message": "The signature for this request is expired."}403 Response{"code": "Client.AuthFailurePermission.MultiAccount","message": "You don't have enough rights to operate this API."}

Not Found{"code": "Client.URLNotFound","message": "A specified URL is not found."}{"code": "GeneralError",

14 / 30

hpc-v1.md

5/17/2023"message": "Operation not permitted."}

405 Response{"code": "Client.InvalidParameterNotAllowed.Method","message": "A specified HTTP method is not allowed."}

500 Response{"code": "Server.InternalServerError","message": "An internal error has occurred. Please try your query again
at a later time."}

Service Unavailable{"code": "Server.ServiceUnavailable","message": "This service is temporarily unavailable. Please try again
later."}{"code": "Server.Maintenance","message": "The system is in maintenance now."}

Responses
StatusMeaning

Description

Schema200

OK

Successful Response

jobs_jobid_get_200_response

400

Bad Request

General Error

CommonErrorFormat

401

Unauthorized

UnauthorizedCommonErrorFormat

403

Forbidden

Forbidden

CommonErrorFormat

404

Not Found

Not Found

CommonErrorFormat
15 / 30

hpc-v1.md

5/17/2023

StatusMeaning

Description

Schema405

Method Not Allowed

Method Not Allowed

CommonErrorFormat

500

Internal Server Error

Internal Server Error

CommonErrorFormat

503

Service Unavailable

Service Unavailable

CommonErrorFormat

To perform this operation, you must be authenticated by means of one of the following methods: SigV4

sync files
files_sync_post
POST /files/sync
Start to sync files

Start to sync Files
This API allows an user to sync files. Post body consists as following:{"path": "path/to/directory","direction": "from_online","delete": false}

Directory path to synchronized on API Server is given by path.
Direction of sync between API Sever Storage and Online Object Storage is given by direction (default isfrom_online). Bucket Name on Online Object Storage is predefined fixed value.
to_online: API Server Storage is source, and Online Object Storage is destination.
from_online: Online Object Storage is source, and API Server Storage is destination.
If true is given by delete (default is false), files that exist in the destination but not in the source aredeleted during sync.
This API is available for authenticated users.
Body parameter{"path": "string","direction": "to_online","delete": false}
16 / 30

hpc-v1.md

5/17/2023

Parameters
Name

In

Type

Required

X-Amz-Dateheaderstringtrue

headerstringtrue

application/json;charset=utf-8

bodyfiles_sync_post_request

true

none

ContentTypebody

Enumerated Values
Parameter

Value

Content-Typeapplication/json;charset=utf-8

Example responses
200 Response{"requestid": 123456}

General Error{"code": "GeneralError","message": "Operation failed."}{"code": "GeneralError","message": "Invalid Content-Type."}{"code": "GeneralError","message": "Invalid Request Body."}

Unauthorized
17 / 30

Description
YYYYMMDD'T'HHMMSS'Z' (ISO8601).

hpc-v1.md

5/17/2023{"code": "Client.AuthFailurePermission","message": "Authentication API abended."}{"code": "Client.AuthFailureRequired.AccessKey","message": "No access key was provided."}{"code": "Client.AuthFailureRequired.Signature","message": "No signature was provided."}{"code": "Client.AuthFailureExpired","message": "The signature for this request is expired."}403 Response{"code": "Client.AuthFailurePermission.MultiAccount","message": "You don't have enough rights to operate this API."}404 Response{"code": "Client.URLNotFound","message": "A specified URL is not found."}

405 Response{"code": "Client.InvalidParameterNotAllowed.Method",

18 / 30

hpc-v1.md

5/17/2023"message": "A specified HTTP method is not allowed."}

422 Response{"detail": [{"loc": ["string"],"msg": "string","type": "string"}]}

500 Response{"code": "Server.InternalServerError","message": "An internal error has occurred. Please try your query again
at a later time."}

Service Unavailable{"code": "Server.ServiceUnavailable","message": "This service is temporarily unavailable. Please try again
later."}{"code": "Server.Maintenance","message": "The system is in maintenance now."}

Responses
StatusMeaning

Description

Schema200

OK

Successful Response

files_sync_post_200_response

19 / 30

hpc-v1.md

5/17/2023

StatusMeaning

Description

Schema400

Bad Request

General Error

CommonErrorFormat

401

Unauthorized

UnauthorizedCommonErrorFormat

403

Forbidden

Forbidden

CommonErrorFormat

404

Not Found

Not Found

CommonErrorFormat

405

Method Not Allowed

Method Not Allowed

CommonErrorFormat

422

Unprocessable Entity

Validation Error

HTTPValidationError

500

Internal Server Error

Internal Server Error

CommonErrorFormat

503

Service Unavailable

Service Unavailable

CommonErrorFormat

To perform this operation, you must be authenticated by means of one of the following methods: SigV4

files_sync_requestid_get
GET /files/sync/{requestid}
Get Synchronization Status

Get Synchronization Status
This API allows an user to view a status of synchronization. Example of response as following:{"status": "complete","result": "0"}

Sync Status is set in status. If error, message is added after error:
waitingcomplete
error: parameter error
error: non such ID
Status code is set in result only if status is complete. If sync is successful, 0 is returned. If sync isfailed, non-zero value is returned.
This API is available for authenticated users.

Parameters
Name

In

Type

Required

Description

X-Amz-Dateheaderstringtrue

YYYYMMDD'T'HHMMSS'Z' (ISO 8601).
20 / 30

hpc-v1.md

5/17/2023

Name

In

Type

Required

Description

requestid

path

integertruerequest_id.

Example responses
200 Response{"result": "0","status": "complete"}

400 Response{"code": "GeneralError","message": "Operation Failed."}

Unauthorized{"code": "Client.AuthFailurePermission","message": "Authentication API abended."}{"code": "Client.AuthFailureRequired.AccessKey","message": "No access key was provided."}{"code": "Client.AuthFailureRequired.Signature","message": "No signature was provided."}{"code": "Client.AuthFailureExpired","message": "The signature for this request is expired."}
21 / 30

hpc-v1.md

5/17/2023

403 Response{"code": "Client.AuthFailurePermission.MultiAccount","message": "You don't have enough rights to operate this API."}

Not Found{"code": "Client.URLNotFound","message": "A specified URL is not found."}{"code": "GeneralError","message": "Operation not permitted."}

405 Response{"code": "Client.InvalidParameterNotAllowed.Method","message": "A specified HTTP method is not allowed."}

500 Response{"code": "Server.InternalServerError","message": "An internal error has occurred. Please try your query again
at a later time."}

Service Unavailable{"code": "Server.ServiceUnavailable","message": "This service is temporarily unavailable. Please try again

22 / 30

hpc-v1.md

5/17/2023

later."}{"code": "Server.Maintenance","message": "The system is in maintenance now."}

Responses
StatusMeaning

Description

Schema200

OK

Successful Response

files_sync_requestid_get_200_response

400

Bad Request

General Error

CommonErrorFormat

401

Unauthorized

UnauthorizedCommonErrorFormat

403

Forbidden

Forbidden

CommonErrorFormat

404

Not Found

Not Found

CommonErrorFormat

405

Method Not Allowed

Method Not Allowed

CommonErrorFormat

500

Internal Server Error

Internal Server Error

CommonErrorFormat

503

Service Unavailable

Service Unavailable

CommonErrorFormat

To perform this operation, you must be authenticated by means of one of the following methods: SigV4

SchemasCommonErrorFormat{"code": "string","message": "string"}

CommonErrorFormat

Properties
Name

Type

Required

Restrictions

Description

code

string

false

none

none

messagestring

false

none

none
23 / 30

hpc-v1.md

5/17/2023

HTTPValidationError{"detail": [{"loc": ["string"],"msg": "string","type": "string"}]}

HTTPValidationError

Properties
Name

Type

Required

Restrictions

Description

detail[ValidationError]

false

none

none

ValidationError{"loc": ["string"],"msg": "string","type": "string"}

ValidationError

Properties
Name

Type

Required

Restrictions

Description

loc[string]

true

none

none

msg

string

true

none

none

type

string

true

none

none

jobs_get_200_response_inner
24 / 30

hpc-v1.md

5/17/2023{"Fugaku:sn": "Fugaku:sn","Fugaku:vnode": "Fugaku:vnode","Fugaku:ec": "Fugaku:ec","Fugaku:reason": "Fugaku:reason","node_require": "node_require","Fugaku:v_mem": "Fugaku:v_mem","priority": "priority","accept": "accept","Fugaku:rank": "Fugaku:rank","Fugaku:core": "Fugaku:core","Fugaku:v_pol": "Fugaku:v_pol","Fugaku:lst": "Fugaku:lst","Fugaku:e_pol": "Fugaku:e_pol","job_name": "job_name","job_id": "job_id","elapse_time": "elapse_time","Fugaku:pc": "Fugaku:pc","user": "user","queue": "queue","status": "status","group": "group","start_date": "start_date","Fugaku:elapse_limit": "Fugaku:elapse_limit","Fugaku:md": "Fugaku:md"}

Properties
Name

Type

Required

Restrictions

Description

job_idstring

true

none

none

job_name

string

true

none

none

statusstring

true

none

none

user

string

true

none

none

group

string

true

none

none

start_date

string

true

none

none

elapse_time

string

false

none

none

node_require

string

true

none

none

priority

string

true

none

none

acceptstring

true

none

none

queue

string

true

none

none

25 / 30

hpc-v1.md

5/17/2023

Name

Type

Required

Restrictions

Description

Fugaku:elapse_limit

string

true

none

none

Fugaku:md

string

true

none

none

Fugaku:vnode

string

true

none

none

Fugaku:core

string

true

none

none

Fugaku:v_mem

string

true

none

none

Fugaku:v_pol

string

true

none

none

Fugaku:e_pol

string

true

none

none

Fugaku:rank

string

true

none

none

Fugaku:lst

string

true

none

none

Fugaku:ec

string

true

none

none

Fugaku:pc

string

true

none

none

Fugaku:sn

string

true

none

none

Fugaku:reason

string

true

none

none

jobs_post_request{"jobfile": "string","qopt": "string"}

Properties
Name

Type

Required

Restrictions

Description

jobfilestringtrue

none

Job script file is given by jobfile.

qopt

string

false

none

qopt is reserved for future extension.

jobs_post_201_response{"job_id": 0}

26 / 30

hpc-v1.md

5/17/2023

Properties
Name

Type

Required

Restrictions

Description

job_idinteger

true

none

job idjobs_jobid_get_200_response{"Fugaku:sn": "Fugaku:sn","Fugaku:vnode": "Fugaku:vnode","Fugaku:ec": "Fugaku:ec","Fugaku:reason": "Fugaku:reason","Fugaku:v_mem": "Fugaku:v_mem","priority": "priority","accept": "accept","Fugaku:rank": "Fugaku:rank","Fugaku:core": "Fugaku:core","Fugaku:v_pol": "Fugaku:v_pol","Fugaku:lst": "Fugaku:lst","Fugaku:e_pol": "Fugaku:e_pol","job_name": "job_name","job_id": "job_id","elapse_time": "elapse_time","Fugaku:pc": "Fugaku:pc","user": "user","queue": "queue","status": "status","group": "group","start_date": "start_date","Fugaku:elapse_limit": "Fugaku:elapse_limit","Fugaku:md": "Fugaku:md"}

Properties
Name

Type

Required

Restrictions

Description

job_idstring

true

none

none

job_name

string

true

none

none

statusstring

true

none

none

user

string

true

none

none

group

string

true

none

none

start_date

string

true

none

none

elapse_time

string

false

none

none

27 / 30

hpc-v1.md

5/17/2023

Name

Type

Required

Restrictions

Description

priority

string

true

none

none

acceptstring

true

none

none

queue

string

true

none

none

Fugaku:elapse_limit

string

true

none

none

Fugaku:md

string

true

none

none

Fugaku:vnode

string

true

none

none

Fugaku:core

string

true

none

none

Fugaku:v_mem

string

true

none

none

Fugaku:v_pol

string

true

none

none

Fugaku:e_pol

string

true

none

none

Fugaku:rank

string

true

none

none

Fugaku:lst

string

true

none

none

Fugaku:ec

string

true

none

none

Fugaku:pc

string

true

none

none

Fugaku:sn

string

true

none

none

Fugaku:reason

string

true

none

none

files_sync_post_request{"path": "string","direction": "to_online","delete": false}

Properties
Name

Type

Required

Restrictions

path

stringtrue

none

Description
Directory path to synchronized on API Server is givenby path.

28 / 30

hpc-v1.md

Name

5/17/2023

Type

Required

Restrictions

Description
Direction of sync between API Sever Storage andOnline Object Storage is given by direction(default is from_online). Bucket Name on Online
Object Storage is predefined fixed value.

direction

stringfalse

none* to_online: API Server Storage is source, andOnline Object Storage is destination.
* from_online: Online Object Storage is source,and API Server Storage is destination.
If true is given by delete (default is false), files

deleteboolean

false

none

that exist in the destination but not in the source aredeleted during sync.

Enumerated Values
Property

Value

direction

to_online

direction

from_online

files_sync_post_200_response{"requestid": 0}

Properties
Name

Type

Required

Restrictions

Description

requestid

integer

true

none

Request ID of the synchronization.

files_sync_requestid_get_200_response{"result": "result","status": "waiting"}

Properties
29 / 30

hpc-v1.md

Name

5/17/2023

Type

Required

Restrictions

Description
Sync Status is set in status. If error, message is added
after error:

statusstringtrue

none* waiting* complete* error: parameter error* error: no such ID
Status code is set in result if status is complete. If

resultstring

false

none

sync is successful, 0 is returned. If sync fails, non-zerovalue is returned.

Enumerated Values
Property

Value

statuswaiting

statuscompletestatuserror: parameter error

statuserror: no such ID

30 / 30