DescribeInstallCaptcha - Security Center - Alibaba Cloud Documentation Center

Queries the verification code for you to manually install the Security Center 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.

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:DescribeInstallCaptcha	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	192.168.XX.XX
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese. en: English.	zh
Deadline	string	No	The validity period of verification codes. If this parameter is not specified, only the valid verification codes are returned. Note An installation verification code can be used only within the validity period. An expired installation verification code cannot be used to install the Security Center agent.	2020-10-11 16:26:22

Response parameters

Parameter	Type	Description	Example
	object
Deadline	string	The validity period of the installation verification code. Note The installation verification code is valid only within the validity period. An expired installation verification code cannot be used to install the agent.	2020-10-10 16:06:38
RequestId	string	The ID of the request.	4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
CaptchaCode	string	The installation verification code for you to manually install the Security Center agent.	M1HH**

Examples

Sample success responses

JSONformat

{
  "Deadline": "2020-10-10 16:06:38",
  "RequestId": "4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D",
  "CaptchaCode": "M1HH**"
}

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-08-29	API Description Update. The API operation is not deprecated.	View Change Details