Retrieve Status of Agents in an Agent Group
get
/ic/api/integration/v1/monitoring/agentgroups/{id}/agents
Retrieves monitoring data for agents in the specified agent group including availability status.
Request
Path Parameters
-
id(required): string
Agent group identifier.
Example:
agentgroups/EXECUTION_AGENT_GROUP/agents
Query Parameters
-
integrationInstance(required): string
This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json; charset=utf-8
200 Response
Successful operation
Root Schema : AgentsMonitoringRs
Type:
Show Source
object
-
agent-group-code: string
Agent Group code
-
has-more: boolean
Has More
-
items: array
items
List of Agent
-
limit: integer
(int32)
Limit
-
total-results: integer
(int32)
Total Results
Nested Schema : AgentMonitoringRs
Type:
Show Source
object
-
agent-group-code: string
Agent Group Code
-
created-by: string
Created By
-
created-date: string
(date-time)
Created Date
-
description: string
Description
-
display-status: string
Display Status
-
last-locked-by: string
Last Locked By
-
last-locked-date: string
(date-time)
Last Locked Date
-
last-updated-by: string
Last Updated By
-
last-updated-date: string
(date-time)
Last Updated Date
-
name: string
Name
-
status: string
Allowed Values:
[ "REGISTERED", "ACTIVE", "UNAVAILABLE" ]
-
type: string
Allowed Values:
[ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
-
version: string
Version
400 Response
Malformed parameters
500 Response
Server error
Examples
The following example shows how to retrieve the status of agents in an agent group by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.
Example: Retrieve Status of Agents in an Agent Group
Request:
curl -X GET -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d @runIntegration.json https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/agentgroups/HGBU_OHIP/agents?integrationInstance=service-instance