1. 接口描述
接口请求域名: hai.tencentcloudapi.com 。
本接口 (ResetInstancesPassword) 用于重置实例的用户密码。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ResetInstancesPassword。 |
Version | 是 | String | 公共参数,本接口取值:2023-08-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 是 | Array of String | 实例ID列表 示例值:['hai-2dfajzo4q'] |
Password | 是 | String | 实例密码必须8-30位,推荐使用12位以上密码,不能以“/”开头,至少包含以下字符中的三种不同字符,字符种类: 示例值:test@11111. |
DryRun | 否 | Boolean | 默认为False,True代表只验证接口连通性 示例值:False |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | task任务id 示例值:23898659 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实例重置密码
实例重置密码
输入示例
POST / HTTP/1.1
Host: hai.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResetInstancesPassword
<公共请求参数>
{
"InstanceIds": [
"hai-xxxx"
],
"DryRun": false,
"Password": "test#123456"
}
输出示例
{
"Response": {
"RequestId": "e188f45e-e2db-4c30-81e0-2e7a3dfa7754",
"TaskId": 232559186
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameterValue.Duplicated | 列表入参中存在重复值 |
InvalidParameterValue.InstanceIdNotFound | 指定的实例不存在 |
InvalidParameterValue.InvalidInstanceIdMalformed | 实例ID格式非法 |
InvalidParameterValue.InvalidPassword | 指定的密码不合规范。 |
OperationDenied.InstanceOperationInProgress | 指定实例有正在执行的操作,不能执行新的操作 |