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

GetKxScalingGroup

Retrieves details of a scaling group.

Request Syntax


GET /kx/environments/environmentId/scalingGroups/scalingGroupName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

environmentId

A unique identifier for the kdb environment.

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

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

Required: Yes

scalingGroupName

A unique identifier for the kdb scaling group.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "availabilityZoneId": "string",
   "clusters": [ "string" ],
   "createdTimestamp": number,
   "hostType": "string",
   "lastModifiedTimestamp": number,
   "scalingGroupArn": "string",
   "scalingGroupName": "string",
   "status": "string",
   "statusReason": "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.

availabilityZoneId

The identifier of the availability zones.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 12.

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

clusters

The list of Managed kdb clusters that are currently active in the given scaling group.

Type: Array of strings

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

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

createdTimestamp

The timestamp at which the scaling group was 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

hostType

The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

It can have one of the following values:

kx.sg.large – The host type with a configuration of 16 GiB memory and 2 vCPUs.
kx.sg.xlarge – The host type with a configuration of 32 GiB memory and 4 vCPUs.
kx.sg.2xlarge – The host type with a configuration of 64 GiB memory and 8 vCPUs.
kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.

Type: String

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

Pattern: ^[a-zA-Z0-9._]+

lastModifiedTimestamp

The last time that the scaling group was updated 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

scalingGroupArn

The ARN identifier for the scaling group.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:*:*:*:*:*

scalingGroupName

A unique identifier for the kdb scaling group.

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]$

status

The status of scaling group.

CREATING – The scaling group creation is in progress.
CREATE_FAILED – The scaling group creation has failed.
ACTIVE – The scaling group is active.
UPDATING – The scaling group is in the process of being updated.
UPDATE_FAILED – The update action failed.
DELETING – The scaling group is in the process of being deleted.
DELETE_FAILED – The system failed to delete the scaling group.
DELETED – The scaling group is successfully deleted.

Type: String

statusReason

The error message when a failed state occurs.

Type: String

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

Pattern: ^[a-zA-Z0-9\_\-\.\s]+$

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