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

GetKxDatabase

Returns database information for the specified environment ID.

Request Syntax


GET /kx/environments/environmentId/databases/databaseName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

databaseName

The name of the kdb database.

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

Required: Yes

environmentId

A unique identifier for the kdb environment.

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

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdTimestamp": number,
   "databaseArn": "string",
   "databaseName": "string",
   "description": "string",
   "environmentId": "string",
   "lastCompletedChangesetId": "string",
   "lastModifiedTimestamp": number,
   "numBytes": number,
   "numChangesets": number,
   "numFiles": number
}

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.

createdTimestamp

The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Type: Timestamp

databaseArn

The ARN identifier of the database.

Type: String

databaseName

The name of the kdb database for which the information is retrieved.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

description

A description of the database.

Type: String

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

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

environmentId

A unique identifier for the kdb environment.

Type: String

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

Pattern: .*\S.*

lastCompletedChangesetId

A unique identifier for the changeset.

Type: String

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

Pattern: ^[a-zA-Z0-9]+$

lastModifiedTimestamp

The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Type: Timestamp

numBytes

The total number of bytes in the database.

Type: Long

numChangesets

The total number of changesets in the database.

Type: Integer

numFiles

The total number of files in the database.

Type: Integer

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

InternalServerException

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

HTTP Status Code: 500

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