namespace

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The namespace data type describes the namespaces resource.

Properties

The table below describes the properties included in the namespace data type.

Property Data type Description Notes
aclsUsage 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.

These values are not case sensitive.

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.

allowErasureCoding Boolean

For an HCP namespace, specifies whether HCP is allowed to use erasure coding to implement replication of the objects in the namespace. Valid values are:

true
HCP is allowed to use erasure coding for replication of the namespace.
false
HCP is not allowed to use erasure coding for replication of the namespace.

If the tenant is allowed to manage erasure coding for namespaces, the default is the setting specified by the namespace defaults for the tenant. If the tenant does not have this ability, the default is to allow erasure coding for namespaces that are cloud optimized.

This property is valid on a PUT or POST request only if the owning tenant is allowed to manage erasure coding for its namespaces.

This property is optional on a PUT request.

You can set the value of this property to true on a PUT request only if the value of the optimizedFor property is set to true in the same request or if new namespaces are cloud optimized by default.

You can set the value of this property to true on a POST request only if the namespace is already cloud optimized or the optimizedFor property is set to true in the same request.

This property is not returned by any GET request for a namespace that is not selected for replication or for which the owning tenant is not allowed to manage erasure coding for its namespaces.

This property is not valid for the default namespace.

allowPermissionAnd OwnershipChanges 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.

appendEnabled 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.

Note: The appendable-object feature provides snaplock volume support for third-party backup solutions. Do not enable this feature unless you have been explicitly told to do so.

atimeSynchronization Enabled 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.

authAndAnonymous MinimumPermissions 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.

These values are not case sensitive.

This property is optional on a PUT request.

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.

authMinimum Permissions 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.

These values are not case sensitive.

This property is optional on a PUT request.

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.

authUsersAlwaysGranted AllPermissions 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.

creationTime 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:

2017-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.
customMetadata IndexingEnabled 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.

customMetadata ValidationEnabled 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.
description 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.

This property is optional on a PUT request.
directoryUsage String

Specifies whether the cloud optimized namespace is configured for balanced directory mode or unbalanced directory mode. Valid values are:

Balanced
The directory usage is configured for balanced mode. A well distributed directory structure is required to avoid hot spotting and ensure optimal performance.
Unbalanced
The directory usage is configured for unbalanced mode. Optimal performance is not dependent upon a directory structure.

The default is specified by the namespace defaults for the tenant. These values are not case sensitive.

 
dpl 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.

enterpriseMode 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.

fullyQualifiedName 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.
hardQuota 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.

hashScheme String

Specifies the cryptographic hash algorithm for the namespace. Valid values are:

  • MD5
  • SHA-1
  • SHA-256
  • SHA-384
  • SHA-512
  • RIPEMD-160

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.
id 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.
indexingDefault 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.

indexingEnabled 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 the searchEnabled property 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.

isDplDynamic 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:

2017-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.
multipartUploadAuto AbortDays Integer

For an HCP namespace, specifies the number of days multipart uploads can remain incomplete before they are automatically aborted. Valid values are integers in the range zero through 180. The default is 30.

A value of zero means multipart uploads are never automatically aborted.

This property is optional on a PUT request.

This property is not valid for the default namespace.

name 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 S3 compatible, CIFS, or NFS protocol is enabled for the namespace. However, when you change the name, the URL for the namespace may change as well.

optimizedFor String

For an HCP namespace, specifies whether the namespace is optimized for cloud protocols only or optimized for all namespace access protocols. Valid values are:

CLOUD
Optimizes the namespace for cloud protocols only
ALL
Optimizes the namespace for all namespace access protocols

The default is specified by the namespace defaults for the tenant.

These values are not case sensitive.

This property is optional on a PUT request.

You can set this property to ALL on a POST request only if the namespace already does not allow erasure coding or the allowErasureCoding property is set to false in the same request.

This property is not valid for the default namespace

owner 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.

ownerType 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.

readFromReplica 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, the default is true if replicationEnabled is set to true in the same request; 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.

replicationEnabled 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 replication is enabled for the owning tenant.

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.

replicationTimestamp 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.

retentionType String Specifies the retention type to be applied to all objects in the namespace. Valid values are:
HCP
HCP retention type
S3
S3 Object Lock

Default value is HCP retention.

When you set the retentionType to S3 Object Lock in a MAPI request for a namespace, versioning, delete markers, and cloud-optimized protocols are automatically enabled. You do not need to set these parameters explicitly.
s3UnversionedOverwrite Boolean

Specifies whether object overwrite is enabled for the namespace. Valid values are:

true
Object overwrite is enabled.
false
Object overwrite is disabled.

The default is false.

You can set the value of this property to either true or false. However, if you enable versioning for the namespace, changing the value will not have any effect. This property applies only to the requests made through Hitachi API for Amazon S3.

Overwriting an object will also overwrite its custom metadata.

searchEnabled 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.
servicePlan 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.

serviceRemoteSystemRequests

Boolean

Specifies whether HCP can service HTTP-based data access 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.
softQuota 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.

tags 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.

Tags are not case sensitive.

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, the element that identifies each tag is 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.

versioningSettings

versioning

Settings

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.

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.

Query parameter for restarting indexing

While search is enabled for a namespace, you can restart metadata query engine indexing of the namespace from the time the namespace was created or from a specified date. To do this, you use this query parameter:

resetMQECheckpoint=(mm/dd/yyyy|0)

The value 0 (zero) restarts indexing from the time the namespace was created.

You use the resetMQECheckpoint query parameter with a POST request against the namespace resource.

Here’s a sample POST request that restarts metadata query engine indexing of the accounts-receivable namespace from the time the namespace was created:

curl -k -i -d "<namespace/>" -H "Content-Type: application/xml"
    -H "Authorization: HCP bGdyZWVu:a3b9c163f6c520407ff34cfdb83ca5c6"
    "https://finance.hcp.example.com:9090/mapi/tenants/finance/namespaces/
     accounts-receivable?resetMQECheckpoint=0”

Example

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

<namespace>
    <aclsUsage>ENFORCED</aclsUsage>
    <authUsersAlwaysGrantedAllPermissions>true
    </authUsersAlwaysGrantedAllPermissions>
    <allowPermissionAndOwnershipChanges>true
    </allowPermissionAndOwnershipChanges>
    <appendEnabled>false</appendEnabled>
    <atimeSynchronizationEnabled>false</atimeSynchronizationEnabled>
    <authMinimumPermissions>
        <permission>BROWSE</permission>
        <permission>READ</permission>
        <permission>WRITE</permission>
    </authMinimumPermissions>
    <creationTime>2017-02-09T15:42:36-0500</creationTime>
    <customMetadataIndexingEnabled>true</customMetadataIndexingEnabled>
    <customMetadataValidationEnabled>true</customMetadataValidationEnabled>
    <description>Created for the Finance department at Example Company by Lee
        Green on 2/9/2017.</description>
    <dpl>Dynamic</dpl>
    <enterpriseMode>true</enterpriseMode>
    <allowErasureCoding>true</allowErasureCoding>
    <fullyQualifiedName>Accounts-Receivable.Finance.hcp.example.com
    </fullyQualifiedName>
    <hardQuota>50 GB</hardQuota>
    <hashScheme>SHA-256</hashScheme>
    <indexingDefault>true</indexingDefault>
    <indexingEnabled>true</indexingEnabled>
    <isDplDynamic>true</isDplDynamic>
    <mqeIndexingTimestamp>2017-02-26T18:11:13-0400</mqeIndexingTimestamp>
    <multipartUploadAutoAbortDays>30</multipartUploadAutoAbortDays>
    <name>Accounts-Receivable</name>
    <optimizedFor>CLOUD</optimizedFor>
    <owner>pblack</owner>
    <ownerType>LOCAL</ownerType>
    <readFromReplica>true</readFromReplica>
    <replicationEnabled>true</replicationEnabled>
    <replicationTimestamp>2017-02-27T06:45:52-0500</replicationTimestamp>
    <searchEnabled>true</searchEnabled>
    <servicePlan>Short-Term-Activity</servicePlan>
    <serviceRemoteSystemRequests>true</serviceRemoteSystemRequests>
    <softQuota>75</softQuota>
    <s3UnversionedOverwrite>false</s3UnversionedOverwrite>
    <tags>
        <tag>Billing</tag>
        <tag>lgreen</tag>
    </tags>
    <id>0e774b8d-8936-4df4-a352-b68766b5c287</id>
    <authAndAnonymousMinimumPermissions>
        <permission>BROWSE</permission>
        <permission>READ</permission>
    </authAndAnonymousMinimumPermissions>
</namespace>