All Products
Search
Document Center

Security Center:DescribeSasPmAgentList

Last Updated:Feb 20, 2024

Queries the servers on which you want to install the CloudMonitor agent.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
yundun-sas:DescribeSasPmAgentListRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
en
UuidsstringYes

The UUID of the server. Separate multiple UUIDs with commas (,).

inet-cb7ae5ee-b2bc-4581-b616-62495f5d****,inet-37cf0e4f-55cc-4b84-8073-b348b4b4****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

8EF3ACC2-9400-5B64-B72D-4A1D35113750
SasPmAgentListobject []

An array that consists of the information about servers.

AliyunAssistIdstring

The ID of Cloud Assistant.

mi-hz034jn***yxhc0
AliyunMonitorIdstring

The ID of the CloudMonitor agent.

5d5ef6be-54ff-11ed-82cf-8f01475e****
AssistInstallStatusinteger

The status of Cloud Assistant. Valid values:

  • 0: installing
  • 1: installed
  • 2: installation failed
  • 3: installation timed out
1
MonitorInstallStatusinteger

The status of the CloudMonitor agent. Valid values:

  • 0: installation failed
  • 1: installed
1
AssistInstallResultinteger

The installation result of Cloud Assistant. Valid values:

  • 0: SUCCESS
  • 1: MISSING_PARAM
  • 2: UNKNOWN_SYSTEM
  • 3: DOWNLOAD_FAILED
  • 4: INSTALL_FAILED
0
MonitorInstallResultinteger

The installation result of the CloudMonitor agent. Valid values:

  • 0: failed
  • 1: successful
1
Uuidstring

The UUID of the server.

87f1724d-075e-48d3-95fd-78c2dd36****

Examples

Sample success responses

JSONformat

{
  "RequestId": "8EF3ACC2-9400-5B64-B72D-4A1D35113750",
  "SasPmAgentList": [
    {
      "AliyunAssistId": "mi-hz034jn***yxhc0",
      "AliyunMonitorId": "5d5ef6be-54ff-11ed-82cf-8f01475e****",
      "AssistInstallStatus": 1,
      "MonitorInstallStatus": 1,
      "AssistInstallResult": 0,
      "MonitorInstallResult": 1,
      "Uuid": "87f1724d-075e-48d3-95fd-78c2dd36****"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400ConsoleErrorThe error message is %s %s.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
No change history