调用DescribeInstallCaptcha接口获取手动安装Agent的安装验证码。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstallCaptcha

需要执行的操作。

取值:DescribeInstallCaptcha

SourceIp String 1.2.3.4

访问源的IP地址。

Lang String zh

请求和接收消息的语言类型。取值:

  • zh:中文。
  • en:英文。
Deadline String 2020-10-11 16:26:22

指定安装验证码的有效期。该参数的取值为空时,安装验证码的有效期默认为1小时。

说明 安装验证码只有在有效期内才能使用。已过期的安装验证码无法安装云安全中心Agent。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
CaptchaCode String M1HH**

手动安装云安全中心Agent的安装验证码。

Deadline String 2020-10-10 16:06:38

安装验证码有效日期。

说明 安装验证码只有在有效期内才能使用。过期的安装验证码无法使用。
RequestId String 4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D

阿里云为该请求生成的唯一标识符。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstallCaptcha
&<公共请求参数>

正常返回示例

XML 格式

<DescribeInstallCaptcha>
      <RequestId>A45EB449-0913-4FAF-B5C0-0F2812F69FB4</RequestId>
      <Deadline>2020-10-10 16:06:38</Deadline>
      <CaptchaCode>M1HH**</CaptchaCode>
</DescribeInstallCaptcha>

JSON 格式

{
	"DescribeInstallCaptcha": {
		"RequestId": "A45EB449-0913-4FAF-B5C0-0F2812F69FB4",
		"Deadline": "2020-10-10 16:06:38",
		"CaptchaCode": "M1HH**"
	}
}

错误码

访问错误中心查看更多错误码。