UpgradeCloudAssistants--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

UpgradeCloudAssistants

最近更新时间：2024.06.13 14:26:07首次发布时间：2024.01.09 10:54:52

调用UpgradeCloudAssistants接口，为云服务器实例升级已安装的批量作业客户端至最新版本。

调试

API Explorer

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

去调试

请求参数

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

名称

类型

是否必填

示例值

描述

Action

String

是

UpgradeCloudAssistants

要执行的操作，取值：UpgradeCloudAssistants。

Version

String

是

2020-04-01

接口的版本，取值：2020-04-01。

InstanceIds.N

String

是

InstanceIds.1=i-ycm4ru8****&InstanceIds.2=i-yclwwbhblsggsw5****

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

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

返回数据

名称	类型	示例值	描述
UpgradingInstanceIds	List	["i-ycm4ru8**","i-yclwwbhblsggsw5**" ]	成功提交升级请求的实例ID列表。
FailedInstances	Array of Struct	-	符合条件的升级失败实例信息。具体请参见下表“FailedInstance 结构”。

FailedInstance 结构

名称	类型	示例值	描述
Id	String	i-yci89z1gpml8j1****	升级失败的实例ID。
ErrorMessage	String	-	失败信息，取值：实例[i-ycm4rsfatu8**]客户端已升级到最新版本。实例[i-yclblsggsw5]未安装客户端。实例[i-stag4g2ys8**]客户端状态不在运行中。

名称

类型

示例值

描述

String

i-yci89z1gpml8j1****

升级失败的实例ID。

ErrorMessage

String

失败信息，取值：

实例[i-ycm4rsfatu8****]客户端已升级到最新版本。
实例[i-yclblsggsw5****]未安装客户端。
实例[i-stag4g2ys8****]客户端状态不在运行中。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "UpgradeCloudAssistants",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstallingInstanceIds": [
            "i-ycuq8r9ibkh9l3b****",
            "i-yclwwbhblsggsw5****"
        ],
        "FailedInstances": []
    }
}

错误码

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