Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListKxVolumes

Lists all the volumes in a kdb environment.

Request Syntax


GET /kx/environments/environmentId/kxvolumes?maxResults=maxResults&nextToken=nextToken&volumeType=volumeType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

environmentId

A unique identifier for the kdb environment, whose clusters can attach to the volume.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-z0-9]+$

Required: Yes

maxResults

The maximum number of results to return in this request.

Valid Range: Minimum value of 0. Maximum value of 100.

nextToken

A token that indicates where a results page should begin.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

volumeType

The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

Valid Values: NAS_1

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "kxVolumeSummaries": [ 
      { 
         "availabilityZoneIds": [ "string" ],
         "azMode": "string",
         "createdTimestamp": number,
         "description": "string",
         "lastModifiedTimestamp": number,
         "status": "string",
         "statusReason": "string",
         "volumeName": "string",
         "volumeType": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

kxVolumeSummaries

A summary of volumes.

Type: Array of KxVolume objects

nextToken

A token that indicates where a results page should begin.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There was a conflict with this action, and it could not be completed.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

LimitExceededException

A service limit or quota is exceeded.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400