HCP System Management Help
Namespace resources let you create, retrieve information about, modify, and delete namespaces. The table below provides information about these resources.
Data type |
Method |
Use |
Access |
Notes |
---|---|---|---|---|
namespace |
Create an HCP namespace |
Tenant-level user account with the administrator role or allow namespace management property |
|
|
List |
Retrieve a list of the namespaces owned by a tenant |
•For an HCP tenant, tenant-level user account with the monitor, administrator, or compliance role or allow namespace management property •For the default tenant, system-level user account with the monitor or administrator role |
The listed namespaces are identified by namespace name. In XML, each listed namespace is the value of an element named name. In JSON, the name in the name/value pair that lists the namespaces is name. For a user with the allow namespace management property and no roles, the retrieved list includes only the namespaces the user owns. |
|
namespace |
Retrieve information about a namespace |
•For an HCP namespace, tenant-level user account with the monitor or administrator role or allow namespace management property •For the default namespace, system-level user account with the monitor or administrator role |
A user with the allow namespace management property and no roles can retrieve information only about the namespaces the user owns. In this case, the retrieved information includes only the namespace name and owner. |
|
N/A |
Check for the existence of a namespace |
•For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role or allow namespace management property •For the default namespace, system-level user account with the monitor or administrator role |
|
|
namespace |
Modify a namespace |
•For an HCP namespace, tenant-level user account with the administrator role •For the default namespace, system-level user account with the administrator role |
For information on query parameters for resetting indexing checkpoints, see Query parameter for restarting indexing. |
|
N/A |
Delete an HCP namespace |
Tenant-level user account with the administrator role or allow namespace management property |
A user with the allow namespace management property and no roles can delete only the namespaces the user owns. The namespace cannot contain any objects. Not valid for the default namespace. |
|
String |
GET |
Retrieve information about whether a namespace is optimized for all access protocols or for optimized for cloud protocols only. |
•For an HCP namespace, tenant-level user account with the administrator role |
The default setting is to optimized for all protocols unless a user with the administrator role changed the setting on the System Management Console. |
.../tenants/tenant-name/namespaces/namespace-name/chargebackReport |
||||
chargeback |
Generate a chargeback report for a namespace |
Tenant-level user account with the monitor or administrator role |
Not valid for the default namespace. Supported output formats are XML, JSON, and CSV. For information on optional query parameters for generating chargeback reports, see Query parameters for generating chargeback reports. For information on chargeback reports, see About chargeback reports. |
|
.../tenants/tenant-name/namespaces/namespace-name/complianceSettings |
||||
compliance |
Retrieve the default retention, shred, custom metadata handling, and disposition settings for a namespace |
•For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role •For the default namespace, system-level user account with the monitor, administrator, or compliance role |
Default retention and shred settings do not apply to the default namespace. |
|
Modify the default retention, shred, custom metadata handling, or disposition setting for a namespace |
•For an HCP namespace, tenant-level user account with the compliance role •For the default namespace, system-level user account with the compliance role |
|||
.../tenants/tenant-name/namespaces/namespace-name/ |
||||
custom |
Retrieve settings specific to metadata query engine indexing of custom metadata for a search-enabled namespace |
•For an HCP namespace, tenant-level user account with the monitor or administrator role •For the default namespace, system-level user account with the monitor or administrator role |
Not valid for namespaces that do not have search enabled. |
|
Modify settings specific to metadata query engine indexing of custom metadata for a search-enabled namespace |
•For an HCP namespace, tenant-level user account with the administrator role •For the default namespace, system-level user account with the administrator role |
|||
.../tenants/tenant-name/namespaces/namespace-name/permissions |
||||
List |
Retrieve the list of permissions in the data access permission mask for a namespace |
•For an HCP namespace, tenant-level user account with the monitor or administrator role •For the default namespace, system-level user account with the monitor or administrator role |
For the format of the permission list, seePermission lists. |
|
List |
Modify the list of permissions in the data access permission mask for a namespace |
•For an HCP namespace, tenant-level user account with the administrator role •For the default namespace, system-level user account with the administrator role |
Valid values for permissions are: •DELETE •PRIVILEGED •PURGE •READ •SEARCH •WRITE These values are case sensitive. For the format of the permission list, see Permission lists. The set of permissions specified in the request body replaces the set of permissions currently included in the data access permission mask for the namespace. To remove all permissions, specify an empty list. If the set of permissions includes PURGE, delete permission is enabled automatically. If the set of permissions includes SEARCH, read permission is enabled automatically. By default, when you create a namespace, its data access permission mask includes all permissions. |
|
protocols |
Retrieve a subset of the HTTP namespace access protocol settings for the default namespace |
System-level user account with the monitor or administrator role |
Not valid for HCP namespaces. For HCP namespaces, this resource has been superseded by the .../protocols/http resource. |
|
Modify a subset of the HTTP namespace access protocol settings for the default namespace |
System-level user account with the administrator role |
|||
.../tenants/tenant-name/namespaces/namespace-name/protocols/protocol-name |
||||
Determined by protocol-name. Possible data types are: cifsProtocol |
Retrieve the applicable namespace access protocol settings for a namespace |
Tenant-level user account with the monitor or administrator role |
Not valid for the default namespace. Valid values for protocol-name are: •cifs •http •nfs •smtp These values are case sensitive. The httpProtocol data type includes properties for both the HTTP and WebDAV protocols. |
|
Modify the applicable namespace access protocol settings for a namespace |
Tenant-level user account with the administrator role |
|||
.../tenants/tenant-name/namespaces/namespace-name/replicationCollisionSettings |
||||
replication |
Retrieve the replication collision handling settings for a namespace |
•For an HCP namespace, tenant-level user account with the monitor or administrator role •For the default namespace, system-level user account with the monitor or administrator role |
|
|
Modify the replication collision handling settings for a namespace |
•For an HCP namespace, tenant-level user account with the administrator role •For the default namespace, system-level user account with the administrator role |
|
||
.../tenants/tenant-name/namespaces/namespace-name/statistics |
||||
statistics |
Retrieve information about the content of a namespace |
•For an HCP namespace, tenant-level user account with the monitor or administrator role •For the default namespace, system-level user account with the monitor or administrator role |
|
|
.../tenants/tenant-name/namespaces/namespace-name/versioningSettings |
||||
versioning |
Retrieve the versioning settings for a namespace |
Tenant-level user account with the monitor or administrator role or the allow namespace management property |
A user with the allow namespace management property and no roles can retrieve and modify only the versioning enabled property and that property only for the namespaces the user owns. Not valid for the default namespace. |
|
Modify the versioning settings for a namespace |
Tenant-level user account with the administrator role or the allow namespace management property |
Trademarks and Legal Disclaimer
© 2017 Hitachi Vantara Corporation. All rights reserved.