finspace / Client / get_kx_scaling_group

get_kx_scaling_group#

finspace.Client.get_kx_scaling_group(**kwargs)#

Retrieves details of a scaling group.

Request Syntax

response = client.get_kx_scaling_group(
    environmentId='string',
    scalingGroupName='string'
)

Parameters:

environmentId (string) –
[REQUIRED]

A unique identifier for the kdb environment.
scalingGroupName (string) –
[REQUIRED]

A unique identifier for the kdb scaling group.

Return type:

dict

Returns:

Response Syntax

{
    'scalingGroupName': 'string',
    'scalingGroupArn': 'string',
    'hostType': 'string',
    'clusters': [
        'string',
    ],
    'availabilityZoneId': 'string',
    'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED'|'DELETE_FAILED',
    'statusReason': 'string',
    'lastModifiedTimestamp': datetime(2015, 1, 1),
    'createdTimestamp': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- scalingGroupName (string) –
  
  A unique identifier for the kdb scaling group.
- scalingGroupArn (string) –
  
  The ARN identifier for the scaling group.
- hostType (string) –
  
  The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
- clusters (list) –
  
  The list of Managed kdb clusters that are currently active in the given scaling group.
  - (string) –
- availabilityZoneId (string) –
  
  The identifier of the availability zones.
- status (string) –
  
  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.
- statusReason (string) –
  
  The error message when a failed state occurs.
- lastModifiedTimestamp (datetime) –
  
  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.
- createdTimestamp (datetime) –
  
  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.

Exceptions

finspace.Client.exceptions.InternalServerException
finspace.Client.exceptions.ValidationException
finspace.Client.exceptions.ThrottlingException
finspace.Client.exceptions.AccessDeniedException
finspace.Client.exceptions.LimitExceededException
finspace.Client.exceptions.ConflictException
finspace.Client.exceptions.ResourceNotFoundException