All Products
Search
Document Center

Application Real-Time Monitoring Service:GetAgentDownloadUrlV2

Last Updated:Nov 05, 2024

Obtains the download URL of the Application Real-Time Monitoring Service (ARMS) agent.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:GetAgentDownloadUrlnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AgentTypestringYes

The agent type.
Valid values:

  • JavaAgent
  • Instgo
JavaAgent
OsTypestringNo

The operating system of the environment where the agent is installed.
This parameter is required and valid only when AgentType is set to Instgo.
Valid values:

  • linux
  • darwin
  • windows
linux
ArchTypestringNo

The architecture type of the environment where the agent is installed.
This parameter is required and valid only when AgentType is set to Instgo.
Valid values:

  • amd64
  • arm64
amd64

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

78901766-3806-4E96-8E47-CFEF59E4****
Dataobject

The version number and download URL of the agent.

Versionstring

The version number of the agent.

3.2.9
Urlstring

The download URL of the agent.

http://arms-apm-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/3.2.9/ArmsAgent.zip
Messagestring

The returned message.

Codelong

The HTTP status code.
Valid values:

  • 2xx: The request was successful.
  • 3xx: The request was redirected.
  • 4xx: The request was invalid.
  • 5xx: A server error occurred.
200
Successboolean

Indicates whether the request was successful.
Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Data": {
    "Version": "3.2.9",
    "Url": "http://arms-apm-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/3.2.9/ArmsAgent.zip"
  },
  "Message": "",
  "Code": 200,
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400ParameterMissingYou must specify the parameter.You must specify the parameter.
400ParameterIllegalThe specified parameter is invalid.The specified parameter is invalid.
404AppNotExistThe application does not exist.The application does not exist.
500InternalErrorInternal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.

For a list of error codes, visit the Service error codes.