ListPluginStatus_云服务器 ECS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为1000/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ecs:ListPluginStatus
Get
Instance
acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
InstanceIdarray<string>

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

子级条数 <= 51
Namestring

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

示例值:testPluginName
PageNumberinteger<int64>
说明 该参数即将下线,推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
PageSizeinteger<int64>
说明 该参数即将下线,推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10
MaxResultsinteger<int32>

分页查询时每页的最大条目数。展开详情

示例值:10
NextTokenstring

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

示例值:AAAAAdDWBF2

返回参数

字段名称字段详情
PageSizeinteger<int64>

每页行数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:10
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumberinteger<int64>

查询结果的页码。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1
TotalCountinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1
NextTokenstring

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

示例值:AAAAAdDWBF2
InstancePluginStatusSetobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParam.PageNumber
The specified parameter PageNumber is invalid.诊断
400
InvalidParam.PageSize
The specified parameter PageSize is invalid.诊断
400
PluginName.MissingValue
The plugin name must be specified when the number of InstanceIds is not 1.诊断
400
InstanceIds.ExceedLimit
The number of instance IDs exceeds the upper limit.诊断
400
InvalidParameter.NextToken
The specified parameter NextToken is not valid.诊断
400
InvalidParameter.MaxResults
The specified parameter MaxResults is not valid.诊断
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.诊断

变更历史

变更时间变更内容概要操作
2022-09-09
新增OpenAPI,查询实例中云助手插件的状态

相关示例