DescribeInstallCodes - 查询手动安装云安全中心Agent的安装命令列表

查询手动安装云安全中心Agent的安装命令列表。

接口说明

本接口用户查询在服务器上手动安装云安全中心 Agent 时的安装命令。查询结果包含安装验证码和服务器相关的信息。当您需要在服务器上手动安装云安全中心 Agent 时,您可以调用本接口获取手动安装命令。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeInstallCodesget
*全部资源
*

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

C0D6119F-92EE-1276-B8B6-C81A7F9D57F5
InstallCodesarray<object>

安装命令信息。

InstallCodeobject
OnlyImageboolean

是否镜像安装。取值:

  • true:是
  • false:否
false
CaptchaCodestring

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

15v02r
GroupIdlong

服务器所属分组的 ID。

9165712
GroupNamestring

服务器所属分组的名称。

default
ExpiredDatelong

安装命令到期的时间戳,单位为毫秒。

1637810007000
VendorNamestring

服务器供应商的名称。

ALIYUN
Osstring

服务器的操作系统。取值:

  • linux:Linux。
  • windows:Windows。
linux
ProxyClusterstring

代理集群名。

proxy_test
PrivateLinkEndpointIdlong

阿里云私网连接接入 ID。

123

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
2024-11-15OpenAPI 返回结构发生变更查看变更详情
2023-05-16OpenAPI 返回结构发生变更查看变更详情