The table below describes the properties included in the ecTopology data type. For more information about the properties of an erasure coding topology, see Erasure coding topology properties.
Property name | Data type | Description | Notes |
---|---|---|---|
description | String |
Specifies the description of the erasure coding topology. This description is optional. The default is no description. To remove the description from an existing erasure coding topology, specify the description property with no value. For the rules for descriptions, see Descriptions. |
This property is optional on a PUT request. |
erasureCodedObjects | Long |
Specifies the number of objects and parts of multipart objects on the local HCP system that were erasure coded according to this erasure coding topology. An object is counted as erasure coded if a chunk for it is stored on the system. |
This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
erasureCodingDelay | Integer |
Specifies the erasure coding delay for the erasure coding topology as a number of days. Valid values are integers in the range zero through 3,650. The default is zero. |
This property is optional on a PUT request. |
fullCopy | Boolean |
Specifies whether the erasure coding topology uses full-copy distribution or chunk distribution. Valid values are: •true — The erasure coding topology uses full-copy distribution. •false — The erasure coding topology uses chunk distribution. The default is false. |
This property is optional on a PUT request. |
hcpSystems | List |
Lists the HCP systems that are included in the erasure coding topology. Each system is identified by the fully qualified name of the domain associated with the [hcp_system] network on that system. |
This property is not valid on a PUT or POST request. 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. |
id | String | Specifies the ID for the erasure coding topology. | This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
minimumObjectSize | Long |
Specifies the minimum size for objects to be erasure coded. Valid values are: •4096 •16384 •32768 •65536 •131072 •262144 •524288 •1048576 The default is 4096. |
This property is optional on a PUT request. |
name | String | Specifies the name of the erasure coding topology. The name must be from one through 64 characters long and can contain any valid UTF-8 characters, including white space. Erasure coding topology names are not case sensitive. |
This property is required on a PUT request. |
protectionStatus | String |
Specifies the current status of the erasure coding topology with respect to how well-protected erasure-coded objects are. Possible values are: •BROKEN — Two or more systems in the topology are unavailable. Objects erasure coded according to the topology are inaccessible and are not protected. •HEALTHY — All systems in the topology are available. Objects erasure coded according to the topology can be read and are fully protected. •RETIRED — The topology has finished retiring. •RETIRING — The topology is in the process of retiring. •UNKNOWN — HCP cannot determine the protection status. •VULNERABLE — One system in the topology is unavailable, and the loss of a link or suspension of activity on a link would prevent an additional system from receiving data or chunks for newly ingested objects. Objects erasure coded according to the topology can be read but are not fully protected. |
This property is not valid on a PUT or POST request. |
readStatus | String |
Specifies the current status of the erasure coding topology with respect to the ability to read erasure-coded objects. Possible values are: •BROKEN — Two or more systems in the topology are unavailable. Objects erasure coded according to the topology are inaccessible. •HEALTHY — All systems in the topology are available. Objects erasure coded according to the topology can be read. •RETIRED — The topology has finished retiring. •UNKNOWN — HCP cannot determine the read status. •VULNERABLE — One system in the topology is unavailable. Objects erasure-coded according to the toplogy can be read, but the loss of a link would cause those objects to become inaccessible. |
This property is not valid on a PUT or POST request. |
replicationLinks | replication Links |
Specifies the replication links included in the erasure coding topology. For details, see replicationLinks. |
This property is required on a PUT request. It is not valid on a POST request. The properties returned for each replication link in response to a GET request for an erasure coding topology depend on whether the request includes the verbose=true query parameter. |
restorePeriod | Integer |
Specifies the restore period for the erasure coding topology as a number of days. Valid values are integers in the range zero through 180. The default is zero |
This property is optional on a PUT request. |
state | String |
Specifies the state of the erasure coding topology. Possible values are: •ACTIVE — The topology is currently being used to erasure-code newly ingested objects that are subject to erasure coding. •RETIRED — The topology is retired. •RETIRING — The topology is in the process of retiring. |
This property is not valid on a PUT or POST request. |
tenants | List |
Lists the tenants included in the erasure coding topology. |
This property is not valid on a PUT or POST request. In XML, the element that identifies each tenant is name. In JSON, the name in the name/value pair that lists the tenants is name. |
type | String |
Specifies the type of the underlying replication topology. Valid values for an erasure coding topology with four, five, or six systems are: •FULLY_CONNECTED — The erasure coding topology is based on a fully connected active/active replication topology. •RING — The erasure coding topology is based on an active/active replication ring topology. For an erasure coding topology with three systems, the value of this property must be FULLY_CONNECTED. These values are not case sensitive. |
This property is required on a PUT request. It is not valid on a POST request. |
© 2015, 2020 Hitachi Vantara LLC. All rights reserved.