DescribeAgentInstallStatus - Security Center - Alibaba Cloud Documentation Center

Queries the installation status of the Security Center agent after you run an installation command by using Cloud Assistant.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeAgentInstallStatus	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	59.46.XXX.XXX
Lang	string	No	The language of the content within the request and response. Valid value: zh: Chinese en: English	zh
Uuids	string	Yes	The UUIDs of servers. Separate multiple UUIDs with commas (,). Note You can call the DescribeCloudCenterInstances operation to query the UUIDs of servers.	inet-eae014a7-16c4-4d4e-9f03-5208f4dc**,inet-eae047da-1e5a-41ce-828d-47606e9b**

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
AegisClientInvokeStatusResponseList	object []	The status of servers.
Uuid	string	The UUID of the server.	d123f6ae-9749-4338-8c7f-3c2c1ead****
Message	string	The returned message.	Installed
Result	integer	The installation result. Valid value: -1: The agent is not installed. 0: The agent is being installed. 1: The agent is installed. 2: The installation failed.	0
ResuleCode	string	The installation status. Valid value: -1: The agent is not installed. 0: The agent is installed. 1: Failed to create a directory in the client. 2: Failed to download the installation package. 3: The installation file does not exist. 4: The verification information of the installation file does not exist. 5: Failed to verify the installation file. 6: Failed to execute the installation file. 7: You do not have the required permissions. The installation failed. 8: No client process is detected. 100: The installation failed due to an unknown error. 1001: The installation failed. One-click installation is not supported in this region. 1002: The installation failed. Servers that are not provided by Alibaba Cloud are not supported. Install the agent by executing a script on the server. 1003: The installation failed. The operating system is not supported. 1004: An internal error occurred. Try again later. 1005: The Elastic Compute Service (ECS) instance is not started. Start the ECS instance and try again. 1006: One-click installation is not supported for ECS instances of the classic network type. 1007: The running command is manually stopped. 1008: Cloud Assistant is not installed. You cannot install the client. 1009: The command execution timed out. Try again later. 1010: The machine is already online. You do not need to install a client.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7",
  "AegisClientInvokeStatusResponseList": [
    {
      "Uuid": "d123f6ae-9749-4338-8c7f-3c2c1ead****",
      "Message": "Installed\n",
      "Result": 0,
      "ResuleCode": "1"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	InternalError	The request processing has failed due to some unknown error.	-
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation
2022-01-19	Add Operation	see changesets