You need to enable JavaScript to run this app.
导航
InstallCloudAssistant
最近更新时间:2024.06.13 14:26:07首次发布时间:2023.09.04 15:43:19

调用InstallCloudAssistant接口,为指定实例安装批量作业客户端。

说明

通过本接口安装批量作业客户端后,还需调用RebootInstances接口重启实例,使客户端启动生效。

调试

请求参数

名称类型是否必填示例值描述
ActionStringInstallCloudAssistant要执行的操作,取值:InstallCloudAssistant。
VersionString2020-04-01接口的版本,取值:2020-04-01。

InstanceIds.N

String

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

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

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

返回数据

名称类型示例值描述
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-ycuq8r9ibkh9l3b****"
        ],
        "FailedInstances": []
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。