Method: remoteAgents.fetchRemoteAgentsInformation

Full name: projects.locations.instances.remoteAgents.fetchRemoteAgentsInformation

Returns a list of all remote agents, including their advanced information.

HTTP request


Path parameters

Parameters
parent

string

Required. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "remoteAgentIdentifiers": [
    string
  ]
}
Fields
remoteAgentIdentifiers[]

string

Required. List of remote agent identifiers.

Response body

Response message for the FetchAgentsInformation method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "remoteAgentInfoResponses": [
    {
      object (RemoteAgentInfoResponse)
    }
  ]
}
Fields
remoteAgentInfoResponses[]

object (RemoteAgentInfoResponse)

Output only. List of remote agents information.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

RemoteAgentInfoResponse

Information about a specific remote agent.

JSON representation 
{
  "identifier": string,
  "displayName": string,
  "lastCommunicationTime": string,
  "lastActionExecutionTime": string,
  "version": string,
  "requiredPlatformVersion": string,
  "ipAddress": string,
  "hostName": string,
  "communicationStatus": enum (AgentCommunicationStatus),
  "highAvailabilityStatus": enum (HighAvailabilityStatus),
  "usages": [
    string
  ],
  "deploymentType": enum (InstallationType),
  "loggingLevel": enum (RemoteAgentLogLevel),
  "availableForLoggingLevel": boolean,
  "upgradeAvailable": boolean,
  "majorUpgrade": boolean,
  "redeployInfo": {
    object (RedeployInformation)
  },
  "latestVersion": boolean,
  "supportCloudLogging": boolean,
  "latestRemoteAgentVersion": string,
  "connectorsMigrationStatus": enum (AgentConnectorsMigrationStatus),
  "supportConnectorsHighAvailability": boolean
}
Fields
identifier

string

Output only. Unique GUID Identifier of the remote agent
displayName

string

Output only. The display name of the remote agent.
lastCommunicationTime

string (Timestamp format)

Output only. Last communication time with the remote agent in unix time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
lastActionExecutionTime

string (Timestamp format)

Output only. Last action execution time in the remote agent in unix time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
version

string

Output only. Represents the remote agent's current version.
requiredPlatformVersion

string

Output only. Required platform version to run any integration on the remote agent.
ipAddress

string

Output only. Represents the remote agent's IP address.
hostName

string

Output only. Represents the remote agent's host name.
communicationStatus

enum (AgentCommunicationStatus)

Output only. Indicates the remote agent's current communication status in real time.
highAvailabilityStatus

enum (HighAvailabilityStatus)

Output only. Indicates the secondary remote agent's communication status in real time. The secondary remote agent acts as a backup mechanism in case the primary remote agent becomes unavailable - for example due to high load. Therefore, it is named as HighAvailabilityStatus.
usages[]

string

Output only. List of all integrations, connectors and jobs installed on the remote agent for a specific integration identifier.
deploymentType

enum (InstallationType)

Output only. Remote agent installation type
loggingLevel

enum (RemoteAgentLogLevel)

Output only. Logging level on the remote agent.
availableForLoggingLevel

boolean

Output only. Indicates if the remote agent logging level can be changed.
upgradeAvailable

boolean

Output only. Indicates if the remote agent has an available new version to which it can be upgraded.
majorUpgrade

boolean

Output only. Indicates if the remote agent's version is a major version or not. Major upgrade - upgrade of the renote agent that needs client intervention. E.g. deploying new docker image.
redeployInfo

object (RedeployInformation)

Output only. Remote agent redeployment information.
latestVersion

boolean

Output only. Indicates if the remote agent version is the latest.
supportCloudLogging

boolean

Output only. Indicates if the remote agent is compatible with cloud logging.
latestRemoteAgentVersion

string

Output only. The remote agent latest version available for upgrade (Available on publisher).
connectorsMigrationStatus

enum (AgentConnectorsMigrationStatus)

Output only. Connectors migration status.
supportConnectorsHighAvailability

boolean

Output only. Indicates if the remote agent supports high availability for connectors.

AgentCommunicationStatus

Possible values for the remote agent's current communication status.

Enums
AGENT_COMMUNICATION_STATUS_UNSPECIFIED Agent status is unspecified.
LIVE An agent status of 'live' means it has an active connection with the system.
ERROR An agent status of 'error' means it does not have an active connection with the system.
DISABLED An agent status of 'disabled' means it was disabled by the user and can be re-enabled in the future.
WAITING_FOR_AGENT An agent status of 'waiting for agent' means either the system is waiting for a connection response from the agent or the agent is undergoing a process such as an upgrade.
DELETED Agent current status is deleted.

HighAvailabilityStatus

Indicates the secondary remote agent's communication status in real time, as reported by the system.

Enums
HIGH_AVAILABILITY_STATUS_UNSPECIFIED Remote agent status is unspecified.
LIVE The secondary remote agent is fully operational.
ERROR There is a mismatch in versions between the remote agent and the platform, or the status cannot be calculated.
DISABLED Either the Primary or the secondary remote agent is disabled.
PENDING_SECONDARY_AGENT A secondary remote agent status of 'Pending Secondary Agent' means that the secondary remote agent is in a pending state either because the systme is waiting for a connection response from the remote agent or the remote agent is undergoing a process and waiting for it to finish.
NOT_CONFIGURED This indicates that a secondary remote agent does not exist.

RedeployInformation

Remote agent redeployment information.

JSON representation 
{
  "redeployed": boolean,
  "sourceDeployedAgent": string
}
Fields
redeployed

boolean

Output only. Indicates if the remote agent was redeployed from another remote agent.
sourceDeployedAgent

string

Output only. If the remote agent was redeployed from a different remote agent, then this field indicates the source remote agent's identifier.

AgentConnectorsMigrationStatus

Represents the migration status of remote agent connectors.

Enums
AGENT_CONNECTORS_MIGRATION_STATUS_UNSPECIFIED AgentConnectorsMigrationStatus is unspecified.
PENDING Migration is pending.
IN_PROGRESS Migration is in progress for at least one connector.
COMPLETED Migration is complete or no migration is required.
FAILED Migration has failed for at least one connector.