19.71. RPC Error Codes¶
RPC error codes are signed, 32-bit values returned by Clara Deploy SDK as part of the Standard Reponse Header.
All error codes are negative values, with non-negative values reserved for success conditions. The errors are as follows:
19.71.1. Pipeline Service Errors¶
Errors related to Pipelines and/or the Pipeline Service are in the range -[0x1000, 0x1999].
126.96.36.199. Invalid Pipeline ID¶
Returned when a Pipeline ID in an RPC request is malformed (i.e. not a valid UUID).
188.8.131.52. Missing/Invalid Pipeline¶
Returned when specified pipeline ID does not match an existing pipeline.
184.108.40.206. Pipeline Store Error¶
Returned when storage of a pipeline in the pipeline service fails.
220.127.116.11. Pipeline List Error¶
Returned when listing the pipelines in the pipeline service fails.
18.104.22.168. Pipeline Update Error¶
Returned when updating an exising pipelind in the pipeline service fails.
22.214.171.124. Pipeline Definition Error¶
Returned when the pipeline definition in an RPC request is malformed.
Messages: An exception string describing the issue with the request.
126.96.36.199. Pipeline Load Error¶
Returned when loading/parsing a Clara Pipeline Definition fails.
Messages: An exception string generated during the pipeline load process. This generally includes error messages to help resolve the issue with the provided pipeline definition.
19.71.2. Jobs Service Errors¶
Errors related to Pipeline Jobs and/or the Jobs Service are in the range -[0x2000, 0x2999].
188.8.131.52. Invalid Job ID¶
Returned when a job ID in an RPC request is malformed (i.e. not a valid UUID).
184.108.40.206. Missing/Invalid Job¶
Returned when specified job ID does not match an existing job.
220.127.116.11. Job Store Error¶
Returned when storage of a job in the jobs service fails.
18.104.22.168. Jobs List Error¶
Returned when listing the jobs in the jobs service fails.
22.214.171.124. Invalid Job Name¶
Returned when the specified name of a job is invalid.
Messages: Job name parse error and/or a definition for a valid job name.
126.96.36.199. Invalid Job Variable¶
Returned when a variable specified during job start is invalid.
Messages: Description of the variable definition that is invalid.
188.8.131.52. Create Payload Failed¶
Returned when creating a payload as part of job creation fails.
184.108.40.206. Job Start Error¶
Returned when starting a job fails.
220.127.116.11. Job Cancel Error¶
Returned when cancelling a job fails.
19.71.3. Payloads Service Errors¶
Errors related to payloads and/or the payload service are in the range -[0x3000, 0x3999].
18.104.22.168. Invalid Payload ID¶
Returned when a payload ID in an RPC request is malformed (i.e. not a valid UUID).
22.214.171.124. Missing/Invalid Payload¶
Returned when specified payload ID does not match an existing payload.
126.96.36.199. Missing File¶
Returned when a provided filename does not exist in the payload.
Messages: The name of the missing file.
188.8.131.52. Delete Contents Failure¶
Returned when deleting the contents of a payload fails.
184.108.40.206. Payload Details Failure¶
Returned when enumerating the contents of a payload fails.
220.127.116.11. Download File Failure¶
Returned when downloading the contents of a file from a payload fails.
Messages: An exception string describing the download failure.
18.104.22.168. Upload File Failure¶
Returned when uploading the contents of a file to a payload fails.
Messages: An exception string describing the upload failure.
22.214.171.124. Payload Delete Failure¶
Returned when deleting a payload fails.