DescribeAgentInstallStatus - 查询Agent安装状态

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribeAgentInstallStatus

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

SourceIp

string

访问源的 IP 地址。

59.46.XXX.XXX

Lang

string

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

  • zh:中文。

  • en:英文。

zh

Uuids

string

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

说明

您可以调用 DescribeCloudCenterInstances 接口获取服务器的 UUID。

inet-eae014a7-16c4-4d4e-9f03-5208f4dc****,inet-eae047da-1e5a-41ce-828d-47606e9b****

返回参数

名称

类型

描述

示例值

object

RequestId

string

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

A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7

AegisClientInvokeStatusResponseList

array<object>

服务器状态列表。

object

服务器状态。

Uuid

string

服务器唯一识别 UUID。

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

Message

string

请求结果返回信息。

uninstalled

Result

integer

状态结果。取值:

  • -1:未安装

  • 0:安装中

  • 1:安装成功

  • 2:安装失败

-1

ResuleCode

string

状态。取值:

  • -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

错误码

错误信息

描述

500 InternalError The request processing has failed due to some unknown error.
500 ServerError ServerError
403 NoPermission caller has no permission

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

变更历史

更多信息,参考变更详情