Batch Retrieve Instance BSM-Agent Status
Updated at：2025-10-20
Batch Retrieval of bsm-agent State within Instances
API description
Retrieve the bsm-agent state for up to 100 virtual machines in batches.
Request structure
Plain Text
1POST /v1/ca/agent/batchRequest headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| hosts | List<Host> | Yes | RequestBody | Virtual machine list |
Response headers
There are no special headers required beyond the common headers.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| requestId | String | Request ID |
| code | String | Response state, where successful execution is indicated by success. |
| result | List<Agent> | bsm-agent state in virtual machine |
Request example
JSON
1POST /v1/ca/agent/batch
2{
3 "hosts": [
4 {
5 "instanceId" : "i-LxvHe***"
6 },
7 {
8 "instanceId" : "i-gVGDt***"
9 }
10 ],
11}Response example
JSON
1{
2 "requestId": "d8752367-38e8-45e4-b4c7-e53be3******",
3 "code": "success",
4 "result": [
5 {
6 "host": {
7 "instanceId": "i-LxvHe***"
8 },
9 "state": "ONLINE",
10 "version": "0.0.0.1"
11 },
12 {
13 "host": {
14 "instanceId": "i-gVGDt***"
15 },
16 "state": "OFFLINE",
17 "version": "0.0.0.1"
18 }
19 ]
20}Appendix - data structures
Agent
| Parameter name | Types | Description |
|---|---|---|
| host | Host | Instance information |
| state | String | bsm-agent states. Possible values: ONLINE (online), OFFLINE (offline). |
| version | String | bsm-agent version No., e.g., 4.2.0.1 |
Host
| Parameter name | Types | Description |
|---|---|---|
| instanceId | String | Instance ID, e.g., BCC instance ID: i-gVGDt*** |