GetVolumeBackupPolicyAssetAssignment
get
/20160918/volumeBackupPolicyAssignments
Get the volume backup policy assignment for the specified volume. The assetId query parameter is required. The returned list will contain at most one item, since volume can only have one volume backup policy assigned at a time.
Request
Supported Media Types
- application/json
Query Parameters
-
assetId(required): string
The OCID of an asset (for example, a volume).
-
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
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.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object VolumeBackupPolicyAssignment
Specifies the volume that the volume backup policy is assigned to.
Nested Schema : VolumeBackupPolicyAssignment
Type:
object
Specifies the volume that the volume backup policy is assigned to.
Show Source
-
assetId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the volume the policy has been assigned to. -
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the volume backup policy assignment. -
policyId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the volume backup policy that has been assigned to the volume. -
timeCreated(required):
string(date-time)
The date and time the volume backup policy was assigned to the volume. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
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