Enable container mode

Converts the vaults deployed to an access pool to container vaults.

Request

Security

Table 1. Roles capable of executing the Enable Container Mode (systemContainerModeConfiguration.adm)API method
Any	Super User	System Admin	Security Admin	Operator
	superUser	systemAdmin

HTTP method

Edit online


POST /manager/api/{apiResponseType}/1.0/systemContainerModeConfiguration.adm HTTP/1.1 
     Host:{manager.dsnet} enable=[true|false]&accessPoolIds={ID1}[&accessPoolIds={IDn}]

Curl method

Edit online


curl -u {username}:{password}  
     -k 'https://{manager.dsnet}/manager/api/{apiResponseType}/1.0
        /systemContainerModeConfiguration.adm' 
     -d 'enable=[true|false]&accessPoolIds={ID1}[&accessPoolIds={IDn}]'

Parameters

Edit online

Table 2. Request parameters for Enable Container Mode (systemContainerModeConfiguration) API method
Parameter	Type	Usage	Default	Description
enable	Boolean	Optional	true	Flag representing whether container mode should be enabled (true) or disabled (false).
acccessPoolIds	List	Required		List of access pool IDs on which to enable Container Mode.

Response

Edit online

On success, the default JSON example response is returned.

However, on failure, one of two responses is returned as shown in JSON response example.

JSON response example

Edit online

The following example is identical to the default JSON failure response, and is returned if there's a simple error.

{
"responseStatus":"fail",
"responseHeader": {
    "now":1588369433692,
    "status":"fail",
    "requestId":"XqyYGQqMZFgAAFKxEFQAAACN"
  },
"responseData": {
    "errors":[
        {
           "field":"accessPoolIds",
           "code":"accessPoolIds.invalid",
           "message":"An access pool with the id 987654321 could not be found"
        },
        {
           "field":"accessPoolIds",
           "code":"accessPoolIds.invalid",
           "message":"An access pool with the id 123456789 could not be found"
        }
     ]
  }
}

The following JSON might be returned if there are more complex validation errors enabling container mode. Each object in the validationErrors array has a category, rule, and an array of objects that are violating the rule, if necessary. Inside the "objects" array are details of each object that is violating the rule. For instance in the above JSON, there is an access pool (id=8) that has an improper API type. All of these errors must be resolved before container mode can be enabled.

{
   "responseStatus": "fail",
   "responseHeader": {
     "now": 1465840430014,
     "status": "fail",
     "requestId": null
   },
   "responseData": {
     "validationErrors": [
       {
         "category": "Vault Existence",
         "rule": "Only service or management vaults may exist",
         "objects": []
       },
       {
         "category": "API",
         "rule": "access pool(s) must change its API type to 'Cloud Storage Object'",
         "objects": [
           {
             "type": "accessPool",
             "id": 8,
             "name": "Access Pool 3"
           }
         ]
       },
       {
         "category": "Mirror",
         "rule": "Container Mode not supported on dsNets with mirrors",
         "objects": []
       }
     ],
     "migrationErrors": []
   }
 }