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

接口说明

实例的云助手客户端版本不低于以下版本,才可以查询到实例内云助手插件状态:

  • Linux:2.2.3.344。
  • Windows:2.1.3.344。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListPluginStatus

系统规定参数。取值:ListPluginStatus

RegionId String cn-hangzhou

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

InstanceId.N String i-bp1iudwa5b1tqa****

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

Name String testPluginName

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

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

当前页码。

  • 起始值为1。
  • 默认值为1。
PageSize Long 10

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

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

返回数据

名称 类型 示例值 描述
PageSize Long 10

每页行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

请求ID。

PageNumber Long 1

查询结果的页码。

TotalCount Long 1

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

InstancePluginStatusSet Array of InstancePluginStatus

实例插件状态列表。

InstancePluginStatus
InstanceId String i-xxxxx

实例ID。

PluginStatusSet Array of PluginStatus

插件状态列表。

PluginStatus
PluginVersion String 1.1

插件版本号。

PluginName String testName

插件名称。

FirstHeartbeatTime String 2020-01-19T09:15:46Z

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

LastHeartbeatTime String 2020-01-19T09:15:46Z

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

PluginStatus String Running

插件状态。取值范围:

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

示例

请求示例

http(s)://ecs.aliyuncs.com/?Action=ListPluginStatus
&RegionId=cn-hangzhou
&InstanceId=["i-bp1iudwa5b1tqa****"]
&Name=testPluginName
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListPluginStatusResponse>
    <PageSize>10</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <InstancePluginStatusSet>
        <InstancePluginStatus>
            <InstanceId>i-xxxxx</InstanceId>
            <PluginStatusSet>
                <PluginStatus>
                    <PluginName>testName</PluginName>
                    <PluginVersion>1.1</PluginVersion>
                    <PluginStatus>Running</PluginStatus>
                    <FirstHeartbeatTime>2020-01-19T09:15:46Z</FirstHeartbeatTime>
                    <LastHeartbeatTime>2020-01-19T09:15:46Z</LastHeartbeatTime>
                </PluginStatus>
            </PluginStatusSet>
        </InstancePluginStatus>
    </InstancePluginStatusSet>
</ListPluginStatusResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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. 目标实例数量超过上限。
404 InvalidInstance.NotFound The specified instance does not exist. 指定的实例不存在。
404 InvalidPluginName.NotFound The specified plugin name does not exist. 指定的插件名称不存在。
500 InternalError.Dispatch An error occurred when you dispatched the request. 发送请求时发生错误,请稍后重试。

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