Jump to

• Request
• Response

ListInstanceBackups

get

/20160918/instanceBackups

List instance backups by compartment or instance. Specify a compartment OCID or an instance OCID.

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• instanceId: string
  The OCID of the instance.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: oracle.doceng.json.BetterJsonNull@2c07545f

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list is being retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object InstanceBackup

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

Nested Schema : InstanceBackup

Type: object

Show Source

• bootVolumeId: string
  The OCID of the boot volume of the backed up instance.
• bucketName: integer
  The bucket name in the object store to where the backup has been exported
• destinationType: string
  The destination type to where the backup has been exported, either objectStorageTuple or objectStorageUri.
• id: string
  The OCID of the instance backup.
• imageId: string
  The OCID of the source image of the backed up instance.
• instanceId: string
  The OCID of the instance which has been backed up.
• lifecycleState: integer
  The lifecycle state of the instance backup object.
• namespaceName: string
  The namespace in the object store to where the backup has been exported.
• volumeIds: object volumeIds
  The OCIDs of the attached block volumes of the backed up instance.

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the instance backup."
        },
        "instanceId":{
            "type":"string",
            "description":"The OCID of the instance which has been backed up."
        },
        "imageId":{
            "type":"string",
            "description":"The OCID of the source image of the backed up instance."
        },
        "bootVolumeId":{
            "type":"string",
            "description":"The OCID of the boot volume of the backed up instance."
        },
        "volumeIds":{
            "type":"object",
            "description":"The OCIDs of the attached block volumes of the backed up instance."
        },
        "destinationType":{
            "type":"string",
            "description":"The destination type to where the backup has been exported, either objectStorageTuple or objectStorageUri."
        },
        "namespaceName":{
            "type":"string",
            "description":"The namespace in the object store to where the backup has been exported."
        },
        "bucketName":{
            "type":"integer",
            "description":"The bucket name in the object store to where the backup has been exported"
        },
        "lifecycleState":{
            "type":"integer",
            "description":"The lifecycle state of the instance backup object."
        }
    },
    "type":"object"
}

Nested Schema : volumeIds

Type: object

The OCIDs of the attached block volumes of the backed up instance.

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top