文档

ListPluginStatus - 查询实例中云助手插件的状态

更新时间:

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

接口说明

  • 实例的云助手 Agent 版本不低于以下版本,才可以查询到实例内云助手插件状态:
    • Linux:2.2.3.344。
    • Windows:2.1.3.344。
  • 支持以下两种方式查看返回数据:
    • 方式一:分页查询首页时,仅需设置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:ListPluginStatusRead
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

请求参数

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

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

cn-hangzhou
InstanceIdarray

实例 ID,单次请求最多支持 50 台实例,N 的取值范围为 1~50。

string

实例 ID,单次请求最多支持 50 台实例,N 的取值范围为 1~50。

i-bp1iudwa5b1tqa****
Namestring

插件名称,支持全字符集。长度不得超过 255 个字符。

  • 若不指定该参数,会查询实例中已安装插件的状态。

    说明 若不指定该参数,只能指定一个实例 ID。
  • 若指定该参数,会查询出实例中指定插件的状态。

testPluginName
PageNumberlong

当前页码。

  • 起始值为 1。
  • 默认值为 1。
1
PageSizelong

分页查询时设置的每页行数。

  • 最大值为 50。
  • 默认值为 10。
10
MaxResultsinteger

分页查询时每页的最大条目数。

最大值为 50。

默认值为 10。

10
NextTokenstring

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

AAAAAdDWBF2

返回参数

名称类型描述示例值
object
PageSizelong

每页行数。

10
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumberlong

查询结果的页码。

1
TotalCountlong

符合查询条件的记录条数。

1
NextTokenstring

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

AAAAAdDWBF2
InstancePluginStatusSetobject []

实例插件状态列表。

InstanceIdstring

实例 ID。

i-xxxxx
PluginStatusSetobject []

插件状态列表。

PluginVersionstring

插件版本号。

1.1
PluginNamestring

插件名称。

testName
FirstHeartbeatTimestring

云助手第一次上报插件状态的时间。

2020-01-19T09:15:46Z
LastHeartbeatTimestring

云助手最近一次上报插件状态的时间。

2020-01-19T09:15:46Z
PluginStatusstring

插件状态。取值范围:

  • NotInstalled:插件未安装。
  • Installed:一次性插件已安装。
  • Running:常驻插件运行中。
  • Stopped:常驻插件未运行。
  • Crashed:插件状态异常。
  • Removed:插件已卸载。
  • UnKnown:状态未知。
Running

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParam.PageNumberThe specified parameter PageNumber is invalid.指定的参数PageNumber不合法。
400InvalidParam.PageSizeThe specified parameter PageSize is invalid.指定的参数PageSize不合法。
400PluginName.MissingValueThe plugin name must be specified when the number of InstanceIds is not 1.指定的实例数量不为1时,插件名称必须指定。
400InstanceIds.ExceedLimitThe number of instance IDs exceeds the upper limit.目标实例数量超过上限。
400InvalidParameter.NextTokenThe specified parameter NextToken is not valid.指定的参数NextToken不合法。
400InvalidParameter.MaxResultsThe specified parameter MaxResults is not valid.指定的参数MaxResults不合法。
404InvalidInstance.NotFoundThe specified instance does not exist.指定的实例不存在。
404InvalidPluginName.NotFoundThe specified plugin name does not exist.指定的插件名称不存在。
500InternalError.DispatchAn error occurred when you dispatched the request.发送请求时发生错误,请稍后重试。

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

  • 本页导读 (1)