InstallCloudAssistant - 安装批量作业客户端--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

InstallCloudAssistant - 安装批量作业客户端

最近更新时间：2024.12.06 19:34:10首次发布时间：2023.09.04 15:43:19

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

使用说明

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

调试

API Explorer

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

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	InstallCloudAssistant	要执行的操作，取值：InstallCloudAssistant。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
InstanceIds.N	Array of String	是	InstanceIds.1=i-ervasv***&InstanceIds.2=i-uihrdgh***	实例ID，最多支持50个ID。您可以调用DescribeInstances接口查询获取实例ID。参数 - N：表示实例的序号。多个Instance ID之间用&分隔。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
InstallingInstanceIds	Array of String	["i-ycm4ru8**","iyclwwbhbls**" ]	已提交安装Agent的实例ID。
FailedInstances	Array of Object	--	符合条件的安装失败实例信息。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308301A86D*******",
        "Action": "InstallCloudAssistant",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstallingInstanceIds": [
            "i-ervasv*****"
        ],
        "FailedInstances": []
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.AccountId	The required parameter AccountId is not supplied.	用户ID不能为空。
400	MissingParameter.InstanceIds	The required parameter InstanceIds is not supplied.	实例 ID 不能为空。
400	LimitExceeded.MaximumInstanceIds	The specified InstanceIds exceeds the limit.	实例数量超出限制。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。