The table below describes the properties included in the namespace data type.
Property name |
Data type |
Description |
Notes |
---|---|---|---|
String |
Specifies whether the namespace supports access control lists (ACLs) and, if so, whether HCP honors ACLs in the namespace. Valid values are: •NOT_ENABLED — The namespace does not support ACLs. •ENFORCED — The namespace supports ACLs, and HCP honors ACLs in the namespace. •NOT_ENFORCED — The namespace supports ACLs, but HCP does not honor ACLs in the namespace. The default is NOT_ENABLED. |
This property is optional on a PUT request. You can change the value of this property from NOT_ENABLED to ENFORCED or NOT_ENFORCED but not from ENFORCED or NOT_ENFORCED to NOT_ENABLED. This property is not valid for the default namespace. |
|
Boolean |
Specifies whether changes to POSIX UIDs, GIDs, and permissions and to object ownership are allowed for objects under retention in the namespace. Valid value are: •true — Changes to POSIX UIDs, GIDs, and permissions and to object ownership are allowed for objects under retention. •false — Changes to POSIX UIDs, GIDs, and permissions and to object ownership are not allowed for objects under retention. The default is false. |
This property is optional on a PUT request. This property is not valid for the default namespace. |
|
Boolean |
Specifies whether the namespace supports appendable objects. Valid values are: •true — The namespace supports appendable objects. •false — The namespace does not support appendable objects. The default is false. |
This property is optional on a PUT request. You cannot enable both appendable objects and versioning for a namespace. This property is not valid for the default namespace. |
|
Boolean |
Specifies whether atime synchronization with retention settings is enabled for the namespace. Valid values are: •true — Atime synchronization is enabled. •false — Atime synchronization is not enabled. The default is false. |
This property is optional on a PUT request. This property is not valid for the default namespace. |
|
List |
Lists the minimum data access permissions for all unauthenticated users of the namespace. Authenticated users also have these permissions when the value of the authUsersAlways-GrantedAllPermissions property is true. Valid values for permissions are: •BROWSE •DELETE •PURGE •READ •READ_ACL •WRITE •WRITE_ACL The default is no permissions. |
This property is optional on a PUT request. For the format of the permission list, see Permission lists. The set of permissions specified in the request body replaces the current set of minimum permissions for all users. To remove all the permissions for all users, specify an empty list. If the set of permissions includes PURGE, delete permission is enabled automatically. If the set of permissions includes READ, browse permission is enabled automatically. This property is not valid for the default namespace. |
|
List |
Lists the minimum data access permissions for authenticated users of the namespace. Valid values for permissions are: •BROWSE •DELETE •PURGE •READ •READ_ACL •WRITE •WRITE_ACL The default is no permissions. |
This property is optional on a PUT request. For the format of the permission list, see Permission lists. The set of permissions specified in the request body replaces the current set of permissions for authenticated users. To remove all the permissions for authenticated users, specify an empty list. If the set of permissions includes PURGE, delete permission is enabled automatically. If the set of permissions includes READ, browse permission is enabled automatically. This property is not valid for the default namespace. |
|
Boolean |
Specifies whether users have the minimum data access permissions specified by the authAndAnonymous-MinimumPermissions property in addition to the minimum data access permissions specified by the authMinimumPermissions property when using a protocol that requires authentication. Valid values are: •true — Users have the minimum data access permissions specified by both properties when using a protocol that requires authentication. •false — Users have only the minimum data access permissions specified by the authMinimum-Permissions property when using a protocol that requires authentication. The default is true. |
This property is optional on a PUT request. This property is not valid for the default namespace. |
|
String |
Specifies the date and time at which the namespace was created, in this ISO 8601 format: yyyy-MM-ddThh:mm:ssZ Z represents the offset from UTC, in this format: (+|-)hhmm For example: 2012-02-09T19:44:03-0500 |
This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
|
customMetadataIndexing |
Boolean |
Specifies whether custom metadata indexing is enabled for the namespace. Valid values are: •true — Custom metadata indexing is enabled. •false — Custom metadata indexing is disabled. The default is false. |
This property is optional on a PUT request. You can set this property to true only while indexing is enabled for the namespace. Disabling custom metadata indexing for the namespace automatically disables full custom metadata indexing. |
Boolean |
Specifies whether custom metadata XML checking is enabled for the namespace. Valid values are: •true — When custom metadata is added to an object in the namespace, HCP checks whether the custom metadata is well-formed XML. •false — When custom metadata is added to an object in the namespace, HCP does not check whether the custom metadata is well-formed XML. The default is false. |
This property is optional on a PUT request. |
|
String |
Specifies a description of the namespace. This description is optional. The default is the description specified by the namespace defaults for the tenant. To remove a description from an existing namespace, specify the description property with no value. For the rules for descriptions, see Common property values. |
This property is optional on a PUT request. |
|
String |
|
Deprecated. Namespace DPL is now a service plan function. This property is ignored on a PUT or POST request. In response to a GET request, the value of this property is always Dynamic. |
|
Boolean |
Specifies the namespace retention mode. Valid values are: •true — The namespace is in enterprise mode. •false — The namespace is in compliance mode. The default is the retention mode specified by the namespace defaults for the tenant. |
This property is optional on a PUT request. You can set the value of this property to false only if the owning tenant is allowed to set the retention mode for its namespaces. In enterprise mode, privileged deletes are allowed, retention class durations can be shortened, and retention classes can be deleted. In compliance mode, these activities are not allowed. The value of this property can be changed from true to false but not from false to true. |
|
String |
Specifies the fully qualified hostname of the namespace. |
This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
|
String |
For an HCP namespace, specifies the total amount of space allocated to the namespace. This is the space available for storing objects, including object data, metadata, and the redundant data required to satisfy the namespace service plan. Valid values are decimal numbers with up to two places after the period, followed by a space, followed by MB, GB, or TB (for example, 1.25 TB). The minimum value is 1 (one) for GB and .01 for TB. The maximum value is the amount of space the tenant has available to allocate to its namespaces. The default is the hard quota specified by the namespace defaults for the tenant. |
This property is optional on a PUT request. This property is not valid for the default namespace. |
|
String |
Specifies the cryptographic hash algorithm for the namespace. Valid values are: MD5 These values are case sensitive. The default is the cryptographic hash algorithm specified by the namespace defaults for the tenant. |
This property is optional on a PUT request. It is not valid on a POST request and is returned only by a verbose GET request. |
|
String |
Specifies the system-supplied unique ID for the namespace. HCP generates this ID automatically when you create a namespace. |
This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
|
Boolean |
For an HCP namespace, specifies the default index setting for objects added to the namespaces. Valid values are: •true — New objects are marked for indexing. •false — New objects are not marked for indexing. The default is true. |
This property is optional on a PUT request. This property is not valid for the default namespace. |
|
Boolean |
Specifies whether indexing is enabled for the namespace. Valid values are: •true — Indexing is enabled. •false — Indexing is disabled. On a PUT request, the default is true if searchEnabled is set to true in the same request; otherwise, the default is false. |
This property is optional on a PUT request. You can set this property to true only while search is enabled for the namespace. Disabling indexing for the namespace automatically disables custom metadata indexing. |
|
Boolean |
|
Deprecated. Namespace DPL is now a service plan function. This property is not valid on a PUT or POST request. In response to a GET request, the value of this property is always true. |
|
mqeIndexingTimestamp |
String |
Specifies the date and time before which objects are guaranteed to have been indexed by the metadata query engine, in this ISO 8601 format: yyyy-MM-ddThh:mm:ssZ Z represents the offset from UTC, in this format: (+|-)hhmm For example: 2012-02-09T19:44:03-0500 |
This property is not valid on a PUT or POST request. It is returned only by a verbose GET request. |
String |
Specifies the name of the namespace. HCP derives the hostname for the namespace from this name. The hostname is used in URLs for access to the namespace. In English, the name you specify for a namespace must be from one through 63 characters long and can contain only alphanumeric characters and hyphens (-) but cannot start or end with a hyphen. In other languages, because the derived hostname cannot be more than 63 characters long, the name you specify may be limited to fewer than 63 characters. Namespace names cannot contain special characters other than hyphens and are not case sensitive. White space is not allowed. Namespace names cannot start with xn-- (that is, the characters x and n followed by two hyphens). Namespace names must be unique for the owning tenant. Different tenants can have namespaces with the same name. You can reuse namespace names that are not currently in use. So, for example, if you delete a namespace, you can give a new namespace the same name as the one the deleted namespace had. The name of the default namespace is always Default. |
This property is required on a PUT request. The namespace name is used in the URL for access to the namespace. You can change the namespace name any time after you create the namespace, except while the HS3, CIFS, or NFS protocol is enabled for the namespace. However, when you change the name, the URL for the namespace may change as well. |
|
String |
For an HCP namespace, specifies the namespace owner. Valid values are: •If the owner has an HCP user account, the username for that account. •If the owner has an AD user account, the account username along with the name of the AD domain in which the account is defined, in this format: username@ad-domain-name If the namespace doesn’t have an owner, this property has no value. |
This property is optional on a PUT request. If this property is included on a PUT or POST request with a value that identifies an AD user account, the request must also include the ownerType property with a value of EXTERNAL. In response to a GET request, if the owner is an AD user and HCP cannot communicate with AD or cannot find the user account in AD, the value of this property is the security ID (SID) for the AD user account. This property is not valid for the default namespace. |
|
String |
For an HCP namespace, specifies the type of the user account that identifies the object owner. Valid values are: •LOCAL — The user account is defined in HCP. •EXTERNAL — The user account is defined in AD. The default is LOCAL. These values are not case sensitive. If the namespace doesn’t have an owner, this property has no value. |
This property is optional on a PUT request. You can specify a value for this property on a PUT or POST request only if you specify a value for the owner property in the same request. This property is not valid for the default namespace. |
|
String |
Specifies whether the namespace is optimized for cloud or optimized for all access protocols. The valid values are: •CLOUD - Enables cloud optimization •ALL - Enables all access protocols The default value is whatever value was configured on the system administrator set on the System Management Console. |
This property is optional on a PUT and POST request. This property is not valid for the default namespace |
|
Boolean |
Specifies whether read from replica is enabled for the namespace. Valid values are: •true — Read from replica is enabled. •false — Read from replica is disabled. On a PUT request to create an HCP tenant, the default is true if replicationEnabled is set to true in the same request; otherwise, the default is false. On a PUT request to create the default tenant and namespace, the default is true if the HCP system supports replication; otherwise, the default is false. |
This property is optional on a PUT request. You can set the value of this property to true on a PUT request only if, for an HCP namespace, the replicationEnabled property is set to true in the same request or, for the default namespace, the HCP system supports replication. On a POST request, you can set the value for this property to true for an HCP namespace only if the namespace is already selected for replication or the replicationEnabled property is set to true in the same request. You can set the value for this property to true for the default namespace only if the HCP system supports replication. This property is not returned by any GET request for an HCP namespace that is not selected for replication. This property is not returned by any GET request for the default namespace if the HCP system does not support replication, |
|
Boolean |
For an HCP namespace, specifies whether the namespace is selected for replication. Valid values are: •true — The namespace is selected for replication. •false — The namespace is not selected for replication. The default is the replication setting specified by the namespace defaults for the tenant. |
This property is optional on a PUT request. You can set the value of this property to true only if the owning tenant has replication configuration enabled. If the HCP system does not support replication, this property is not returned by any GET request. This property is not valid for the default namespace. If the HCP system supports replication, replication is automatically enabled for that namespace. |
|
String |
Specifies the oldest change time for objects and configuration changes not yet replicated or recovered from the namespace, as applicable, in this format: yyyy-MM-ddThh:mm:ssZ Z represents the offset from UTC, in this format: (+|-)hhmm For example: 2012-02-27T14:32:19-0500 |
This property is not valid on a PUT or POST request. It is returned only by a verbose GET request and only when these conditions are true: •The namespace is selected for replication. •The tenant that owns the namespace is included in a replication link. |
|
Boolean |
Specifies whether search is enabled for the namespace. Valid values are: •true — Search is enabled. •false — Search is disabled. The default is the search setting specified by the namespace defaults for the tenant. |
This property is optional on a PUT request. You can set the value of this property to true only if the owning tenant is allowed to enable search for its namespaces. Disabling search after it has been enabled: •Automatically disables indexing for the namespace. •Removes objects in the namespace from the metadata query engine index. If you subsequently reenable search for the namespace, the namespace must be reindexed from scratch. •Deletes the list of excluded annotations for the namespace. •Deletes all associations the namespace has with any content classes. |
|
String |
Specifies the service plan associated with the namespace. Valid values are names of existing service plans. The default is the service plan specified by the namespace defaults for the tenant. |
This property is valid on a PUT or POST request and returned by a GET request only if the owning tenant is allowed to select service plans for its namespaces. If valid, this property is optional on a PUT request. |
|
Boolean |
Specifies whether HCP can service HTTP requests against the namespace that are redirected from other HCP systems. Valid values are: •true — HCP can service requests against the namespace that are redirected from other systems. •false — HCP cannot service requests against the namespace that are redirected from other systems. The default is true. |
This property is optional on a PUT request. |
|
Integer |
For an HCP namespace, specifies the percentage point at which HCP notifies the tenant that free storage space for the namespace is running low. Valid values are integers in the range ten through 95. The default is the soft quota specified by the namespace defaults for the tenant. |
This property is optional on a PUT request. This property is not valid for the default namespace. |
|
List |
Associates zero, one, or more tags with the namespace. Each tag can be from one through 64 characters long and can contain any valid UTF-8 characters except commas (,). White space is allowed. |
This property is optional on a PUT request. For an existing namespace, the set of tags specified in the request body replaces the set of tags currently associated with the namespace. To remove all tags, specify an empty set. In XML, each listed tag is the value of an element named tag. In JSON, the name in the name/value pair that lists the tags is tag. This property is not valid for the default namespace. |
|
versioning |
For an HCP namespace, specifies the versioning settings for the namespace. If this property is omitted on a PUT request, the default is the versioning settings specified by the namespace defaults for the tenant. For details, see versioningSettings. |
This property is optional on a PUT request. If this property is included on a PUT request and the owning tenant is not allowed to set versioning for its namespaces, the value of the enabled property for versioningSettings, if specified, must be false. This property is not valid on a POST request and is not returned by a GET request. To modify or retrieve the versioning settings for a namespace, use the namespace versioning-Settings resource. This property is not valid for the default namespace. You cannot enable versioning for a namespace while the CIFS, NFS, WebDAV, or SMTP protocol or appendable objects are enabled. |
© 2015 Hitachi Data Systems Corporation. All rights reserved.