批量重置弹性云服务器密码
功能介绍
批量重置弹性云服务器管理账号(root用户或Administrator用户)的密码。
接口约束
- 使用此API,需预先安装重置密码插件。一键式重置密码插件的下载与安装,请参见《弹性云服务器用户指南》的“安装一键式重置密码插件”章节。
- 弹性云服务器的重置密码请求下发后,脚本执行失败,该API不会报错。
- 弹性云服务器开机或重启后,新密码生效。
- 该接口支持虚拟机状态为开机或者关机状态下执行。
调试
您可以在API Explorer中调试该接口。
请求消息
请求参数如表2所示。
|
参数 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
new_password |
String |
是 |
新密码。 当dry_run字段为true时,该字段为非必填字段,否则为必填字段。
新密码的校验规则:
|
|
dry_run |
Boolean |
否 |
是否只预检此次请求。
默认值:false |
|
servers |
Array of objects |
是 |
待批量重置密码的弹性云服务器ID信息,详情参见 表3。 |
响应消息
响应参数请参见 响应(批量操作类) 所示。
请求示例
批量重置ID为“1bd0eb17-4466-4c15-a9ce-87727ad311b5”和“fd6b6e9d-64a1-40fa-b7dc-f491be42fdd2”的云服务器的密码,建议将密码在配置文件或者环境变量中密文存放,使用时解密,确保安全。
PUT https://{endpoint}/v1/{project_id}/cloudservers/os-reset-passwords
{
"new_password": "$ADMIN_PASS",
"dry_run": true,
"servers": [
{
"id":"1bd0eb17-4466-4c15-a9ce-87727ad311b5"
},
{
"id":"fd6b6e9d-64a1-40fa-b7dc-f491be42fdd2"
}
]
}
响应示例
响应示例请参见响应(批量操作类)所示。
{
"response": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
},
{
"id": "516fb98f-46ca-475e-917e-2563e5a8cd12"
}
]
}
返回值
请参考通用请求返回值。
错误码
请参考错误码。