全部产品
Search
文档中心

轻量应用服务器:DescribeCloudAssistantAttributes - 查询一台或者多台实例的命令助手信息

更新时间:May 22, 2024

查询一台或者多台实例的命令助手信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

指定的轻量应用服务器实例所属的地域 ID。 您可以调用 ListRegions 查看支持的阿里云地域列表。

cn-hangzhou
PageNumberinteger

当前页码。

起始值:1。

默认值:1。

1
PageSizeinteger

每页行数。

10
InstanceIdsarray

轻量应用服务器的实例 ID。

string

轻量应用服务器实例 ID。

["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

30637AD6-D977-4833-A54C-CC89483E****
CloudAssistantobject []

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

InstanceIdstring

轻量应用服务器实例 ID。

85dbe3e7cc7b49e1a3df4af3bfa4ebbf
CloudAssistantStatusstring

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

true:2 分钟内有心跳。

false:2 分钟内无心跳。

true
LastInvokedTimestring

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

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

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

2.2.0.106
ActiveTaskCountlong

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

0
InvocationCountlong

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

4
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
TotalCountinteger

总条数。

4
PageSizeinteger

每页行数。

10
PageNumberinteger

当前页码。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "CloudAssistant": [
    {
      "InstanceId": "85dbe3e7cc7b49e1a3df4af3bfa4ebbf",
      "CloudAssistantStatus": "true",
      "LastInvokedTime": "2021-03-15T08:00:00Z\n",
      "CloudAssistantVersion": "2.2.0.106\n",
      "ActiveTaskCount": 0,
      "InvocationCount": 4,
      "LastHeartbeatTime": "2021-03-15T09:00:00Z\n",
      "OSType": "Linux",
      "SupportSessionManager": true
    }
  ],
  "TotalCount": 4,
  "PageSize": 10,
  "PageNumber": 1
}

错误码

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