> 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/describeinstanceipmiurl.md).

# DescribeInstanceIpmiUrl

## 1. 接口描述

本接口(DescribeInstanceIpmiUrl)用于查询裸金属实例的IPMI控制台访问地址。

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

* 调用本接口前需要先通过 [ResetInstanceIpmiPassword](/api-reference/cn/bmc/bare-metal-instance/resetinstanceipmipassword.md) 设置IPMI密码，否则返回 OPERATION\_DENIED\_INSTANCE\_IPMI\_NOT\_ENABLED。
* 打开控制台地址后，使用用户名 `operator` 和通过 [ResetInstanceIpmiPassword](/api-reference/cn/bmc/bare-metal-instance/resetinstanceipmipassword.md) 设置的密码登录。
  {% endhint %}

## 2. 请求参数

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

| 参数名称       | 必选 | 类型     | 描述    |
| ---------- | -- | ------ | ----- |
| instanceId | 是  | String | 实例ID。 |

## 3. 响应结果

| 参数名称      | 类型     | 描述                                                                                                                                                                     |
| --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| requestId | String | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p>                                                                                                               |
| url       | String | <p>IPMI控制台访问地址。</p><p>登录用户名固定为operator，密码为通过 <a href="/api-reference/cn/bmc/bare-metal-instance/resetinstanceipmipassword.md">ResetInstanceIpmiPassword</a> 设置的密码。</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: DescribeInstanceIpmiUrl
<Common Request Params>

Request:
{
  "instanceId": "1234567890123456789"
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "url": "https://xxx.zenlayer.net/console/xxxx"
  }
}
```

{% 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               | 实例在回收站。                                                                                                                          |
| 409     | OPERATION\_DENIED\_INSTANCE\_IPMI\_NOT\_ENABLED     | 实例未开启IPMI控制台，需要先调用 [ResetInstanceIpmiPassword](/api-reference/cn/bmc/bare-metal-instance/resetinstanceipmipassword.md) 设置IPMI密码。 |
| 409     | OPERATION\_FAILED\_INSTANCE\_IPMI\_URL\_UNAVAILABLE | 获取实例IPMI控制台地址失败。                                                                                                                 |