describeResourceGroup()

This operation describes a specific resource group.

public DescribeResourceGroupResp describeResourceGroup(DescribeResourceGroupReq request)

Request Syntax

describeResourceGroup(DescribeResourceGroupReq.builder()
    .groupName(String groupName)
    .build()
)

BUILDER METHODS:

• groupName(String collectionName)

  [REQUIRED]

  The name of the target resource group to describe.

RETURN TYPE:

DescribeResourceGroupResp

RETURNS:

A DescribeResourceGroupResp object contains the following fields:

• groupName (String) -

  The name of the current resource group.

• capacity (Integer) -

  The number of query nodes allocated to the current resource group.

• numberOfAvailableNode (Interger) -

  The number of available query nodes.

• numberOfLoadedReplica (Map<String, Integer>) -

  The number of loaded replicas per query node.

• numberOfOutgoingNode (Map<String, Integer>) -

  The number of outgoing nodes.

• numberOfInComingNode (Map<String, Integer>) -

  The number of incoming nodes.

• config (ResourceGroupConfig) -

  The configuration of the current resource group, which is a ResourceGroupConfig object as follows:

  • requests (ResourceGroupLimit) -

    The number of nodes required by a resource group

  • limits (ResourceGroupLimit) -

    The maximum number of nodes required by a resource group.

  • from (List<ResourceGroupTransfer>) -

    The source resource groups for necessary transfers.

  • to (List<ResourceGroupTransfer>) -

    The target resource groups for necessary transfers.

  • nodeFilter (ResourceGroupNodeFilter) -

    A filter used to filter the query nodes with specified node labels.

• nodes (List<NodeInfo>) -

  A list of nodes, each of which is a NodeInfo object.

  • nodeId (Long) -

    The ID of the current query node.

  • address (String) -

    The address of the current query node.

  • hostname (String) -

    The hostname of the current query node.

EXCEPTIONS:

• MilvusClientExceptions

  This exception will be raised when any error occurs during this operation.

Example

// prepare requests    
DescribeResourceGroupReq describeResourceGroupReq = DescribeResourceGroupReq.builder()
    .groupName("rg1")
    .build();

// list resource groups
DescribeResourceGroupResp group = client.describeResourceGroup(describeResourceGroupReq);