DescribeInstallCodes - Security Center - Alibaba Cloud Documentation Center

Queries the commands that are used to manually install the Security Center Agent.

Operation description

You can call this operation to query the commands that are used to manually install the Security Center agent on the server. The return result contains the installation verification code and the server information. If you want to manually install the Security Center agent on your server, you can call this operation to query installation commands.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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:DescribeInstallCodes	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	C0D6119F-92EE-1276-B8B6-C81A7F9D57F5
InstallCodes	object []	The information about the installation commands.
OnlyImage	boolean	Indicates whether an image is used to install the Security Center agent. Valid values: true false	false
CaptchaCode	string	The verification code for you to manually install the Security Center agent.	15v02r
GroupId	long	The ID of the server group to which the server belongs.	9165712
GroupName	string	The name of the server group to which the server belongs.	default
ExpiredDate	long	The timestamp generated when the commands used to install the Security Center agent expire. Unit: milliseconds.	1637810007000
VendorName	string	The name of the server provider.	ALIYUN
Os	string	The operating system of the server. Valid values: linux windows	linux
ProxyCluster	string	The name of the proxy cluster.	proxy_test

Examples

Sample success responses

JSONformat

{
  "RequestId": "C0D6119F-92EE-1276-B8B6-C81A7F9D57F5",
  "InstallCodes": [
    {
      "OnlyImage": false,
      "CaptchaCode": "15v02r",
      "GroupId": 9165712,
      "GroupName": "default",
      "ExpiredDate": 1637810007000,
      "VendorName": "ALIYUN",
      "Os": "linux",
      "ProxyCluster": "proxy_test"
    }
  ]
}

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	ServerError	ServerError	-

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

Change history

Change time

Summary of changes

Operation

2023-05-16

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.