Replication resources

Replication resources let you configure, monitor, and manage replication. The table below provides information about these resources.

Data type

Method

Use

Access

Notes

.../services/replication

replication
Service

GET

Retrieve replication service settings

System-level user account with the monitor or administrator role

 

POST

Modify replication service settings or perform an action on the replication service

System-level user account with the administrator role

For information on query parameters for performing actions on the replication service, see Query parameters for replication service actions.

.../services/replication/certificates
List GET Retrieves a list of replication certificates

System-level user account with the monitor or administrator role

 

Certificate

PUT Uploads a new replication certificate System-level user account with the administrator role  
.../services/replication/certificates/certificate-id
Link GET Retrieve information about a replication certificate

System-level user account with the monitor or administrator role

 
N/A DELETE Delete a replication certificate System-level user account with the administrator role  
.../services/replication/certificates/server
Text GET Downloads the replication server certificate and saves it on your computer as a server_certificate.txt file System-level user account with the administrator role  

.../services/replication/links

link

PUT

Create a replication link

System-level user account with the administrator role

 

List

GET

Retrieve a list of the replication links in which the HCP system being queried participates

System-level user account with the monitor or administrator role

The listed links are identified by link name.

In XML, each listed link is the value of an element named name. In JSON, the name in the name/value pair that lists the links is name.

.../services/replication/links/link-name

link

GET

Retrieve information about a replication link

System-level user account with the monitor or administrator role

 

N/A

HEAD

Check for the existence of a replication link

System-level user account with the monitor or administrator role

 

link

POST

Modify or perform an action on a replication link

System-level user account with the administrator role

For information on query parameters for performing actions on replication links, see .

N/A

DELETE

Delete a replication link

System-level user account with the administrator role

 

.../services/replication/links/link-name/content

content

GET

Retrieve a list of the items included in a replication link

System-level user account with the monitor or administrator role

 

.../services/replication/links/link-name/content/defaultNamespaceDirectories

List

GET

Retrieve a list of the default-namespace directories included in a replication link

System-level user account with the monitor or administrator role

This resource is available only if the default tenant exists.

The listed directories are identified by directory name.

In XML, each listed directory is the value of an element named name. In JSON, the name in the name/value pair that lists the directories is name.

.../services/replication/links/link-name/content/defaultNamespaceDirectories/
directory-name

N/A

PUT

Add a default-namespace directory to a replication link

System-level user account with the administrator role

 

DELETE

Remove a default-namespace directory from a replication link

System-level user account with the administrator role

 

.../services/replication/links/link-name/content/chainedLinks

List

GET

Retrieve a list of the chained links included in an active/passive link

System-level user account with the monitor or administrator role

Not valid for active/active links.

The listed chained links are identified by link name.

In XML, each listed chained link is the value of an element named name. In JSON, the name in the name/value pair that lists the chained links is name.

This resource is not valid for active/active links.

.../services/replication/links/link-name/content/chainedLinks/link-name

N/A

PUT

Add a chained link to an active/passive link

System-level user account with the administrator role

You cannot add a chained link to an active/active link.

DELETE

Remove a chained link from an active/passive link

System-level user account with the administrator role

 

.../services/replication/links/link-name/content/tenants

List

GET

Retrieve a list of the HCP tenants included in a replication link

System-level user account with the monitor or administrator role

The listed tenants are identified by tenant name.

In XML, each listed tenant is the value of an element named name. In JSON, the name in the name/value pair that lists the tenants is name.

.../services/replication/links/link-name/content/tenants/tenant-name

N/A

PUT

Add an HCP tenant to a replication link

System-level user account with the administrator role

 

tenant
(data type for replication link content tenant)

GET

Retrieve replication status information for a tenant included in a replication link

System-level user account with the monitor or administrator role

 

N/A

POST

Perform an action on a tenant included in a replication link

System-level user account with the administrator role

For information on query parameters for performing actions on tenants included in replication links, see Query parameters for replication link content tenant actions.

DELETE

Remove an HCP tenant from a replication link

System-level user account with the administrator role

 

.../services/replication/links/link-name/localCandidates

content

GET

Retrieve a list of the items on the system being queried that are eligible to be included in a replication link

System-level user account with the monitor or administrator role

 

.../services/replication/links/link-name/localCandidates/defaultNamespaceDirectories

List

GET

Retrieve a list of the default-namespace directories on the system being queried that are eligible to be included in a a replication link

System-level user account with the monitor or administrator role

This resource is available only if the default tenant exists.

The listed directories are identified by directory name.

In XML, each listed directory is the value of an element named name. In JSON, the name in the name/value pair that lists the directories is name.

.../services/replication/links/link-name/localCandidates/chainedLinks

List

GET

Retrieve a list of the inbound links on the system being queried that are eligible to be included in an active/passive link

System-level user account with the monitor or administrator role

Not valid for active/active links.

The listed chained links are identified by link name.

In XML, each listed chained link is the value of an element named name. In JSON, the name in the name/value pair that lists the chained links is name.

This resource is not valid for active/active links.

.../services/replication/links/link-name/localCandidates/tenants

List

GET

Retrieve a list of the HCP tenants on the system being queried that are eligible to be included in a replication link

System-level user account with the monitor or administrator role

The listed tenants are identified by tenant name.

In XML, each listed tenant is the value of an element named name. In JSON, the name in the name/value pair that lists the tenants is name.

.../services/replication/links/link-name/remoteCandidates

content

GET

Retrieve a list of the items on the other system involved in a replication link that are eligible to be included in the link

System-level user account with the monitor or administrator role

 

.../services/replication/links/link-name/remoteCandidates/defaultNamespaceDirectories

List

GET

Retrieve a list of the default-namespace directories on the other system involved in a replication link that are eligible to be included in the link

System-level user account with the monitor or administrator role

This resource is available only if the default tenant exists.

The listed directories are identified by directory name.

In XML, each listed directory is the value of an element named name. In JSON, the name in the name/value pair that lists the directories is name.

.../services/replication/links/link-name/remoteCandidates/chainedLinks

List

GET

Retrieve a list of the inbound links on the other system involved in an active/passive link that are eligible to be included in the link

System-level user account with the monitor or administrator role

Not valid for active/active links.

The listed chained links are identified by link name.

In XML, each listed chained link is the value of an element named name. In JSON, the name in the name/value pair that lists the chained links is name.

This resource is not valid for active/active links.

.../services/replication/links/link-name/remoteCandidates/tenants

List

GET

Retrieve a list of the HCP tenants on the other system involved in a replication link that are eligible to be included in the link

System-level user account with the monitor or administrator role

The listed tenants are identified by directory name.

In XML, each listed tenant is the value of an element named name. In JSON, the name in the name/value pair that lists the tenants is name.

.../services/replication/links/link-name/schedule

schedule

GET

Retrieve the schedules for an active/active link or the schedule for an active/passive link

System-level user account with the monitor or administrator role

 

POST

Modify the schedules for an active/active link or the schedule for an active/passive link

System-level user account with the administrator role

 

Trademark and LegalDisclaimer

© 2015 Hitachi Data Systems Corporation. All rights reserved.