DescribeResourceGroupAsync()
Describes a resource group.
public async Task<DescribeResourceGroupResp> DescribeResourceGroupAsync(DescribeResourceGroupReq request, CancellationToken cancellationToken = default)
Request Syntax
var request = new DescribeResourceGroupReq
{
ResourceGroupName = "rg1"
};
DescribeResourceGroupResp response = await client.DescribeResourceGroupAsync(request);
REQUEST PARAMETERS:
ResourceGroupName(string) -The name of the resource group to describe.
RETURN TYPE:
Task
RETURNS:
A DescribeResourceGroupResp object that describes the resource group.
DescribeResourceGroupResp
Name // -> string
Capacity // -> int
NumAvailableNode // -> int
NumLoadedReplica // -> IReadOnlyDictionary<string, int>
NumOutgoingNode // -> IReadOnlyDictionary<string, int>
NumIncomingNode // -> IReadOnlyDictionary<string, int>
Config // -> ResourceGroupConfigData
Nodes // -> IReadOnlyList<NodeInfoData>
PARAMETERS:
Name (string) -
The name of the resource group.
Capacity (int) -
The number of query nodes in the resource group.
NumAvailableNode (int) -
The number of available query nodes in the resource group.
NumLoadedReplica (IReadOnlyDictionary
) - The number of loaded replicas per collection in the resource group.
NumOutgoingNode (IReadOnlyDictionary
) - The number of nodes outgoing to other resource groups, keyed by collection name.
NumIncomingNode (IReadOnlyDictionary
) - The number of nodes incoming from other resource groups, keyed by collection name.
Config (ResourceGroupConfigData) -
The configuration of the resource group, in the same shape as ResourceGroupConfig.
RequestsNodeNum (int?) -
The requested number of query nodes for the resource group.
LimitsNodeNum (int?) -
The maximum number of query nodes for the resource group.
TransferFrom (IReadOnlyList
) - The names of the resource groups that can have nodes transferred from.
TransferTo (IReadOnlyList
) - The names of the resource groups that can have nodes transferred to.
NodeFilterLabels (IReadOnlyList
> ) -The node filter labels used to match query nodes for the resource group.
Nodes (IReadOnlyList
) - The query nodes in the resource group.
NodeId (long) -
The ID of the query node.
Address (string) -
The address of the query node.
Hostname (string) -
The hostname of the query node.
EXCEPTIONS:
-
Thrown when the RPC fails or the server returns an error. Inspect the exception message for details.
Example
using Milvus.Client.V2;
using Milvus.Client.V2.Requests.ResourceGroup;
using Milvus.Client.V2.Responses.ResourceGroup;
using Milvus.Client.V2.Types;
using var client = new MilvusClientV2(new ConnectConfig
{
Uri = "localhost:19530",
Username = "root",
Password = "Milvus"
});
await client.ConnectAsync();
DescribeResourceGroupResp response = await client.DescribeResourceGroupAsync(new DescribeResourceGroupReq { ResourceGroupName = "rg1" });
Console.WriteLine($"capacity: {response.Capacity}, available: {response.NumAvailableNode}");