---
title: "修改实例备注别名"
method: PUT
path: "/user/instances/{id}/alias"
tags: ["用户管理"]
---

# 修改实例备注别名

`PUT /user/instances/{id}/alias`

## Request

- Base URL: `http://localhost:8888/api/v1`
- URL: `http://localhost:8888/api/v1/user/instances/{id}/alias`
- Auth: API key in header `Authorization`

仅实例所属用户可修改，最多128个字符；空字符串清空别名。只影响面板显示，实例原名、名称搜索和宿主机标识保持不变。

## Path parameters

- `id` integer, required

## Request body

- ProviderUpdateInstanceAliasRequest
  - `alias` string, required

## Response `200`

修改成功

- object
  - `code` integer
  - `data` ProviderInstanceAliasResponse
    - `alias` string
    - `id` integer
  - `message` string
  - `msg` string

## Other responses

- `400`: 参数错误
- `401`: 用户未登录
- `404`: 实例不存在或无权限

## Changes

- **2026-10-22** `feff9cdb702b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/oneclickvirt/apis/oneclickvirt-api/changes/user/instances/:id/alias/put.md)

---

[API](https://skmtc.dev/oneclickvirt/apis/oneclickvirt-api.md) - [All operations](https://skmtc.dev/oneclickvirt/apis/oneclickvirt-api/llms.txt) - [OpenAPI document](https://skmtc.dev/oneclickvirt/apis/oneclickvirt-api/revisions/feff9cdb702b?raw)