listResourceGroups()

This operation lists all available resource groups.

listResourceGroups(data): Promise<ListResourceGroupsResponse>

Request Syntax

milvusClient.describeResourceGroup({
    timeout?: number
})

PARAMETERS:

• timeout (number) -

  The timeout duration for this operation.

  Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

RETURNS Promise |<DescribeResourceGroupResponse>

This method returns a promise that resolves to a DescribeResourceGroupResponse object.

{
    code: number
    error_code: string | number,
    reason: string,
    resource_groups: string[]
}

PARAMETERS:

• code (number) -

  A code that indicates the operation result. It remains 0 if this operation succeeds.

• error_code (string | number) -

  An error code that indicates an occurred error. It remains Success if this operation succeeds.

• reason (string) -

  The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

• resource_groups (string[]) -

  A list of resource group names.

Example

const milvusClient = new milvusClient(MILUVS_ADDRESS);

const res = await milvusClient.listResourceGroups();