replicationLink

The replicationLink property describes the replicationLinks property of the linkCandidates resource for erasure coding and the replicationLinks property of the ecTopology data type.

replicationLink data type properties

The following table describes the properties included in the replicationLink data type.

Property nameData typeDescriptionNotes
hcpSystemsListLists the two HCP systems included in the replication link. To specify a system, use the fully qualified name of the domain associated with the [hcp_system] network on that system.

This property is optional on a PUT request to create an erasure coding topology.

If a PUT request to create an erasure coding topology does not include the uuid property for a replication link and the name specified for the link is the same as the name of one or more other links, HCP may not know which link you want to include in the topology. To ensure that the correct link is used, the request should include the hcpSystems property for the link you want.

In XML, the element that identifies each system is name. In JSON, the name in the name/value pair that lists the systems is name.

nameStringSpecifies the name of the replication link.This property is required on a PUT request to create an erasure coding topology if the request does not include the uuid property for the replication link. Otherwise, the name property is optional.
pausedTenantsCountIntegerSpecifies the number of tenants for which replication on the link is currently paused.This property is not valid on a PUT request to create an erasure coding topology. It is returned only by a verbose GET request.
stateString

Indicates the general health of the replication link. Possible values are:

  • HEALTHY

    The specific status of the link is one of these:

    • oSynchronizing data
    • oScheduled data

  • NOT_REPLICATING

    The specific status of the link is one of these:

    • oSuspended by user
    • oRemote storage full, link suspended
    • oLocal storage full, link suspended
    • oFailed over

  • UNHEALTHY

    The specific status of the link is one of these:

    • oHigh error rate
    • oStalled link
    • oUnrecognized link
    • oBroken link

  • UNKNOWN

    HCP cannot determine the specific status of the link.

This property is not valid on a PUT request to create an erasure coding topology. It is returned only by a verbose GET request.
uuidStringSpecifies the unique ID for the replication link.This property is not valid on a PUT request to create an erasure coding topology. It is returned only by a verbose GET request.

Example

Here's an XML example of the replicationLink data type; the properties shown are those that are returned in response to a verbose GET request:

<replicationLink>
    <hcpSystems>
        <name>hcp-ca.example.com</name>
        <name>hcp-eu.example.com</name>
    </hcpSystems>
    <name>eu-ca</name>
    <pausedTenantsCount>0</pausedTenantsCount>
    <state>HEALTHY</state>
    <uuid>7ae4101c-6e29-426e-ae71-9a7a529f019d</uuid>
</replicationLink>