# Describe resource group

Inspect the configuration and capacity of a resource group.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/describe/

## Section links

- [cURL command](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/describe/#curl-command)
- [Default request](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/describe/#default-request)
- [Sample response](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/describe/#sample-response)
- [Request fields](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/describe/#request-fields)

`POST /v2/vectordb/resource_groups/describe`

Replace `https://your-cluster.example.com` with your Milvus endpoint. Set `MILVUS_TOKEN` for authentication or omit the Authorization header on an unauthenticated cluster.

## cURL command

```bash
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/resource_groups/describe' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "name": "catalog_queries"
}'
```

## Default request

```json
{
  "name": "catalog_queries"
}
```

## Sample response

```json
{
  "resource_group": {
    "name": "catalog_queries",
    "capacity": 1,
    "num_available_node": 1,
    "num_loaded_replica": {
      "books": 1
    },
    "config": {
      "requests": {
        "node_num": 1
      },
      "limits": {
        "node_num": 1
      }
    },
    "nodes": [
      {
        "node_id": 12,
        "address": "query-node-1:21123",
        "hostname": "query-node-1"
      }
    ]
  }
}
```

## Request fields

- `name` string (required)
  Resource name.
- `config` object
  Resource group node allocation, with requests and limits.

See [`HttpClient.describeResourceGroup`](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describeresourcegroup) for the Node.js SDK method.
