Method: legacySdk.legacyGetAgentById

Full name: projects.locations.instances.legacySdk.legacyGetAgentById

Legacy RPC for get agent by id.

HTTP request


Path parameters

Parameters
instance

string

Required. The GetAgentById request. Format: projects/{project}/locations/{location}/instances/{instance}/legacySdk:getAgentById

Query parameters

Parameters
agentId

string

Required. The agent id.

Request body

The request body must be empty.

Response body

ApiAgent message.

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

JSON representation 
{
  "id": string,
  "identifier": string,
  "name": string,
  "environments": [
    string
  ],
  "publisherId": string,
  "publisherName": string,
  "publisherSlaveName": string,
  "accessLink": string,
  "status": enum (AgentStatusEnum),
  "certificate": string,
  "primaryAgentIdentifier": string,
  "loggingLevel": enum (AgentLoggingLevelEnum)
}
Fields
id

string (int64 format)

Required. Agent id.
identifier

string

Agent identifier.
name

string

Agent name.
environments[]

string

Agent environments.
publisherId

string (int64 format)

Publisher id.
publisherName

string

Publisher name.
publisherSlaveName

string

Publisher slave name.
status

enum (AgentStatusEnum)

Agent status.
certificate

string

Certificate.
primaryAgentIdentifier

string

Required. Primary agent identifier.
loggingLevel

enum (AgentLoggingLevelEnum)

Required. Agent logging level.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

AgentStatusEnum

AgentStatusEnum enum.

Enums
AGENT_STATUS_UNSPECIFIED Agent status is unspecified.
ENABLED Agent is enabled.
DISABLED Agent is disabled.
DELETED Agent is deleted.

AgentLoggingLevelEnum

AgentLoggingLevelEnum enum.

Enums
ERROR Agent logging level is error.
WARNING Agent logging level is warning.
INFO Agent logging level is info.
DEBUG Agent logging level is debug.