Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get Azure Data Replication Rules

Description

Get information about all Azure replication rules. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/azure_data_replication_rule​[?data_policy_id={string}][&last_page]​[&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}][&replicate_deletes=TRUE|FALSE][&state=NORMAL]​[&target_id={string}][&type=PERMANENT|RETIRED]

Request Parameters 

Parameter	Description	Required
data_policy_id	Data policy UUID or other unique attribute.	no
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of Azure replication rules to list. Default: all items after page_offset.	no
page_offset	The starting point for the first Azure replication rule to list. Default: 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page_start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no
replicate_deletes	Whether objects deleted from local buckets are also deleted from the replication target. Values: TRUE, FALSE	no
state	The state of the replication rule. Values: NORMAL — The Azure replication rule is in a normal, included state.	no
target_id	The Azure target UUID or other unique attribute.	no
type	The type of Azure replication rule. Values: PERMANENT, RETIRED. See Type for descriptions.	no

Responses

Response Elements

<Data>

   <AzureDataReplicationRule>

     <DataPolicyId>{string}</DataPolicyId>

     <Id>{string}</Id>

     <MaxBlobPartSizeInBytes>{string}</MaxBlobPartSizeInBytes>

     <ReplicateDeletes>TRUE|FALSE</ReplicateDeletes
     <State>NORMAL</State>

     <TargetId>{string}</TargetId>

     <Type>PERMANENT</Type>

   </AzureDataReplicationRule>

</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
AzureReplication Rule	The container for information about one Azure replication rule.
DataPolicyId	The UUID for the data policy.
Id	The UUID for the Azure replication rule.
ReplicateDeletes	Whether objects deleted from local buckets are also deleted from the replication target. Values: TRUE, FALSE
State	The state of the persistence rule. Value: NORMAL — The persistence rule is in a normal, included state.
TargetId	The UUID for the Azure target.
Type	The type of replication rule. Values: PERMANENT, RETIRED. See Type for descriptions.

Example

Sample Request

This request gets information about all Azure data replication rules on the BlackPearl system.

GET http://blackpearl-hostname/_rest_/azure_data_replication_rule/HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>

   <AzureDataReplicationRule>

     <DataPolicyId>

       d8945332-11f2-47d0-8ca8-dafe204d2d1e

     </DataPolicyId>

     <Id>8ac0c6fd-de37-4936-8862-caa0f1844735</Id>

     <MaxBlobPartSizeInBytes>1073741824</MaxBlobPartSizeInBytes>

     <ReplicateDeletes>TRUE</ReplicateDeletes
     <State>NORMAL</State>

     <TargetId>1dad5f1e-d55b-415a-a8ab-9bc387e1eb33</TargetId>

     <Type>PERMANENT</Type>

   </AzureDataReplicationRule>

   <AzureDataReplicationRule>

     <DataPolicyId>

        9f7418e5-67e6-47f7-8653-dec602c66eeb
     </DataPolicyId>

     <Id>485634bd-d9fc-478e-8bbf-3e1cf65a94b6</Id>

     <MaxBlobPartSizeInBytes>1073741824</MaxBlobPartSizeInBytes>

     <ReplicateDeletes>TRUE</ReplicateDeletes
     <State>NORMAL</State>

     <TargetId>d86f4876-46d9-432c-843c-a6dd12355e7e</TargetId>

     <Type>PERMANENT</Type>

   </AzureDataReplicationRule>

</Data>