ListPluginStatus -

Usage notes

Before you call this operation to query the status of Cloud Assistant plug-ins on ECS instances, make sure that the versions of Cloud Assistant Agent on the instances are not earlier than the following ones:

2.2.3.344 for Linux instances
2.1.3.344 for Windows instances

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListPluginStatus	The operation that you want to perform. Set the value to ListPluginStatus.
RegionId	String	Yes	cn-hangzhou	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.
InstanceId.N	String	No	i-bp1iudwa5b1tqa****	The ID of instance N. You can specify up to 50 instance IDs in each request. Valid values of N: 1 to 50.
Name	String	No	testPluginName	The name of the Cloud Assistant plug-in. The name supports all character sets and must be 1 to 255 characters in length. If this parameter is not specified, the status of all Cloud Assistant plug-ins that are installed on the specified instances are queried. Note If this parameter is not specified, only a single instance ID can be specified. If this parameter is specified, the status of the specified Cloud Assistant plug-in is queried.
PageNumber	Long	No	1	The page number. Pages start from page 1. Default value: 1.
PageSize	Long	No	10	The number of entries per page. Valid values: 1 to 50. Default value: 10.

Response parameters


Parameter	Type	Example	Description
PageSize	Long	10	The number of entries per page.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	The request ID.
PageNumber	Long	1	The page number.
TotalCount	Long	1	The total number of entries returned.
InstancePluginStatusSet	Array of InstancePluginStatus		The states of Cloud Assistant plug-ins on the instances.
InstancePluginStatus
InstanceId	String	i-xxxxx	The ID of the instance.
PluginStatusSet	Array of PluginStatus		The queried Cloud Assistant plug-ins.
PluginStatus
PluginVersion	String	1.1	The version of the plug-in.
PluginName	String	testName	The name of the plug-in.
FirstHeartbeatTime	String	2020-01-19T09:15:46Z	The first time when Cloud Assistant reported the state of the plug-in.
LastHeartbeatTime	String	2020-01-19T09:15:46Z	The last time when Cloud Assistant reported the state of the plug-in.
PluginStatus	String	Running	The state of the Cloud Assistant plug-in. Valid values: NotInstalled: The plug-in is not installed. Installed: The one-time plug-in is installed. Running: The long-running plug-in is running. Stopped: The long-running plug-in is not running. Crashed: The plug-in is abnormal. Removed: The plug-in is uninstalled. Unknown: The state of the plug-in is unknown.

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=ListPluginStatus
&RegionId=cn-hangzhou
&InstanceId=["i-bp1iudwa5b1tqa****"]
&Name=testPluginName
&PageNumber=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

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 format

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"
        } ]
      }
    } ]
  }
}

Error codes


HTTP status code	Error code	Error message	Description
400	InvalidParam.PageNumber	The specified parameter PageNumber is invalid.	Invalid PageNumber value.
400	InvalidParam.PageSize	The specified parameter PageSize is invalid.	Invalid PageSize value.
400	PluginName.MissingValue	The plugin name must be specified when the number of InstanceIds is not 1.	The Name parameter is left empty when no or multiple instance IDs are specified.
400	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	The maximum number of instance IDs is exceeded.
404	InvalidInstance.NotFound	The specified instance does not exist.	The specified instance is not found.
404	InvalidPluginName.NotFound	The specified plugin name does not exist.	The plug-in name is not found.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	An error occurred when the request was being sent. Try again later.

For a list of error codes, visit the API Error Center.