ListPluginStatus - 查询实例中云助手插件的状态-阿里云帮助中心

调用ListPluginStatus查询实例中云助手插件的状态。

接口说明

实例的云助手 Agent 版本不低于以下版本，才可以查询到实例内云助手插件状态：
- Linux：2.2.3.344。
- Windows：2.1.3.344。
分页查询首页时，仅需设置MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证，并设置MaxResults限制返回条目数。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecs:ListPluginStatus

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
InstanceId	array	否	实例 ID，单次请求最多支持 50 台实例，N 的取值范围为 1~50。
	string	否	实例 ID，单次请求最多支持 50 台实例，N 的取值范围为 1~50。	i-bp1iudwa5b1tqa****
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
Name	string	否	插件名称，支持全字符集。长度不得超过 255 个字符。若不指定该参数，会查询实例中已安装插件的状态。说明若不指定该参数，只能指定一个实例 ID。若指定该参数，会查询出实例中指定插件的状态。	testPluginName
PageNumber	integer	否	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。	1
PageSize	integer	否	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。	10
MaxResults	integer	否	分页查询时每页的最大条目数。最大值为 50。默认值为 10。	10
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	AAAAAdDWBF2

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页行数。	10
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	查询结果的页码。	1
TotalCount	integer	符合查询条件的记录条数。	1
NextToken	string	本次调用返回的查询凭证值。	AAAAAdDWBF2
InstancePluginStatusSet	object
InstancePluginStatus	array<object>	实例插件状态列表。
	array<object>	实例插件状态列表。
InstanceId	string	实例 ID。	i-xxxxx
PluginStatusSet	object
PluginStatus	array<object>	插件状态列表。
	object	插件状态列表。
PluginStatus	string	插件状态。取值范围： NotInstalled：插件未安装。 Installed：一次性插件已安装。 Running：常驻插件运行中。 Stopped：常驻插件未运行。 Crashed：插件状态异常。 Removed：插件已卸载。 UnKnown：状态未知。	Running
PluginVersion	string	插件版本号。	1.1
PluginName	string	插件名称。	testName
FirstHeartbeatTime	string	云助手第一次上报插件状态的时间。	2020-01-19T09:15:46Z
LastHeartbeatTime	string	云助手最近一次上报插件状态的时间。	2020-01-19T09:15:46Z

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2",
  "InstancePluginStatusSet": {
    "InstancePluginStatus": [
      {
        "InstanceId": "i-xxxxx",
        "PluginStatusSet": {
          "PluginStatus": [
            {
              "PluginStatus": "Running",
              "PluginVersion": "1.1",
              "PluginName": "testName",
              "FirstHeartbeatTime": "2020-01-19T09:15:46Z",
              "LastHeartbeatTime": "2020-01-19T09:15:46Z"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	RegionId.ApiNotSupported	The api is not supported in this region.	指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。
400	InvalidParam.PageNumber	The specified parameter PageNumber is invalid.	指定的参数PageNumber不合法。
400	InvalidParam.PageSize	The specified parameter PageSize is invalid.	指定的参数PageSize不合法。
400	PluginName.MissingValue	The plugin name must be specified when the number of InstanceIds is not 1.	指定的实例数量不为1时，插件名称必须指定。
400	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.	指定的参数NextToken不合法。
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	指定的参数MaxResults不合法。
500	InternalError.Dispatch	An error occurred when you dispatched the request.	发送请求时发生错误，请稍后重试。
403	Operation.Forbidden	The operation is not permitted.	该操作是不被允许的。
404	InvalidInstance.NotFound	The specified instance does not exist.	指定的实例不存在。
404	InvalidPluginName.NotFound	The specified plugin name does not exist.	指定的插件名称不存在。

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

变更历史

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