Resources

The main types of HCP management API resources are tenants, namespaces, retention classes, content classes, user accounts, group accounts, and replication. Each main type of resource is associated with a set of resource identifiers, each of which identifies one of these:

A list of resources of that type

An instance of that type of resource

A property of that type of resource that’s treated as a resource in its own right

A resource identifier is the portion of a resource URL that follows mapi. For information on resource URLs, see URLs for HCP access through the management API.

For each main type of resource, this chapter contains a table of the associated resource identifiers. For each resource identifier, the applicable table shows:

The data type of the resource when you use the resource in conjunction with a specific method. For information on data types that are sets of properties, see Data types.

The methods supported by the resource. Because all resources support the OPTIONS method, this method is not included in the tables.

The use for each supported method.

The type of account required for access to the resource with each supported method.

Note: Where the tables in this chapter specify that a tenant-level user account is required, you can also use a system-level user account if the tenant has granted system-level users administrative access to itself. Additionally, in this case, when you use a system-level user account to retrieve information about the tenant, you get both the system-level and tenant-level tenant properties.

Any additional notes about the resource.

This chapter also contains examples of using the management API to manipulate resources. Each example consists of:

The curl command for the sample request

The Python code for the sample request

The HTTP request headers

The HTTP response headers

The request or response body, as applicable, in XML

Note: Each example in this chapter stands on its own. The requirements for executing each example are outlined in its initial description.  All the examples assume an HCP system that supports Active Directory, includes the replication feature, and has virtual network management enabled.

Additionally, this chapter contains instructions for paging through, sorting, and filtering the results of GET requests for tenants, namespaces, user accounts, and data access permissions.

Trademarks and Legal Disclaimer

© 2017 Hitachi Data Systems Corporation. All rights reserved.