DescribeCloudAssistantStatus_云服务器 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.

接口说明

  • 建议您先调用该接口查询实例的云助手状态,当 CloudAssistantStatus 为 true 时再执行命令或下发文件,尤其对于新购实例。
  • 分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置MaxResults限制返回条目数。

流控信息

当前云产品API请求速率暂未透出。

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
OSTypestring

实例的操作系统类型。取值范围:展开详情

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

分页查询时每页的最大条目数。若已设置 InstanceId 参数,则该参数无效。展开详情

示例值:10
NextTokenstring

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

示例值:AAAAAdDWBF2
InstanceIdarray<string>

实例 ID 列表。

示例值:i-bp1iudwa5b1tqa****子级条数 <= 100

返回参数

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

每页行数。

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

请求 ID。

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

当前页码。

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

实例总个数。

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

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

示例值:AAAAAdDWBF2
InstanceCloudAssistantStatusSetobject

返回示例

变更历史

暂无变更历史

相关示例

执行云助手命令
2021-01-15