Call GetAgent to retrieve agent information.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Below are request parameters specific to this API, along with some common parameters. For more details, see common parameters.

Action string required Example value: GetAgent

Operation to be performed: GetAgent.

Version string requiredExample: 2025-01-01

API version: 2025-01-01.

Id string required Example: 1*

Proxy ID.

Response parameters

Below are the response parameters unique to this API. For more details, see Response Structure.

Id string Example: 1*

Proxy ID.

AccountId string Example value: 210000****

Account ID.

Alias string Example: aaa

Proxy alias.

AgentGroupId string Sample value: 1*

Agent group ID.

RunningMode string Example value: Process

Running mode. Available values:

Process: Independent process.

NetworkType string Example: Vpc

Network type. The details are as follows:

Public: public network

Vpc: virtual private cloud (VPC)

Status Boolean Example value: true

Agent running status. Possible values:

true: The agent is running successfully

false: The agent is not running

CreateAt string Example: 1764748140000

Creation time, in milliseconds timestamp.

UpdateAt string Example: 1764748140000

Update time, represented by a millisecond timestamp.

Sample request

Sample response

Error codes

The following table lists error codes related to this API and its business logic. For common error codes, refer to the Common Error Codes documentation.

Status Code	Error Code	Error message	Description
400	2002-00000012	InvalidRequestBody	Invalid parameter.
404	2002-00000014	EntityNotFoundErr	The corresponding entity does not exist.
500	2001-00000001	ServiceInternalErr	Server error. Please try again later.

Data Migration Service