Jump to

• Request
• Response

ListVolumeBackupPolicies

get

/20160918/volumeBackupPolicies

List all the volume backup policies available in the specified compartment.

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment. If no compartment is specified, the Oracle defined backup policies are listed.
• 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 VolumeBackupPolicy
  A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are created. Avoid entering confidential information when you supply string values using the API.

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

Nested Schema : VolumeBackupPolicy

Type: object

A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are created. Avoid entering confidential information when you supply string values using the API.

Show Source

• compartmentId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment that contains the volume backup.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace.
• destinationRegion: string
  Minimum Length: 1

  Maximum Length: 255

  The paired destination region for copying scheduled backups to. Example us-ashburn-1.
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the volume backup policy.
• lifecycleState: string
  Allowed Values: [ "AVAILABLE" ]

  The current state of a volume backup. This will only ever be sent to SPLAT for reconciliation.
• schedules(required): array schedules
  The collection of schedules that this policy will apply.
• timeCreated(required): string(date-time)
  The date and time the volume backup policy was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

{
    "description":"A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are created. Avoid entering confidential information when you supply string values using the API.",
    "x-obmcs-splat":{
        "resourceKind":"backup-policies",
        "adLocality":"regional",
        "getOperationId":"GetVolumeBackupPolicy",
        "ocidEntityType":"volumebackuppolicy",
        "activeLifecycleStates":[
            "AVAILABLE"
        ],
        "deletedLifecycleStates":[
            ""
        ],
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"VolumeBackupPolicy",
            "scope":"customer"
        }
    },
    "properties":{
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "id":{
            "description":"The OCID of the volume backup policy.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "schedules":{
            "description":"The collection of schedules that this policy will apply.",
            "items":{
                "$ref":"#/definitions/VolumeBackupSchedule"
            },
            "type":"array"
        },
        "destinationRegion":{
            "description":"The paired destination region for copying scheduled backups to. Example us-ashburn-1.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the volume backup policy was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).",
            "format":"date-time",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the volume backup.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of a volume backup. This will only ever be sent to SPLAT for reconciliation.",
            "enum":[
                "AVAILABLE"
            ],
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "required":[
        "id",
        "displayName",
        "schedules",
        "timeCreated"
    ],
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : schedules

Type: array

The collection of schedules that this policy will apply.

Show Source

• Array of: object VolumeBackupSchedule
  Defines the backup frequency and retention period for a volume backup policy.

{
    "description":"The collection of schedules that this policy will apply.",
    "items":{
        "$ref":"#/definitions/VolumeBackupSchedule"
    },
    "type":"array"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : VolumeBackupSchedule

Type: object

Defines the backup frequency and retention period for a volume backup policy.

Show Source

• backupType(required): string
  Allowed Values: [ "FULL", "INCREMENTAL" ]

  The type of volume backup to create.
• dayOfMonth: integer
  Minimum Value: 1

  Maximum Value: 31

  The day of the month to schedule the volume backup.
• dayOfWeek: string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]

  The day of the week to schedule the volume backup.
• hourOfDay: integer
  Minimum Value: 0

  Maximum Value: 23

  The hour of the day to schedule the volume backup.
• month: string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]

  The month of the year to schedule the volume backup.
• offsetSeconds: integer
  Minimum Value: 0

  Maximum Value: 31532400

  Multiple Of: 3600

  The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period. The volume backup start time is the frequency start time plus the offset.
• offsetType: string
  Allowed Values: [ "STRUCTURED", "NUMERIC_SECONDS" ]

  Indicates how the offset is defined. If value is STRUCTURED, then hourOfDay, dayOfWeek, dayOfMonth, and month fields are used and offsetSeconds will be ignored in requests and users should ignore its value from the responses. hourOfDay is applicable for periods ONE_DAY, ONE_WEEK, ONE_MONTH and ONE_YEAR. dayOfWeek is applicable for period ONE_WEEK. dayOfMonth is applicable for periods ONE_MONTH and ONE_YEAR. 'month' is applicable for period 'ONE_YEAR'. They will be ignored in the requests for inapplicable periods. If value is NUMERIC_SECONDS, then offsetSeconds will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the responses. For clients using older versions of Apis and not sending offsetType in their requests, the behaviour is just like NUMERIC_SECONDS.
• period(required): string
  Allowed Values: [ "ONE_HOUR", "ONE_DAY", "ONE_WEEK", "ONE_MONTH", "ONE_YEAR" ]

  The volume backup frequency.
• retentionSeconds(required): integer
  Minimum Value: 3600

  Maximum Value: 1576800000

  Multiple Of: 3600

  How long, in seconds, to keep the volume backups created by this schedule.
• timeZone: string
  Default Value: UTC

  Allowed Values: [ "UTC", "REGIONAL_DATA_CENTER_TIME" ]

  Specifies what time zone is the schedule in

{
    "description":"Defines the backup frequency and retention period for a volume backup policy.",
    "properties":{
        "backupType":{
            "description":"The type of volume backup to create.",
            "enum":[
                "FULL",
                "INCREMENTAL"
            ],
            "type":"string"
        },
        "offsetSeconds":{
            "minimum":"0",
            "maximum":"31532400",
            "multipleOf":"3600",
            "description":"The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period. The volume backup start time is the frequency start time plus the offset.",
            "type":"integer"
        },
        "period":{
            "description":"The volume backup frequency.",
            "enum":[
                "ONE_HOUR",
                "ONE_DAY",
                "ONE_WEEK",
                "ONE_MONTH",
                "ONE_YEAR"
            ],
            "type":"string"
        },
        "offsetType":{
            "description":"Indicates how the offset is defined. If value is STRUCTURED, then hourOfDay, dayOfWeek, dayOfMonth, and month fields are used and offsetSeconds will be ignored in requests and users should ignore its value from the responses. hourOfDay is applicable for periods ONE_DAY, ONE_WEEK, ONE_MONTH and ONE_YEAR. dayOfWeek is applicable for period ONE_WEEK. dayOfMonth is applicable for periods ONE_MONTH and ONE_YEAR. 'month' is applicable for period 'ONE_YEAR'. They will be ignored in the requests for inapplicable periods. If value is NUMERIC_SECONDS, then offsetSeconds will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the responses. For clients using older versions of Apis and not sending offsetType in their requests, the behaviour is just like NUMERIC_SECONDS.",
            "enum":[
                "STRUCTURED",
                "NUMERIC_SECONDS"
            ],
            "type":"string"
        },
        "hourOfDay":{
            "description":"The hour of the day to schedule the volume backup.",
            "minimum":"0",
            "maximum":"23",
            "type":"integer"
        },
        "dayOfWeek":{
            "description":"The day of the week to schedule the volume backup.",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ],
            "type":"string"
        },
        "dayOfMonth":{
            "description":"The day of the month to schedule the volume backup.",
            "minimum":"1",
            "maximum":"31",
            "type":"integer"
        },
        "month":{
            "description":"The month of the year to schedule the volume backup.",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ],
            "type":"string"
        },
        "retentionSeconds":{
            "description":"How long, in seconds, to keep the volume backups created by this schedule.",
            "maximum":"1576800000",
            "multipleOf":"3600",
            "minimum":"3600",
            "type":"integer"
        },
        "timeZone":{
            "description":"Specifies what time zone is the schedule in",
            "enum":[
                "UTC",
                "REGIONAL_DATA_CENTER_TIME"
            ],
            "type":"string",
            "default":"UTC"
        }
    },
    "required":[
        "period",
        "backupType",
        "retentionSeconds"
    ],
    "type":"object"
}

400 Response

Bad Request

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."
        }
    }
}

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."
        }
    }
}

Default Response

An error has occurred.

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