文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 安装配置/ 查询agent安装脚本 - ListAgentInstallScript
更新时间:2025-10-31 GMT+08:00
分享

查询agent安装脚本 - ListAgentInstallScript

功能介绍

查询agent安装脚本

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/setting/agent-install-script

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

os_type

String

os类型:Windows和Linux

os_arch

String

系统架构:x86_64和aarch64;当os_type为Windows时,只能选择x86_64

outside_host

Boolean

是否非华为云

outside_group_id

String

服务器组ID,此参数已废弃

batch_install

Boolean

是否批量安装

type

String

类型:password和ssh_key

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

install_script_list

Array of AgentInstallScriptResponseInfo objects

安装脚本列表

表5 AgentInstallScriptResponseInfo

参数

参数类型

描述

package_type

String

包类型

cmd

String

命令

package_download_url

String

包下载url

请求示例

批量查询os类型为linux,架构为x86_64类型为密码,企业项目id为all_granted_eps,region为xx的agent安装命令

GET https://{endpoint}/v5/setting/agent-install-script?batch_install=true&os_type=Linux&os_arch=x86_64&type=password&enterprise_project_id=all_granted_eps&region=xxx

响应示例

状态码:200

请求已成功

{
  "install_script_list" : [ {
    "cmd" : "curl -k -O xxxxxxagent_Install.sh",
    "package_type" : "Linux"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档