GetVolumeBackupPolicy
get
/20160918/volumeBackupPolicies/{policy_id}
Get information for the specified volume backup policy.
Request
Supported Media Types
- application/json
Path Parameters
-
policyId(required): string
The OCID of the volume backup policy.
Response
Supported Media Types
- application/json
200 Response
The volume backup policy was retrieved.
Headers
-
etag: string
For optimistic concurrency control. See if-match.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root 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: additionalPropertiesDefined 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: additionalPropertiesFree-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).
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : freeformTags
Type:
object
Additional Properties Allowed
Show Source
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.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only the String type is supported.
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
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.
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
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.
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
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.
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
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.
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
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.
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