使用DescribeCloudAssistantAttributes查询实例命令助手状态与属性-轻量应用服务器-阿里云

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

swas-open:DescribeCloudAssistantAttributes

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	指定的轻量应用服务器实例所属的地域 ID。您可以调用 ListRegions 查看支持的阿里云地域列表。	cn-hangzhou
PageNumber	integer	否	当前页码。起始值：1。默认值：1。	1
PageSize	integer	否	每页行数。	10
InstanceIds	array	是	轻量应用服务器的实例 ID。
	string	否	轻量应用服务器实例 ID。	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	30637AD6-D977-4833-A54C-CC89483E****
CloudAssistant	array<object>	实例命令助手安装状态结果集合。
	object
InstanceId	string	轻量应用服务器实例 ID。	85dbe3e7cc7b49e1a3df4af3bfa4ebbf
CloudAssistantStatus	string	实例内的命令助手是否在运行中。可能值： true：2 分钟内有心跳。 false：2 分钟内无心跳。	true
LastInvokedTime	string	最近一次命令执行的时间。	2021-03-15T08:00:00Z
CloudAssistantVersion	string	命令助手 Agent 版本号，若未安装或未运行命令助手 Agent，则该值为空。	2.2.0.106
ActiveTaskCount	integer	实例内的命令助手运行中的任务数。	0
InvocationCount	integer	实例内的命令助手已完成的任务数。	4
LastHeartbeatTime	string	命令助手最近一次心跳时间。该值平均每分钟（有上下 5 秒的随机浮动，最短 55 秒，最长 65 秒）更新一次。	2021-03-15T09:00:00Z
OSType	string	实例操作系统类型。可能值： Windows。 Linux。 FreeBSD。	Linux
SupportSessionManager	boolean	实例内的命令助手是否支持会话管理功能。若不支持，表示命令助手版本较低，请将客户端更新至最新版本。命令助手支持会话管理功能的最低版本如下： Linux：2.2.3.189 Windows：2.1.3.189	true
TotalCount	integer	总条数。	4
PageSize	integer	每页行数。	10
PageNumber	integer	当前页码。	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
}

错误码

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

变更历史

更多信息，参考变更详情。