Jump to

• Request
• Response

View Job Status of a Patch Precheck Operation

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/patches/checks/job/{jobId}

Returns information about the long-running job to precheck application of a patch.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

• jobId: string
  Job ID of the operation that was returned when the patching precheck was initiated.
• serviceId: string
  Name of the Database Classic Cloud Service instance.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : view-precheck-response

Type: object

The response body includes information about the patch precheck. When viewing all patching prechecks, the response body includes information about all patch prechecks executed on this service instance.

Show Source

• endDate(optional): string
  Date and time that the patching precheck operation stopped.
• href(optional): string
  URL for checking the status of the patching precheck job. This attribute displays only when viewing all patching precheck operations.
• id(optional): integer
  ID of the operation.
• inProgress(optional): boolean
  Flag that specifies whether the patch precheck is still in progress.
• jobId(optional): string
  Job ID for the patching precheck operation.
• jsonResult(optional): object jsonResult
  System messages. This attribute displays only when viewing the status of one patching precheck operation.
• patchId(optional): string
  Patch ID.
• performedBy(optional): string
  Name of the user account used to perform the patch precheck.
• startDate(optional): string
  Date and time that the patching precheck operation started.
• status(optional): string
  Status of the patching precheck operation. Valid values include:

  • PASSED_PRECHECK - Patching precheck passed.
  • DIDNT_PASS_PRECHECK - Patching precheck did not pass. Check the preCheckMessages attribute for more information.
  • DIDNT_FINISHED_PRECHECK - An internal error was encountered and the patching precheck could not be performed.

{
    "description":"The response body includes information about the patch precheck. When viewing all patching prechecks, the response body includes information about all patch prechecks executed on this service instance.",
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID of the operation."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID for the patching precheck operation."
        },
        "patchId":{
            "type":"string",
            "description":"Patch ID."
        },
        "startDate":{
            "type":"string",
            "description":"Date and time that the patching precheck operation started."
        },
        "endDate":{
            "type":"string",
            "description":"Date and time that the patching precheck operation stopped."
        },
        "performedBy":{
            "type":"string",
            "description":"Name of the user account used to perform the patch precheck."
        },
        "inProgress":{
            "type":"boolean",
            "description":"Flag that specifies whether the patch precheck is still in progress."
        },
        "status":{
            "type":"string",
            "description":"Status of the patching precheck operation. Valid values include: <ul><li><code>PASSED_PRECHECK</code> - Patching precheck passed.</li><li><code>DIDNT_PASS_PRECHECK</code> - Patching precheck did not pass. Check the <code>preCheckMessages</code> attribute for more information.</li><li><code>DIDNT_FINISHED_PRECHECK</code> - An internal error was encountered and the patching precheck could not be performed."
        },
        "href":{
            "type":"string",
            "description":"URL for checking the status of the patching precheck job. This attribute displays only when viewing all patching precheck operations."
        },
        "jsonResult":{
            "type":"object",
            "description":"System messages. This attribute displays only when viewing the status of one patching precheck operation.",
            "properties":{
                "statusMessage":{
                    "type":"string",
                    "description":"Describes status of executed precheck. Describes if the operation completed or encountered any errors."
                },
                "messages":{
                    "type":"array",
                    "description":"Precheck status detailed messages, if any.",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : jsonResult

Type: object

System messages. This attribute displays only when viewing the status of one patching precheck operation.

Show Source

• messages(optional): array messages
  Precheck status detailed messages, if any.
• statusMessage(optional): string
  Describes status of executed precheck. Describes if the operation completed or encountered any errors.

{
    "type":"object",
    "description":"System messages. This attribute displays only when viewing the status of one patching precheck operation.",
    "properties":{
        "statusMessage":{
            "type":"string",
            "description":"Describes status of executed precheck. Describes if the operation completed or encountered any errors."
        },
        "messages":{
            "type":"array",
            "description":"Precheck status detailed messages, if any.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Precheck status detailed messages, if any.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Precheck status detailed messages, if any.",
    "items":{
        "type":"string"
    }
}

Back to Top