1. 接口描述
接口请求域名: bm.tencentcloudapi.com 。
重装操作系统
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ReloadDeviceOs。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 设备的唯一ID |
Password | 是 | String | 密码。 用户设置的linux root或Windows Administrator密码。密码校验规则: [a-z] ,[A-Z] ,[0-9] 和[() '~!@#$%^&*-+=_ |{}[]:;'<>,.?/] 的特殊符号, 密码不能包含Administrator(不区分大小写); [a-z,A-Z] ,[0-9] 和[() '~!@#$%^&*-+=_ |{}[]:;'<>,.?/] 的特殊符号 |
OsTypeId | 否 | Integer | 操作系统类型ID。通过接口查询操作系统信息(DescribeOsInfo)获取操作系统信息 |
RaidId | 否 | Integer | RAID类型ID。通过接口查询机型RAID方式以及系统盘大小(DescribeDeviceClassPartition)获取RAID信息 |
IsZoning | 否 | Integer | 是否格式化数据盘。0: 不格式化(默认值);1:格式化 |
SysRootSpace | 否 | Integer | 系统盘根分区大小,默认是10G。系统盘的大小参考接口查询机型RAID方式以及系统盘大小(DescribeDeviceClassPartition) |
SysSwaporuefiSpace | 否 | Integer | 系统盘swap分区或/boot/efi分区的大小。若是uefi启动的机器,分区为/boot/efi ,且此值是默认是2G。普通机器为swap分区,可以不指定此分区。机型是否是uefi启动,参考接口查询设备型号(DescribeDeviceClass) |
SysUsrlocalSpace | 否 | Integer | /usr/local分区大小 |
VpcId | 否 | String | 重装到新的私有网络的ID。如果改变VPC子网,则要求与SubnetId同时传参,否则可不填 |
SubnetId | 否 | String | 重装到新的子网的ID。如果改变VPC子网,则要求与VpcId同时传参,否则可不填 |
LanIp | 否 | String | 重装指定IP地址 |
HyperThreading | 否 | Integer | 指定是否开启超线程。 0:关闭超线程;1:开启超线程(默认值) |
ImageId | 否 | String | 自定义镜像ID。传此字段则用自定义镜像重装 |
FileSystem | 否 | String | 指定数据盘的文件系统格式,当前支持 EXT4和XFS选项, 默认为EXT4。 参数适用于数据盘和Linux, 且在IsZoning为1时生效 |
NeedSecurityAgent | 否 | Integer | 是否安装安全Agent,取值:1(安装) 0(不安装),默认取值0 |
NeedMonitorAgent | 否 | Integer | 是否安装监控Agent,取值:1(安装) 0(不安装),默认取值0 |
NeedEMRAgent | 否 | Integer | 是否安装EMR Agent,取值:1(安装) 0(不安装),默认取值0 |
NeedEMRSoftware | 否 | Integer | 是否安装EMR软件包,取值:1(安装) 0(不安装),默认取值0 |
ReserveSgConfig | 否 | Integer | 是否保留安全组配置,取值:1(保留) 0(不保留),默认取值0 |
SysDataSpace | 否 | Integer | /data分区大小,可不填。除root、swap、usr/local的剩余空间会自动分配到data分区 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | 黑石异步任务ID |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 重装操作系统
输入示例
https://bm.tencentcloudapi.com/?Action=ReloadDeviceOs
&InstanceId=cpm-xxx
&Password=123456Test
&OsTypeId=1
&VpcId=vpc-xxxxx
&SubnetId=subnet-xxxxx
&RaidId=2
&IsZoning=1
&SysRootSpace=20
&SysSwaporuefiSpace=10
&SysUsrlocalSpace=10
&LanIp=10.88.255.6
&HyperThreading=1
&NeedSecurityAgent=1
&NeedMonitorAgent=1
&<公共请求参数>
输出示例
{
"Response": {
"TaskId": 123,
"RequestId": "e9825743-cfaf-43a1-85be-9c99966430dd"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.ExistRepairTask | 存在未结束故障单,操作失败。 |
InvalidParameter | 参数错误。 |
UnsupportedOperation | 操作不支持。 |