Create an access pool

Create an access pool in the system.

Request

Security

Table 1. Roles capable of executing the Create Access Pool API method
Any	Super User	System Admin	Security Admin	Operator
	superUser	systemAdmin

HTTP method

Edit online


POST /manager/api/{apiResponseType}/1.0/createAccessPool.adm HTTP/1.1
Host:{manager.dsnet} name={accessPoolName}
     &accessDeviceIds={aId1}
     &accessDeviceIds={aId2}
     &accessDeviceIds={aId3}
     &vaultIds={vId1}&vaultIds={vId2}
     &vaultIds={vId3}
     &vaultIds={vId4}
     &mirrorIds={mId1}
     &mirrorIds={mId2}
     &mirrorIds={mId3}
     &mirrorIds={mId4}
     &protocolType={s3|soh}
     &description={description!}
     &accessServicePorts[https]={443|8443}
     &accessServicePorts[http]={80|8080}
     &s3VirtualHostSuffix={s3VirtualHostSuffix}
     &additionalSubjectAltNames={additionalSubjectAltNames}
     &includeDefaultIpsInAltNames={true|false}
     &privateKeyPem={privateKeyPem}
     &certificatePem={certificatePem}

Curl method

Edit online


curl -X 
POST -u admin:password 
     --header ”Content-Type: application/x-www-form-urlencoded“
     --header ”Accept: application/json“ 
     -k 'https://{manager.dsnet}/manager/api/json/1.0/createAccessPool.adm' 
     -d 'name={accessPoolName}&accessDeviceIds={aId1}
                              &accessDeviceIds={aId2}
                              &accessDeviceIds={aId3}
                              &vaultIds={vId1}
                              &vaultIds={vId2}
                              &vaultIds={vId3}
                              &vaultIds={vId4}
                              &mirrorIds={mId1}
                              &mirrorIds={mId2}
                              &mirrorIds={mId3}
                              &mirrorIds={mId4}
                              &protocolType={s3|soh}
                              &description={description!}
                              &accessServicePorts[https]={443|8443}
                              &accessServicePorts[http]={80|8080}
                              &s3VirtualHostSuffix={s3VirtualHostSuffix}
                              &additionalSubjectAltNames={additionalSubjectAltNames}
                              &includeDefaultIpsInAltNames={true|false}
                              &privateKeyPem={privateKeyPem}
                              &certificatePem={certificatePem}
                              '

Parameters

Edit online

Table 2. Request Parameters for Create Access Pool (createAccessPool) API method
Parameter	Type	Usage	Default	Description
name	String	Required		Name to assign to new Access Pool Maximum length is 255 characters
accessDeviceIds	Long[]	Optional		List of Accesser® Appliance IDs to create Access Pool
vaultIds	Long[]	Optional		List of Vault IDs to create Access Pool
mirrorIds	Long[]	Optional		List of Mirror IDs to create Access Pool
protocolType	String	Required		API type to set for Access Pool: s3 or soh When the system is in container mode, the Simple Object API Type is not supported. Note: Only S3 is supported for protection.
description	String	Optional		The description to use with the Access Pool
accessServicePorts	Map	Optional		The complete set of Accesser device service ports (the ports on which the Accesser® Appliance is listening). Ports must be one of 80, 443, 8080 , 8443, 8337, or 8338 (Container Mode only)
s3VirtualHostSuffix	String	Optional		The S3 Virtual Host Suffix is required when virtual host style addressing is used. The specified value should match the DNS entry that is routing requests to the Accesser nodes.
staticWebsiteVirtualHostSuffix	String	Optional		If Static Website Hosting is wanted, specify the Static Website Virtual Host Suffix. Static Website Hosting must be enabled on one or more vaults. Vaults must have DNS-compliant names.
additionalSubjectAltNames	String	Optional		By default, Accesser® Node certificates contain the Accesser® Node' IP(s) and hostname. This field should be used when additional subject alternative names are required. Example: IP:{IP-address-1},IP:{IP-address-2},DNS:{dns-name-1},DNS:{dns-name-2}
includeDefaultIpsInAltNames	Boolean	Optional	`true`	If the External PKI feature is being used and the certificate is being signed by a commercial certificate authority, it may not be possible to include the Accesser® Node IP(s) in the certificate. In this case, this parameter should be set to false to avoid a failure when the certificate is loaded into the Manager.
defaultProvisioningCodeId	Long	Optional		The manager generated id of a deployed Container Vault. This vault that is used for container creation when a LocationConstraint is not provided during PUT bucket requests. If no default is set, the LocationConstraint is a required parameter in the PUT bucket request. Container Mode only.
managementVaultId	Long	Management Vault Configuration = manual		Devices in storage pools must be set at the storage pool level. Accesser® Appliances and Manager Appliances can still be set individually.
privateKeyPem	String	Optional		The trusted external private key that is associated with the external certificate(s)
certificatePem	String	Optional		The certificate(s) associated with the private key. Enter the host certificate and any intermediary CA certificates up to the root CA

Response

Edit online

Returns success or failure status. On success, returns Manager-generated ID of the created access pool.

JSON response example

Edit online

{
 ”responseStatus“:”ok“,
 ”responseHeader“:{
  ”status“:”ok“,
  ”now“:{milliseconds from the UNIX epoch},
  ”requestId“:”Uxn0nMCoDkMAAENvDKUAAADJ“
 },
 ”responseData“:{
  ”id“:9
 }
}

Parameters

Edit online

Table 3. Response Parameters for Create Access Pool (createAccessPool) API method
Parameter	Type	Description
id	Long	ID of the new access pool.