文档

DescribeAgentInstallStatus - 查询Agent安装状态

更新时间:

通过云助手执行Agent安装命令后,查询Agent安装状态。该接口仅支持查询2分钟内发起安装的安装状态。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
SourceIpstring

访问源的 IP 地址。

59.46.XXX.XXX
Langstring

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

  • zh:中文。
  • en:英文。
zh
Uuidsstring

查询服务器唯一识别 UUID。多个 ID 之间使用半角逗号(,)分隔。

说明 您可以调用 DescribeCloudCenterInstances 接口获取服务器的 UUID。
inet-eae014a7-16c4-4d4e-9f03-5208f4dc****,inet-eae047da-1e5a-41ce-828d-47606e9b****

返回参数

名称类型描述示例值
object
RequestIdstring

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

A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
AegisClientInvokeStatusResponseListobject []

服务器状态列表。

Uuidstring

服务器唯一识别 UUID。

d123f6ae-9749-4338-8c7f-3c2c1ead****
Messagestring

请求结果返回信息。

uninstalled
Resultinteger

状态结果。取值:

  • -1:未安装
  • 0:安装中
  • 1:安装成功
  • 2:安装失败
-1
ResuleCodestring

状态。取值:

  • -1:未安装
  • 0: 安装成功
  • 1:客户端目录创建失败
  • 2:安装包下载失败
  • 3:安装文件不存在
  • 4:安装文件校验信息不存在
  • 5:安装文件校验不通过
  • 6:安装文件执行失败
  • 7:权限不足,安装失败
  • 8:未检测到客户端进程
  • 100:安装失败,未知错误
  • 1001:安装失败,该地域暂不支持一键安装客户端
  • 1002:安装失败,不支持云外主机,请在服务器上执行脚本安装
  • 1003:安装失败,不支持的操作系统类型
  • 1004:内部错误,请稍后重试
  • 1005:ecs 未运行,请启动 ecs 之后重试
  • 1006:不支持经典网络的 ecs,一键安装客户端
  • 1007:命令进程被手动停止
  • 1008:没有安装云助手,无法安装客户端
  • 1009:命令执行超时,请稍后重试
  • 1010:机器已经在线,无需安装客户端
-1

示例

正常返回示例

JSON格式

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7",
  "AegisClientInvokeStatusResponseList": [
    {
      "Uuid": "d123f6ae-9749-4338-8c7f-3c2c1ead****",
      "Message": "uninstalled",
      "Result": -1,
      "ResuleCode": "-1"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500InternalErrorThe request processing has failed due to some unknown error.服务发生某些未知错误,请稍后再试。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
2022-01-19新增 OpenAPI看变更集
  • 本页导读 (1)