REST API used to configure Cloud Object Storage buckets.
API Version: 1.0.0
Bases: object
Enables sending log data to IBM Cloud Activity Tracker Event Routing to provide visibility into bucket management, object read and write events. (Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker Event Routing instance at the container’s location unless otherwise specified in the Activity Tracker Event Routing Event Routing service configuration. (Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker Event Routing instance specified.
read_data_events (bool) – (optional) If set to true, all object read events (i.e. downloads) will be sent to Activity Tracker Event Routing.
write_data_events (bool) – (optional) If set to true, all object write events (i.e. uploads) will be sent to Activity Tracker Event Routing.
activity_tracker_crn (str) – (optional) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker Event Routing instance associated to the container’s location unless otherwise specified in the Activity Tracker Event Routing Event Routing service configuration. If activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker Event Routing instance specified and bucket management events are always enabled.
management_events (bool) – (optional) This field only applies if activity_tracker_crn is not populated. If set to true, all bucket management events will be sent to Activity Tracker Event Routing.
Initialize a ActivityTracking object from a json dictionary.
Bases: object
The current backup coverage for a COS Bucket.
initial_retention (DeleteAfterDays) – The number of days to retain data within a RecoveryRange.
policy_name (str) – The name granted to the policy. Validation : * chars limited to alphanumeric, underscore, hyphen and period.
target_backup_vault_crn (str) – The CRN for a COS BackupVault.
backup_type (str) – The type of backup to support. For LA+GA this is limited to “continuous”.
policy_id (str) – A UUID that uniquely identifies a resource.
policy_status (str) – The current status of the backup policy. pending : the policy has been received and has begun processing. initializing : pre-existing objects are being sync to the backup vault. active : the policy is active and healthy. action_needed : the policy is unhealthy and requires some intervention to recover degraded : the policy is unhealthy failed : the policy has failed unrecoverably.
initial_sync_progress (float) – (optional) Reports percent-doneness of init. Only present when policy_status=INITIALIZING/PENDING.
error_cause (str) – (optional) reports error cause. Only present when policy_status=ERROR/FAILED.
Bases: str, Enum
The type of backup to support. For LA+GA this is limited to “continuous”.
Bases: str, Enum
The current status of the backup policy. pending : the policy has been received and has begun processing. initializing : pre-existing objects are being sync to the backup vault. active : the policy is active and healthy. action_needed : the policy is unhealthy and requires some intervention to recover degraded : the policy is unhealthy failed : the policy has failed unrecoverably.
Initialize a BackupPolicy object from a json dictionary.
Bases: object
A collection of backup policies.
backup_policies (List[BackupPolicy]) – A collection of backup policies.
Initialize a BackupPolicyCollection object from a json dictionary.
Bases: object
Metadata associated with a backup vault.
activity_tracking (BackupVaultActivityTracking) – (optional) Activity Tracking configuration. An empty object ({}) indicates no configuration, and no events will be sent (This is the same behavior as {“management_events”:false}). Note that read/write events cannot be enabled, and events cannot be routed to a non-default Activity Tracker instance.
metrics_monitoring (BackupVaultMetricsMonitoring) – (optional) Metrics Monitoring configuration. An empty object ({}) indicates no configuration, and no metrics will be collected (This is the same behavior as {“usage_metrics_enabled”:false}). Note that request metrics cannot be enabled, and metrics cannot be routed to a non-default metrics router instance.
backup_vault_name (str) – The name given to a Bucket. Bucket names must be between 3 and 63 characters long must be made of lowercase letters, numbers, dots (periods), and dashes (hyphens). Bucket names must begin and end with a lowercase letter or number. Bucket names canâ€t contain consecutive dots or dashes. Bucket names that resemble IP addresses are not allowed. Bucket and BackupVault names exist in a global namespace and therefore must be unique.
region (str) – the region in which this backup-vault should be created within.
sse_kp_customer_root_key_crn (str) – (optional) The CRN for a KeyProtect root key.
crn (str) – (optional) The CRN for a COS BackupVault.
service_instance_crn (str) – (optional) A COS ServiceInstance CRN.
time_created (datetime) – (optional) creation time of the backup-vault. Returns “YYYY-MM-DDTHH:mm:ss.sssZ” timestamp format.
time_updated (datetime) – (optional) time of last update to the backup-vault Returns “YYYY-MM-DDTHH:mm:ss.sssZ” timestamp format.
bytes_used (int) – (optional) byte useage of the backup-vault. This should include all usage, including non-current versions. A maximum value is not defined.
Initialize a BackupVault object from a json dictionary.
Bases: object
Activity Tracking configuration. An empty object ({}) indicates no configuration, and no events will be sent (This is the same behavior as {“management_events”:false}). Note that read/write events cannot be enabled, and events cannot be routed to a non-default Activity Tracker instance.
management_events (bool) – (optional) Whether to send notifications for management events on the BackupVault.
Initialize a BackupVaultActivityTracking object from a json dictionary.
Bases: object
A listing of backup vaults.
next (NextPagination) – (optional) Pagination response body.
backup_vaults (List[str]) – List of Backup Vaults. If no Backup Vaults exist, this array will be empty.
Initialize a BackupVaultCollection object from a json dictionary.
Bases: object
Metrics Monitoring configuration. An empty object ({}) indicates no configuration, and no metrics will be collected (This is the same behavior as {“usage_metrics_enabled”:false}). Note that request metrics cannot be enabled, and metrics cannot be routed to a non-default metrics router instance.
usage_metrics_enabled (bool) – (optional) Whether usage metrics are collected for this BackupVault.
Initialize a BackupVaultMetricsMonitoring object from a json dictionary.
Bases: object
Metadata elements on a backup vault that can be updated.
activity_tracking (BackupVaultActivityTracking) – (optional) Activity Tracking configuration. An empty object ({}) indicates no configuration, and no events will be sent (This is the same behavior as {“management_events”:false}). Note that read/write events cannot be enabled, and events cannot be routed to a non-default Activity Tracker instance.
metrics_monitoring (BackupVaultMetricsMonitoring) – (optional) Metrics Monitoring configuration. An empty object ({}) indicates no configuration, and no metrics will be collected (This is the same behavior as {“usage_metrics_enabled”:false}). Note that request metrics cannot be enabled, and metrics cannot be routed to a non-default metrics router instance.
Initialize a BackupVaultPatch object from a json dictionary.
Bases: object
BackupVaultsPager can be used to simplify the use of the “list_backup_vaults” method.
Returns all results by invoking get_next() repeatedly until all pages of results have been retrieved. :return: A List[dict], where each element is a dict that represents an instance of . :rtype: List[dict]
Bases: object
A bucket.
name (str) – (optional) The name of the bucket. Non-mutable.
crn (str) – (optional) The service instance that holds the bucket. Non-mutable.
service_instance_id (str) – (optional) The service instance that holds the bucket. Non-mutable.
service_instance_crn (str) – (optional) The service instance that holds the bucket. Non-mutable.
time_created (datetime) – (optional) The creation time of the bucket in RFC 3339 format. Non-mutable.
time_updated (datetime) – (optional) The modification time of the bucket in RFC 3339 format. Non-mutable.
object_count (int) – (optional) Total number of objects in the bucket. Non-mutable.
bytes_used (int) – (optional) Total size of all objects in the bucket. Non-mutable.
noncurrent_object_count (int) – (optional) Number of non-current object versions in the bucket. Non-mutable.
noncurrent_bytes_used (int) – (optional) Total size of all non-current object versions in the bucket. Non-mutable.
delete_marker_count (int) – (optional) Total number of delete markers in the bucket. Non-mutable.
firewall (Firewall) – (optional) An access control mechanism based on the network (IP address) where request originated. Requests not originating from IP addresses listed in the allowed_ip field will be denied regardless of any access policies (including public access) that might otherwise permit the request. Viewing or updating the Firewall element requires the requester to have the manager role.
activity_tracking (ActivityTracking) – (optional) Enables sending log data to IBM Cloud Activity Tracker Event Routing to provide visibility into bucket management, object read and write events. (Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker Event Routing instance at the container’s location unless otherwise specified in the Activity Tracker Event Routing Event Routing service configuration. (Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker Event Routing instance specified.
metrics_monitoring (MetricsMonitoring) – (optional) Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in. (Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container’s location unless otherwise specified in the Metrics Router service configuration. (Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field.
hard_quota (int) – (optional) Maximum bytes for this bucket.
protection_management (ProtectionManagementResponse) – (optional) Data structure holding protection management response.
Bases: object
An object containing new bucket metadata.
firewall (Firewall) – (optional) An access control mechanism based on the network (IP address) where request originated. Requests not originating from IP addresses listed in the allowed_ip field will be denied regardless of any access policies (including public access) that might otherwise permit the request. Viewing or updating the Firewall element requires the requester to have the manager role.
activity_tracking (ActivityTracking) – (optional) Enables sending log data to IBM Cloud Activity Tracker Event Routing to provide visibility into bucket management, object read and write events. (Recommended) When the activity_tracker_crn is not populated, then enabled events are sent to the Activity Tracker Event Routing instance at the container’s location unless otherwise specified in the Activity Tracker Event Routing Event Routing service configuration. (Legacy) When the activity_tracker_crn is populated, then enabled events are sent to the Activity Tracker Event Routing instance specified.
metrics_monitoring (MetricsMonitoring) – (optional) Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in. (Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container’s location unless otherwise specified in the Metrics Router service configuration. (Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field.
hard_quota (int) – (optional) Maximum bytes for this bucket.
protection_management (ProtectionManagement) – (optional) Data structure holding protection management operations.
Initialize a BucketPatch object from a json dictionary.
Bases: object
The number of days to retain data within a RecoveryRange.
delete_after_days (int) – (optional) The number of days to retain data within a RecoveryRange.
Initialize a DeleteAfterDays object from a json dictionary.
Bases: object
The retention configuration for a RecoveryRange.
delete_after_days (int) – (optional) The number of days to retain data within a RecoveryRange. -1 is a special value that denotes “indefinite” retention. This value can only be set implicitly via a policy created during the LA release being upgraded to the GA release.
Initialize a DeleteAfterDaysWithIndefinite object from a json dictionary.
Bases: object
An access control mechanism based on the network (IP address) where request originated. Requests not originating from IP addresses listed in the allowed_ip field will be denied regardless of any access policies (including public access) that might otherwise permit the request. Viewing or updating the Firewall element requires the requester to have the manager role.
allowed_ip (List[str]) – (optional) List of IPv4 or IPv6 addresses in CIDR notation to be affected by firewall in CIDR notation is supported. Passing an empty array will lift the IP address filter. The allowed_ip array can contain a maximum of 1000 items.
denied_ip (List[str]) – (optional) List of IPv4 or IPv6 addresses in CIDR notation to be affected by firewall in CIDR notation is supported. Passing an empty array will lift the IP address filter. The denied_ip array can contain a maximum of 1000 items.
allowed_network_type (List[str]) – (optional) Indicates which network types are allowed for bucket access. May contain public, private, and/or direct elements. Setting allowed_network_type to only private will prevent access to object storage from outside of the IBM Cloud. The entire array will be overwritten in a PATCH operation. For more information on network types, [see the documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#advanced-endpoint-types).
Bases: str, Enum
May contain public, private, and/or direct elements. Setting allowed_network_type to only private will prevent access to object storage from outside of the IBM Cloud. The entire array will be overwritten in a PATCH operation. For more information on network types, [see the documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#advanced-endpoint-types).
Bases: object
Enables sending metrics to IBM Cloud Monitoring. All metrics are opt-in. (Recommended) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the Monitoring instance at the container’s location unless otherwise specified in the Metrics Router service configuration. (Legacy) When the metrics_monitoring_crn is populated, then enabled metrics are sent to the Monitoring instance defined in the metrics_monitoring_crn field.
usage_metrics_enabled (bool) – (optional) If set to true, all usage metrics (i.e. bytes_used) will be sent to the monitoring service.
request_metrics_enabled (bool) – (optional) If set to true, all request metrics (i.e. rest.object.head) will be sent to the monitoring service.
metrics_monitoring_crn (str) – (optional) When the metrics_monitoring_crn is not populated, then enabled metrics are sent to the monitoring instance associated to the container’s location unless otherwise specified in the Metrics Router service configuration. If metrics_monitoring_crn is populated, then enabled events are sent to the Metrics Monitoring instance specified.
Initialize a MetricsMonitoring object from a json dictionary.
Bases: object
Pagination response body.
href (str) – A URL to the continuation of results.
token (str) – The continuation token utilized for paginated results.
Initialize a NextPagination object from a json dictionary.
Bases: object
Data structure holding protection management operations.
requested_state (str) – (optional) If set to activate, protection management action on the bucket is being activated.
protection_management_token (str) – (optional) This field is required when using requested_state:activate and holds a JWT that is provided by the Cloud Operator. This should be the encoded JWT.
Bases: str, Enum
If set to activate, protection management action on the bucket is being activated.
Initialize a ProtectionManagement object from a json dictionary.
Bases: object
Data structure holding protection management response.
token_applied_counter (str) – (optional) Indicates the X number of protection management tokens that have been applied to the bucket in its lifetime.
token_entries (List[ProtectionManagementResponseTokenEntry]) – (optional) The ‘protection management token list’ holding a recent list of applied tokens. This list may contain a subset of all tokens applied to the bucket, as indicated by the counter.
Initialize a ProtectionManagementResponse object from a json dictionary.
Bases: object
Data structure holding protection management token.
token_id (str) – (optional)
token_expiration_time (str) – (optional)
token_reference_id (str) – (optional)
applied_time (str) – (optional)
invalidated_time (str) – (optional)
expiration_time (str) – (optional)
shorten_retention_flag (bool) – (optional)
Initialize a ProtectionManagementResponseTokenEntry object from a json dictionary.
Bases: object
Metadata associated with a recovery range.
source_resource_crn (str) – (optional) The CRN for a COS Bucket. Note that Softlayer CRNs do not contain dashes within the service_instance_id, whereas regular CRNs do. Although bucket backup is not supported for softlayer accounts, this need not be enforced at the CRN parsing level.
backup_policy_name (str) –
(optional) The name granted to the policy. Validation :
chars limited to alphanumeric, underscore, hyphen and period.
range_start_time (datetime) – (optional) The point in time at which backup coverage of the sourceResource begins. Returns “YYYY-MM-DDTHH:mm:ss.sssZ” timestamp format.
range_end_time (datetime) – (optional) the point in time at which backup coverage of the sourceResource ends. Returns “YYYY-MM-DDTHH:mm:ss.sssZ” timestamp format.
range_create_time (datetime) – (optional) The time at which this recoveryRange was initially created. Returns “YYYY-MM-DDTHH:mm:ss.sssZ” timestamp format NOTE : this can be before the start-time.
retention (DeleteAfterDaysWithIndefinite) – (optional) The retention configuration for a RecoveryRange.
recovery_range_id (str) – (optional) A UUID that uniquely identifies a resource.
Initialize a RecoveryRange object from a json dictionary.
Bases: object
A collection of recovery ranges.
next (NextPagination) – (optional) Pagination response body.
recovery_ranges (List[RecoveryRange]) – A list of recovery ranges.
Initialize a RecoveryRangeCollection object from a json dictionary.
Bases: object
The retention configuration for a RecoveryRange.
retention (DeleteAfterDays) – (optional) The number of days to retain data within a RecoveryRange.
Initialize a RecoveryRangePatch object from a json dictionary.
Bases: object
RecoveryRangesPager can be used to simplify the use of the “list_recovery_ranges” method.
Returns all results by invoking get_next() repeatedly until all pages of results have been retrieved. :return: A List[dict], where each element is a dict that represents an instance of RecoveryRange. :rtype: List[dict]
Bases: BaseService
The ResourceConfiguration V1 service.
Add a new backup policy to the COS Bucket.
Attach a new Backup Policy on a bucket. This request results in the creation of a single, new RecoveryRange on the destination BackupVault. Deletion and re-creation of a BackupPolicy to the same BackupVault destination will generate a new RecoveryRange. The following shall be validated. Any failure to validate shall cause a HTTP 400 to be returned.
the user has cloud-object-storage.bucket.post_backup_policy permissions on
the source-bucket must have cloud-object-storage.backup_vault.sync
the source-bucket must have versioning-on
the Backup Vault must exist and be able to be contacted by the source-bucket
the source-bucket must not have an existing BackupPolicy targeting the Backup
the source-bucket must not have a BackupPolicy with the same policy_name
the source-bucket must have fewer than 3 total BackupPolicies.
bucket (str) – Name of the COS Bucket name.
initial_retention (DeleteAfterDays) – The number of days to retain data within a RecoveryRange.
policy_name (str) – The name granted to the policy. Validation : * chars limited to alphanumeric, underscore, hyphen and period.
target_backup_vault_crn (str) – The CRN for a COS BackupVault.
backup_type (str) – The type of backup to support. For LA+GA this is limited to “continuous”.
m_d5 (str) – (optional) MD5 hash of content. If provided, the hash of the request must match.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a BackupPolicy object
create a BackupVault.
Creates a BackupVault. Requires that the user has cloud-object-storage.backup_vault.post_backup_vault permissions for the account. Certain fields will be returned only if the user has specific permissions:
activity_tracking requires
metrics_monitoring requires
cloud-object-storage.backup_vault.put_metrics_monitoring.
service_instance_id (str) – Name of the service_instance to list BackupVaults for.
backup_vault_name (str) – The name given to a Bucket. Bucket names must be between 3 and 63 characters long must be made of lowercase letters, numbers, dots (periods), and dashes (hyphens). Bucket names must begin and end with a lowercase letter or number. Bucket names canâ€t contain consecutive dots or dashes. Bucket names that resemble IP addresses are not allowed. Bucket and BackupVault names exist in a global namespace and therefore must be unique.
region (str) – the region in which this backup-vault should be created within.
activity_tracking (BackupVaultActivityTracking) – (optional) Activity Tracking configuration. An empty object ({}) indicates no configuration, and no events will be sent (This is the same behavior as {“management_events”:false}). Note that read/write events cannot be enabled, and events cannot be routed to a non-default Activity Tracker instance.
metrics_monitoring (BackupVaultMetricsMonitoring) – (optional) Metrics Monitoring configuration. An empty object ({}) indicates no configuration, and no metrics will be collected (This is the same behavior as {“usage_metrics_enabled”:false}). Note that request metrics cannot be enabled, and metrics cannot be routed to a non-default metrics router instance.
sse_kp_customer_root_key_crn (str) – (optional) The CRN for a KeyProtect root key.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a BackupVault object
Initiate a Restore.
Initiates a restore operation against some RecoveryRange to some destination bucket. The following shall be validated. Any failure to validate shall cause a HTTP 400 to be returned.
The specified RecoveryRange must exist
The restore time must be within the RecoveryRange
the user has cloud-object-storage.backup-vault.post_restore permissions on
the target-bucket must exist and be able to be contacted by the Backup Vault
target-bucket must have versioning-on
the Backup Vault must have cloud-object-storage.bucket.restore_sync
permissions on the target-bucket.
backup_vault_name (str) – name of BackupVault to restore from.
recovery_range_id (str) – A UUID that uniquely identifies a resource.
restore_type (str) – The type of restore to support. More options will be available in the future.
restore_point_in_time (datetime) – Timestamp format used throughout the API. Accepts the following formats: YYYY-MM-DDTHH:mm:ssZ YYYY-MM-DDTHH:mm:ss YYYY-MM-DDTHH:mm:ss-hh:mm YYYY-MM-DDTHH:mm:ss+hh:mm YYYY-MM-DDTHH:mm:ss.sssZ YYYY-MM-DDTHH:mm:ss.sss YYYY-MM-DDTHH:mm:ss.sss-hh:mm YYYY-MM-DDTHH:mm:ss.sss+hh:mm.
target_resource_crn (str) – The CRN for a COS Bucket. Note that Softlayer CRNs do not contain dashes within the service_instance_id, whereas regular CRNs do. Although bucket backup is not supported for softlayer accounts, this need not be enforced at the CRN parsing level.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a Restore object
Delete a BackupPolicy.
Delete a specific BackupPolicy. Requires that the user has cloud-object-storage.bucket.delete_backup_policy permissions on the bucket.
bucket (str) – name of the bucket affected.
policy_id (str) – uuid of the BackupPolicy.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse
Delete an empty Backup Vault.
Delete the Backup Vault. Requires that the BackupVault not contain any RecoveryRanges. Requires that the user has cloud-object-storage.backup_vault.delete_backup_vault permissions for the account.
backup_vault_name (str) – Name of the backup-vault to create or update.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse
Get BackupPolicy.
Read a specific backup policy on a bucket. Requires that the user has cloud-object-storage.bucket.get_backup_policy permissions on the bucket.
bucket (str) – name of the bucket affected.
policy_id (str) – uuid of the BackupPolicy.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a BackupPolicy object
get the config for a Backup Vault.
Gets configuration information for a Backup Vault. Requires that the user has cloud-object-storage.backup_vault.get_basic permissions on the backup vault. Certain fields will be returned only if the user has specific permissions:
activity_tracking requires
metrics_monitoring requires
sse_kp_customer_root_key_crn requires
cloud-object-storage.backup_vault.get_crk_id.
backup_vault_name (str) – Name of the backup-vault to create or update.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a BackupVault object
Returns metadata for the specified bucket.
Returns metadata for the specified bucket.
bucket (str) – Name of a bucket.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a Bucket object
Get Restore.
Introspect on a specific restore. Requires that the user have cloud-object-storage.backup_vault.get_restore permission on the backup vault.
backup_vault_name (str) – name of BackupVault that the restore occured on.
restore_id (str) – id of the restore to introspect on.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a Restore object
get RecoveryRange info.
Get info for a specific RecoveryRange. Requires the user have cloud-object-storage.backup_vault.get_recovery_range permissions to the Backup Vault.
backup_vault_name (str) – name of BackupVault to update.
recovery_range_id (str) – ID of the RecoveryRange to update.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a RecoveryRange object
List BackupPolicies.
Get all backup policies on a bucket. Requires that the user has cloud-object-storage.bucket.list_backup_policies permissions on the source bucket. This request generates the “cloud-object-storage.bucket-backup-policy.list” ActivityTracking event.
bucket (str) – Name of the COS Bucket name.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a BackupPolicyCollection object
list BackupVaults.
Returns a list of BackupVault CRNs owned by the account. Requires that the user has cloud-object-storage.backup_vault.list_account_backup_vaults permissions for the account.
service_instance_id (str) – Name of the service_instance to list BackupVaults for.
token (str) – (optional) the continuation token for controlling pagination.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a BackupVaultCollection object
List RecoveryRanges on a backup vault.
List RecoveryRanges on a backup vault. Lists all available ranges for all source resources by default. The ?source_resource_crn query parameter will limit the list to only ranges for the specified resource. Requires the user have cloud-object-storage.backup_vault.list_recovery_ranges permissions to the Backup Vault.
backup_vault_name (str) – name of BackupVault.
source_resource_crn (str) – (optional) CRN of source resource to filter on. This limits ranges returned to only ranges where the source_resource_crn matches the parameter value.
latest (str) – (optional) If “true”, then return only the latest RecoveryRange for each source-resource that is backed up. If “false” or not specified, then the default behavior is produced. Value is can insensative. If any value is provided other than “true” or “false” then return 400.
token (str) – (optional) the continuation token for controlling pagination.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a RecoveryRangeCollection object
List Restores.
List all current and complete restores. Requires that the user have cloud-object-storage.backup_vault.list_restores permission on the backup vault.
backup_vault_name (str) – name of BackupVault to restore from.
token (str) – (optional) the continuation token for controlling pagination.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a RestoreCollection object
specified parameters and external configuration.
patch RecoveryRange info.
Update a RecoveryRange via JSON-merge-patch semantics. Requires the user have cloud-object-storage.backup_vault.put_retention permissions to the Backup Vault. The retention.delete_after_days value may only be extended.
backup_vault_name (str) – name of BackupVault to update.
recovery_range_id (str) – ID of the RecoveryRange to update.
recovery_range_patch (RecoveryRangePatch) – The RecoveryRange configuration elements that are to be changed.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a RecoveryRange object
Update the config on a Backup Vault.
Update the Backup Vault config via JSON Merge Patch update semantics. In particular, note that providing an empty object ({}) to either field in the request body will remove any existing configuration. Requires that the user have specific permissions depending on what is being changed:
activity_tracking requires
metrics_monitoring requires
cloud-object-storage.backup_vault.put_metrics_monitoring.
backup_vault_name (str) – Name of the backup-vault to create or update.
backup_vault_patch (BackupVaultPatch) – A Backup Vault config object containing changes to apply to the existing Backup Vault config.
if_match (str) – (optional) Conditionally update the Backup Vault config if and only if the ETag of the existing config exactly matches the provided If-Match MD5.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse with dict result representing a BackupVault object
Make changes to a bucket’s configuration.
Updates a bucket using [JSON Merge Patch](https://tools.ietf.org/html/rfc7396). This request is used to add functionality (like an IP access filter) or to update existing parameters. Primitives are overwritten and replaced in their entirety. It is not possible to append a new (or to delete a specific) value to an array. Arrays can be cleared by updating the parameter with an empty array []. A PATCH operation only updates specified mutable fields. Please don’t use PATCH trying to update the number of objects in a bucket, any timestamps, or other non-mutable fields.
bucket (str) – Name of a bucket.
bucket_patch (BucketPatch) – (optional) An object containing new configuration metadata.
if_match (str) – (optional) An Etag previously returned in a header when fetching or updating a bucket’s metadata. If this value does not match the active Etag, the request will fail.
headers (dict) – A dict containing the request headers
A DetailedResponse containing the result, headers and HTTP status code.
DetailedResponse
Bases: object
Metadata associated with a requested restore operation.
recovery_range_id (str) – A UUID that uniquely identifies a resource.
restore_type (str) – The type of restore to support. More options will be available in the future.
restore_point_in_time (datetime) – Timestamp format used throughout the API. Accepts the following formats: YYYY-MM-DDTHH:mm:ssZ YYYY-MM-DDTHH:mm:ss YYYY-MM-DDTHH:mm:ss-hh:mm YYYY-MM-DDTHH:mm:ss+hh:mm YYYY-MM-DDTHH:mm:ss.sssZ YYYY-MM-DDTHH:mm:ss.sss YYYY-MM-DDTHH:mm:ss.sss-hh:mm YYYY-MM-DDTHH:mm:ss.sss+hh:mm.
target_resource_crn (str) – The CRN for a COS Bucket. Note that Softlayer CRNs do not contain dashes within the service_instance_id, whereas regular CRNs do. Although bucket backup is not supported for softlayer accounts, this need not be enforced at the CRN parsing level.
source_resource_crn (str) – (optional) The CRN for a COS Bucket. Note that Softlayer CRNs do not contain dashes within the service_instance_id, whereas regular CRNs do. Although bucket backup is not supported for softlayer accounts, this need not be enforced at the CRN parsing level.
restore_id (str) – (optional) A UUID that uniquely identifies a resource.
restore_status (str) – (optional) The current status for this restore operation. initializing: The operation is initializing. Do not expect to see restored objects on the target bucket. running : The operation is ongoing. Expect to see some restored objects on the target bucket. complete: The operation has completed successfully. failed: The operation has completed unsuccessfully.
init_time (datetime) – (optional) The time at which this restore was initiated Returns “YYYY-MM-DDTHH:mm:ss.sssZ” timestamp format.
complete_time (datetime) – (optional) The time at which this restore ended (in both success and error cases) Returns “YYYY-MM-DDTHH:mm:ss.sssZ” timestamp format.
restore_percent_progress (int) – (optional) reports percent-doneness of init. Only present when restore_status=running.
error_cause (str) – (optional) Only present when restore_status=running.
Bases: str, Enum
The current status for this restore operation. initializing: The operation is initializing. Do not expect to see restored objects on the target bucket. running : The operation is ongoing. Expect to see some restored objects on the target bucket. complete: The operation has completed successfully. failed: The operation has completed unsuccessfully.
Bases: str, Enum
The type of restore to support. More options will be available in the future.
Bases: object
A list of restore operations.
next (NextPagination) – (optional) Pagination response body.
restores (List[Restore]) – A collection of active and completed restore operations.
Initialize a RestoreCollection object from a json dictionary.
Bases: object
RestoresPager can be used to simplify the use of the “list_restores” method.
Returns all results by invoking get_next() repeatedly until all pages of results have been retrieved. :return: A List[dict], where each element is a dict that represents an instance of Restore. :rtype: List[dict]
Version of ibm_cos_sdk_config
IBM COS Resource Configuration SDK for Python