Retrieve Agent Install Commands with DescribeInstallCodes - Security Center - Alibaba Cloud - Security Center

Queries the list of commands for manually installing the Security Center agent.

Operation description

This operation queries the commands for manually installing the Security Center agent on servers. The query results include installation verification codes and server-related information. If you need to manually install the Security Center agent on a server, call this operation to obtain the manual installation commands.

Rate limit

The single-user queries per second (QPS) limit for this operation is 10. If the number of calls exceeds the limit, throttling is triggered, which may affect your business. Call this operation as needed.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeInstallCodes

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	C0D6119F-92EE-1276-B8B6-C81A7F9D57F5
InstallCodes	array<object>	The installation command information.
	object
OnlyImage	boolean	Indicates whether the installation is image-based. Valid values: true: Yes. false: No.	false
CaptchaCode	string	The installation verification code for manually installing the Security Center agent.	15v02r
GroupId	integer	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	integer	The timestamp when the installation command expires. Unit: milliseconds.	1637810007000
VendorName	string	The name of the server vendor.	ALIYUN
Os	string	The operating system of the server. Valid values: linux: Linux. windows: Windows.	linux
ProxyCluster	string	The name of the proxy cluster.	proxy_test
PrivateLinkEndpointId	integer	The Alibaba Cloud PrivateLink endpoint ID.	123

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.