调用ListPluginStatus查询实例中云助手插件的状态。
接口说明
实例的云助手Agent版本不低于以下版本,才可以查询到实例内云助手插件状态:
- 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个字符。
|
PageNumber | Long | 否 | 1 |
当前页码。
|
PageSize | Long | 否 | 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 |
插件状态。取值范围:
|
示例
请求示例
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
10
473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
1
1
i-xxxxx
testName
1.1
Running
2020-01-19T09:15:46Z
2020-01-19T09:15:46Z
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. | 发送请求时发生错误,请稍后重试。 |
访问错误中心查看更多错误码。
腾讯云1折,限时活动,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/153399.html