Request specific query parameters

Some requests take query parameters that provide additional information to HCP about the operation you want to perform or that request a particular operation. The table below lists these requests and the query parameters they take.

Request

Parameters

More information

PUT to create an HCP tenant

username=username
password=password
forcePasswordChange=(true|false)
initialSecurityGroup=group-name

HCP tenant query parameters

PUT to create the default tenant and namespace

enterpriseMode=(true|false)
hashScheme=hash-algorithm
searchEnabled=(true|false)
servicePlan=service-plan-name

Default tenant query parameters

POST to change the password for a locally authenticated system-level user account

password=password

System-level user account resource

PUT or POST to create or modify a tenant-level user account

password=password

Query parameter for setting user account passwords

POST to reset the security user passwords for a tenant

resetPasswords=password

Query parameter for resetting security user passwords

POST to reset the security group for a tenant

resetSecurityGroup=group-name

Query parameter for resetting the security group

POST to reset the indexing checkpoint for a namespace

resetMQECheckpoint=
(mm/dd/yyyy|0)

Query parameter for restarting indexing

POST to perform an action on all replication links

shutDownAllLinks=reason
reestablishAllLinks

Query parameters for replication service actions

POST to perform an action on a replication link

suspend
resume
failOver
failBack
restore
beginRecovery
completeRecovery

Query parameters for replication link actions

POST to perform an action on a replicating tenant

pause
resume

Query parameters for replication link content tenant actions

GET to retrieve a limited number of tenants, namespaces, user accounts, or namespaces for which a given user or group account has any data access permissions

offset=offset
count=count

Paging through the resource lists

GET to retrieve a sorted list of tenants, namespaces, user accounts, or namespaces for which a given user or group account has any data access permissions

sortType=property-name
sortOrder=(ascending|descending)

Sorting resource lists

GET to retrieve a filtered list of tenants, namespaces, user accounts, or namespaces for which a given user or group account has any data access permissions

filterType=filter-type
filterString=text-string

Filtering resource lists

GET for tenant and namespace chargeback reports

start=start-time
end=end-time
granularity=reporting-interval

Query parameters for generating chargeback reports

When the only action you’re requesting in a POST request for a resource other than a replication resource is specified by a query parameter, you need to provide an empty request body. With cURL, you specify this body as the argument for the -d option in the request:

With a content type of XML, the argument is an empty root element for the resource being modified, enclosed in double quotation marks, like this:

-d "<root-element/>"

For example, here’s a request to change only the password for the user account with the username mwhite:

curl -k -i -d "<userAccount/>" -H "Content-Type: application/xml"
-H "Authorization: HCP bGdyZWVu:a3b9c163f6c520407ff34cfdb83ca5c6"
"https://finance.hcp.example.com:9090/mapi/tenants/finance/
userAccounts/mwhite?password=p4ssw0rd"

With a content type of JSON, the argument is an empty pair of curly braces enclosed in double quotation marks, like this:

-d "{}"

POST requests to perform actions on replication resources do not take a request body, empty or otherwise.

Trademarks and Legal Disclaimer

© 2016 Hitachi Data Systems Corporation. All rights reserved.