接口功能介绍
该接口提供用户更新轻量型云主机的密码功能,此接口为同步接口。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1. 使用限制,本接口只支持在部分资源池进行公测
2. 确保当前请求资源池下,该云主机存在(即instanceID真实存在且与regionID相对应)
3. 云主机需要处于开机状态(running),您可以调用查询轻量型云主机详情查询结果中的instanceStatus字段来确认当前云主机状态
URI
POST /v4/ecs/lite/reset-password
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 轻量型云主机ID,您可以查看轻量型云主机了解轻量型云主机的相关信息 获取: 查 查询轻量型云主机列表 创 创建轻量型云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a | |
newPassword | 是 | String | 用户密码,满足以下规则: 长度在8~30个字符; 必须包含大写字母、小写字母、数字以及特殊符号中的三项; 特殊符号可选:()`~!@#$%^&*_-+=|{}[]:;'<>,.?/\且不能以斜线号 / 开头; 不能包含3个及以上连续字符; Linux镜像不能包含镜像用户名(root)、用户名的倒序(toor)、用户名大小写变化(如RoOt、rOot等); Windows镜像不能包含镜像用户名(Administrator)、用户名大小写变化(adminiSTrator等) |
1qaz@WSX |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceID | String | 被更新密码的云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "aaf589124d5d11eaa04d0242ac110002",
"instanceID": "f21aa082-ded9-a7de-4588-e0ba5274e0f3",
"newPassword": "dfer35sdest3"
}
响应示例
{
"returnObj": {
"instanceID": "f21aa082-ded9-a7de-4588-e0ba5274e0f3"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码