全部产品
Search
文档中心

云服务器 ECS:DescribeCloudAssistantStatus - 查询一台或者多台实例是否安装了云助手Agent

更新时间:May 14, 2024

调用DescribeCloudAssistantStatus查询一台或者多台实例是否安装了云助手Agent。如果已安装了云助手,还将查询云助手命令执行的总数量、正在执行的数量以及最近一次命令执行的时间。

接口说明

  • 建议您先调用该接口查询实例的云助手状态,当 CloudAssistantStatus 为 true 时再执行命令或下发文件,尤其对于新购实例。
  • 支持以下两种方式查看返回数据:
    • 方式一:分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置MaxResults限制返回条目数。
    • 方式二:通过PageSize设置单页返回的条目数,再通过PageNumber设置页码。以上两种方式只能任选其中之一。如果设置了MaxResultsNextToken参数,则请求参数PageSizePageNumber将失效,且返回数据中的TotalCount无效。

调试

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

授权信息

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

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

请求参数

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

实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
OSTypestring

实例的操作系统类型。取值范围:

  • Windows。
  • Linux。
  • FreeBSD。
Windows
PageNumberlong

当前页码。

起始值为 1。

默认值为 1。

1
PageSizelong

分页查询时设置的每页行数。若已设置 InstanceId 参数,则该参数无效。 最大值为 50。

默认值为 10。

10
MaxResultsinteger

分页查询时每页的最大条目数。若已设置 InstanceId 参数,则该参数无效。

最大值为 50。

默认值为 10。

10
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

AAAAAdDWBF2
InstanceIdarray

实例 ID 列表。

string

实例 ID 列表,可包含 ECS 实例 ID、托管实例 ID。 最多可指定 100 个实例 ID。

i-bp1iudwa5b1tqa****

返回参数

名称类型描述示例值
object
PageSizelong

每页行数。

1
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberlong

当前页码。

1
TotalCountlong

实例总个数。

1
NextTokenstring

本次调用返回的查询凭证值。

AAAAAdDWBF2
InstanceCloudAssistantStatusSetobject []

实例云助手安装状态结果集合。

CloudAssistantStatusstring

实例内的云助手是否在运行中。可能值:

  • true:2 分钟内有心跳。

  • false:2 分钟内无心跳。

true
LastInvokedTimestring

最近一次命令执行的时间。

2021-03-15T08:00:00Z
CloudAssistantVersionstring

云助手 Agent 版本号,若未安装或未运行云助手 Agent,则该值为空。

2.2.0.106
ActiveTaskCountlong

实例内的云助手运行中的任务数。

0
InvocationCountlong

实例内的云助手已完成的任务数。

2
InstanceIdstring

实例 ID。

i-bp1iudwa5b1tqa****
LastHeartbeatTimestring

云助手最近一次心跳时间。该值平均每分钟(有上下 5 秒的随机浮动,最短 55 秒,最长 65 秒)更新一次。

2021-03-15T09:00:00Z
OSTypestring

实例操作系统类型。可能值:

  • Windows。
  • Linux。
  • FreeBSD。
Linux
SupportSessionManagerboolean

实例内的云助手是否支持会话管理功能。若不支持,表示云助手版本较低,请将客户端更新至最新版本。

云助手支持会话管理功能的最低版本如下:

  • Linux:2.2.3.189
  • Windows:2.1.3.189
true

示例

正常返回示例

JSON格式

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2",
  "InstanceCloudAssistantStatusSet": {
    "InstanceCloudAssistantStatus": [
      {
        "CloudAssistantStatus": "true",
        "LastInvokedTime": "2021-03-15T08:00:00Z",
        "CloudAssistantVersion": "2.2.0.106",
        "ActiveTaskCount": 0,
        "InvocationCount": 2,
        "InstanceId": "i-bp1iudwa5b1tqa****",
        "LastHeartbeatTime": "2021-03-15T09:00:00Z",
        "OSType": "Linux",
        "SupportSessionManager": true
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400RegionId.ApiNotSupportedThe api is not supported in this region.指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。
400MissingParam.InstanceIdThe parameter instanceId is missing or empty.实例ID为空。
400InvalidParam.PageSizeThe specified parameter is invalid.指定的 PageSize 参数无效。
400InvalidParam.PageNumberThe specified parameter is invalid.指定的 PageNumber 参数无效。
400InvalidParameter.NextTokenThe specified parameter NextToken is not valid.指定的参数NextToken不合法。
400InvalidParameter.MaxResultsThe specified parameter MaxResults is not valid.指定的参数MaxResults不合法。
403InstanceIds.ExceedLimitThe number of instance IDs exceeds the upper limit.目标实例数量超过上限。
403Operation.ForbiddenThe operation is not permitted.该操作是不被允许的。
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.提供的RegionId不存在
404InvalidInstance.NotFoundThe specified instance does not exist.指定的实例不存在。
500InternalError.DispatchAn error occurred when you dispatched the request.发送请求时发生错误,请稍后重试。
500ServiceUnavailableThe request has failed due to a temporary failure of the server.请求后端超时,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2023-12-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:MaxResults
    新增入参:NextToken
出参OpenAPI 返回结构发生变更
2023-05-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    删除错误码:404
    删除错误码:500
2021-08-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
2021-08-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    错误码 404 变更
    删除错误码:400
    删除错误码:500