Jump to

• Request
• Response

List targets requiring backup wallet maintenance

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/databases/RABackupMaintenance

Lists database targets that require SBT backup wallet synchronization after a Recovery Appliance virtual private catalog user password or TLS trusted certificate changes.

Request

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum number of targets returned in one page.

  Default Value: 50
• page: string
  Opaque URL-safe Base64 pagination cursor.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Pending SBT backup wallet maintenance for database targets configured to send backups and redo to a Recovery Appliance.

Headers

• ORCL-EM-PROCESSING-TIME:
  Elapsed time (in milliseconds) since the deployment procedure is submitted.

Body ()

Root Schema : ListMaintenanceResponse

Type: object

Paginated collection of database targets requiring Recovery Appliance backup wallet maintenance.

Show Source

• count(required): integer
  Number of targets included in this response page.
• links(required): object links
  Pagination links for this collection.
• targetList(required): array targetList
  Database targets and their backup wallet maintenance information.
• totalTargetsRequiringMaintenance(required): integer
  Total number of targets requiring maintenance.

{
    "description":"Paginated collection of database targets requiring Recovery Appliance backup wallet maintenance.",
    "type":"object",
    "required":[
        "targetList",
        "count",
        "totalTargetsRequiringMaintenance",
        "links"
    ],
    "properties":{
        "totalTargetsRequiringMaintenance":{
            "type":"integer",
            "description":"Total number of targets requiring maintenance."
        },
        "count":{
            "type":"integer",
            "description":"Number of targets included in this response page."
        },
        "targetList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TargetMaintenanceInfo"
            },
            "description":"Database targets and their backup wallet maintenance information."
        },
        "links":{
            "type":"object",
            "description":"Pagination links for this collection.",
            "required":[
                "self"
            ],
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    },
    "example":{
        "totalTargetsRequiringMaintenance":1075,
        "count":30,
        "targetList":[
            {
                "targetName":"mj_DB1",
                "targetType":"oracle_database",
                "maintenancesRequired":[
                    "The password for VPC user vpcuser1 on Recovery Appliance Alta has changed and must be updated.",
                    "The trusted certificate for Recovery Appliance Alta has changed and must be updated."
                ]
            },
            {
                "targetName":"bD_mmB2",
                "targetType":"rac_database",
                "maintenancesRequired":[
                    "Password of VPC user rman used for Recovery appliance mjra has changed and needs to be updated."
                ]
            }
        ],
        "links":{
            "self":{
                "href":"/em/api/databases/RABackupMaintenance?limit=30"
            },
            "next":{
                "href":"/em/api/databases/RABackupMaintenance?limit=30&page=ZXhhbXBsZUN1cnNvcg=="
            }
        }
    }
}

Example:

{
    "totalTargetsRequiringMaintenance":1075,
    "count":30,
    "targetList":[
        {
            "targetName":"mj_DB1",
            "targetType":"oracle_database",
            "maintenancesRequired":[
                "The password for VPC user vpcuser1 on Recovery Appliance Alta has changed and must be updated.",
                "The trusted certificate for Recovery Appliance Alta has changed and must be updated."
            ]
        },
        {
            "targetName":"bD_mmB2",
            "targetType":"rac_database",
            "maintenancesRequired":[
                "Password of VPC user rman used for Recovery appliance mjra has changed and needs to be updated."
            ]
        }
    ],
    "links":{
        "self":{
            "href":"/em/api/databases/RABackupMaintenance?limit=30"
        },
        "next":{
            "href":"/em/api/databases/RABackupMaintenance?limit=30&page=ZXhhbXBsZUN1cnNvcg=="
        }
    }
}

Nested Schema : links

Type: object

Pagination links for this collection.

Show Source

• next: object Link
  It represents a Link
• previous: object Link
  It represents a Link
• self(required): object Link
  It represents a Link

{
    "type":"object",
    "description":"Pagination links for this collection.",
    "required":[
        "self"
    ],
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : targetList

Type: array

Database targets and their backup wallet maintenance information.

Show Source

• Array of: object TargetMaintenanceInfo

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TargetMaintenanceInfo"
    },
    "description":"Database targets and their backup wallet maintenance information."
}

Nested Schema : Link

Type: object

It represents a Link

Show Source

• href: string
  URL for the link

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the link"
        }
    },
    "description":"It represents a Link"
}

Nested Schema : TargetMaintenanceInfo

Type: object

Show Source

• maintenancesRequired: array maintenancesRequired
  Required backup wallet maintenance actions for the target.
• targetName: string
  Target name.
• targetType: string
  Target type.

{
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target name."
        },
        "targetType":{
            "type":"string",
            "description":"Target type."
        },
        "maintenancesRequired":{
            "type":"array",
            "description":"Required backup wallet maintenance actions for the target.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : maintenancesRequired

Type: array

Required backup wallet maintenance actions for the target.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Required backup wallet maintenance actions for the target.",
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top