Jump to

• Request
• Response

Get job by ID

get

/jobs/{jobId}

Describe job details and job status by job ID. Job details includes the job ID, status, the job created date and time stamp, etc.

Request

Supported Media Types

• application/json

Path Parameters

• jobId: string
  job ID

Back to Top

Response

Supported Media Types

• application/json

200 Response

job details

Body ()

Root Schema : ServiceJobReport

Type: object

Job Request Status

Show Source

• createTimestamp(optional): string(date-time)
• description(optional): string
• jobId(optional): string
• jobType(optional): string
• message(optional): string
• reports(optional): array reports
• resourceList(optional): array resourceList
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]
• updatedTime(optional): string(date-time)

{
    "description":"Job Request Status",
    "properties":{
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure"
            ]
        },
        "message":{
            "type":"string"
        },
        "reports":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskReport"
            }
        },
        "createTimestamp":{
            "type":"string",
            "format":"date-time"
        },
        "resourceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobResourceInfo"
            }
        },
        "description":{
            "type":"string"
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        },
        "jobType":{
            "type":"string"
        }
    }
}

Nested Schema : reports

Type: array

Show Source

• Array of: object TaskReport

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaskReport"
    }
}

Nested Schema : resourceList

Type: array

Show Source

• Array of: object JobResourceInfo
  resource information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobResourceInfo"
    }
}

Nested Schema : TaskReport

Type: object

Show Source

• duration(optional): string
• endTime(optional): string(date-time)
• jobId(optional): string
• nodeName(optional): string
• parentTaskId(optional): string
• reportLevel(optional): string
  Allowed Values: [ "Verbose", "Info", "Error" ]
• startTime(optional): string(date-time)
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ]
• tags(optional): array tags
• taskDescription(optional): string
• taskId(optional): string
• taskName(optional): string
• taskResult(optional): string
• updatedTime(optional): string(date-time)

{
    "properties":{
        "taskId":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "nodeName":{
            "type":"string"
        },
        "taskResult":{
            "type":"string"
        },
        "startTime":{
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "type":"string",
            "format":"date-time"
        },
        "duration":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure",
                "Skipped"
            ]
        },
        "taskDescription":{
            "type":"string"
        },
        "parentTaskId":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reportLevel":{
            "type":"string",
            "enum":[
                "Verbose",
                "Info",
                "Error"
            ]
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : tags

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : JobResourceInfo

Type: object

resource information

Show Source

• jobId(optional): string
• resourceId(optional): string
• resourceNewType(optional): string
• resourceType(optional): string
  Allowed Values: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]
• updatedTime(optional): string(date-time)

{
    "description":"resource information",
    "properties":{
        "resourceId":{
            "type":"string"
        },
        "resourceType":{
            "type":"string",
            "enum":[
                "Backup",
                "BackupConfig",
                "DB",
                "DbHome",
                "Grid",
                "Pdb",
                "Recovery",
                "Report",
                "Tde",
                "ObjectStoreSwift"
            ]
        },
        "resourceNewType":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Default Response

An unexpected error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
• message: string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top