HCP System Management Help


JSON

In a JSON request or response body:

Properties are name/value pairs. For example, the name/value pair that corresponds to the softQuota property with a value of 85 is:

"softQuota":"85"

A list of resources is represented by a name/value pair, where the name is the name of the property used to identify each resource and the value is a comma-separated list of the resource identifiers. For example, the response body for a request to list the tenants defined in an HCP system might look like this:

{
    "name" : [ "Default", "Finance", "HR", "Sales", "Marketing" ]
}

Here’s a request for complete information about the Finance tenant to be returned in JSON format:

curl -k -i -H "Accept: application/json"
    -H "Authorization: HCPm9sZXM=:04EC9F614D89FF5C7126D32ACB448382"
    "https://admin.hcp.example.com:9090/mapi/tenants/finance?verbose=true
         &prettyprint"

Assuming that the tenant has granted system-level users administrative access to itself, here’s the JSON response body you get when you make the request using a system-level user account that includes the administrator role:

{
    "administrationAllowed" : true,
    "authenticationTypes" : {
        "authenticationType" : [ "LOCAL", "EXTERNAL" ]
    },
    "complianceConfigurationEnabled" : true,
    "creationTime" : "2012-02-09T09:11:17-0500",
    "dataNetwork" : "net127",
    "fullyQualifiedName" : "finance.hcp.example.com",
    "hardQuota" : "100.00 GB",
    "managementNetwork" : "net004",
    "maxNamespacesPerUser" : 5,
    "name" : "Finance",
    "namespaceQuota" : "5",
    "replicationConfigurationEnabled" : true,
    "snmpLoggingEnabled" : false,
    "searchConfigurationEnabled" : true,
    "servicePlan" : "Short-Term-Activity",
    "servicePlanSelectionEnabled" : false,
    "softQuota" : 90,
    "syslogLoggingEnabled" : true,
    "systemVisibleDescription" : "Created for the Finance department at Example
        Company by P.D. Grey on 2/9/2012.",
    "tags" : {
        "tag" : [ "Example Company", "pdgrey" ]
    },
    "tenantVisibleDescription" : "Please see Lee Green for any questions about this
        tenant and its namespaces.",
    "id" : "4420f62f-3f63-43ab-a3cd-0bcf1f399daf",
    "versioningConfigurationEnabled" : true
}

© 2017 Hitachi Vantara Corporation. All rights reserved.