> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/bmc/bare-metal-instance/resetinstanceipmipassword.md).

# ResetInstanceIpmiPassword

## 1. 接口描述

本接口(ResetInstanceIpmiPassword)用于设置裸金属实例的IPMI控制台登录密码。

{% hint style="info" %}
**注意事项**

* 设置成功后实例的IPMI控制台即开启，可通过 [DescribeInstanceIpmiUrl](/api-reference/cn/bmc/bare-metal-instance/describeinstanceipmiurl.md) 获取控制台访问地址。
* 登录IPMI控制台的用户名固定为 `operator`，密码为本接口设置的密码。
* 重装系统后IPMI控制台会被关闭，需要重新调用本接口设置密码。
* 密码必须以字母开头，长度为8-16个字符，可包含字母、数字以及特殊字符 `!@#+_,.`。
  {% endhint %}

## 2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

| 参数名称       | 必选 | 类型     | 描述                                                                                                 |
| ---------- | -- | ------ | -------------------------------------------------------------------------------------------------- |
| instanceId | 是  | String | 实例ID。                                                                                              |
| password   | 是  | String | <p>IPMI控制台密码。</p><p>必须以字母开头，长度为8-16个字符，可包含字母、数字以及特殊字符!@#+\_,.。</p><p>登录IPMI控制台的用户名固定为operator。</p> |

## 3. 响应结果

| 参数名称      | 类型     | 描述                                                       |
| --------- | ------ | -------------------------------------------------------- |
| requestId | String | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 设置实例的IPMI密码。**

```json
POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ResetInstanceIpmiPassword
<Common Request Params>

Request:
{
  "instanceId": "1234567890123456789",
  "password": "Abcd1234!"
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码                                                | 说明                                 |
| ------- | -------------------------------------------------- | ---------------------------------- |
| 404     | INVALID\_INSTANCE\_NOT\_FOUND                      | 实例不存在。                             |
| 403     | OPERATION\_DENIED\_INSTANCE\_RECYCLED              | 实例在回收站。                            |
| 400     | INVALID\_PARAMETER\_VALUE\_PASSWORD\_MALFORMED     | 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。 |
| 409     | OPERATION\_FAILED\_INSTANCE\_IPMI\_PASSWORD\_RESET | 设置实例IPMI密码失败。                      |