Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Resources


The main types of HCP management API resources are tenants, namespaces, networks, retention classes, content classes, system-level user accounts, tenant-level user accounts, tenant-level group accounts, replication, erasure coding topologies, licenses, internal logs, and health check reports. 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 section of the Help 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.

NoteWebHelp.png

Note: Where the tables in this section of the Help 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 section of the Help also contains examples of using the management API to manipulate resources. These examples can include:

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

NoteWebHelp.png

Note: Each example in this section of the Help 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 and has virtual network management enabled.

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

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.


 

  • Was this article helpful?