You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

InstallCloudAssistant

最近更新时间：2023.12.01 11:32:41

首次发布时间：2023.09.04 15:43:19

我的收藏

调用InstallCloudAssistant接口，查询实例批量作业客户端的安装状态。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填示例值描述
ActionString是InstallCloudAssistant要执行的操作，取值：InstallCloudAssistant。
VersionString是2020-04-01接口的版本，取值：2020-04-01。

InstanceIds.N

String

是

InstanceIds.1=i-yci89z1gpml8j1****&InstanceIds.2=i-cdhsdl9l8j1****

实例ID，最多支持50个ID。您可以调用DescribeInstances接口查询获取实例ID。

  • 参数 - N：表示实例的序号。
  • 多个Instance ID之间用&分隔。

OSType

String

否

Linux

操作系统类型。取值：

  • Linux：实例使用Linux操作系统。

PageNumber

Integer

否

1

当前页码。

  • 起始值：1。
  • 默认值：1。

PageSize

Integer

否

1

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

  • 取值范围：1~100。
  • 默认值：10。
ClientVersionString否v1.1.0Agent运行版本。

Status

String

否

Running

Agent状态。取值：

  • Running：运行中。
  • Updating：升级中。
  • Error：错误。

返回数据

名称类型示例值描述
InstallingInstanceIdsList["i-ycm4ru8****","iyclwwbhbls****" ]已提交安装Agent的实例ID。
FailedInstancesArray of Struct-符合条件的安装失败实例信息。具体请参见下表“FailedInstance 结构”。

FailedInstance 结构

名称类型示例值描述
IdStringi-yci89z1gpml8j1****安装失败的实例 ID。
ErrorMessageString-失败信息。

请求示例

GET /?Action=InstallCloudAssistant&Version=2020-04-01&InstanceIds.1=i-ycm4ru8****&InstanceIds.2=iyclwwbhbls**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "InstallCloudAssistant",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstallingInstanceIds": ["i-ycm4ru8****","iyclwwbhbls****"],
        "pageSize": [
            {
                    "Id": "i-yci89z1gpml8j1****",
                    "ErrorMessage": "-"
             }
         ]
    }
}