文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 实例管理/ 修改实例备注
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

修改实例备注

接口说明

修改实例的备注。

约束说明

不支持修改已删除实例。

URI

  • URI格式

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/remark

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

remark

是

String

实例备注内容。

长度不能超过64位，不支持回车和>!<"&'=特殊字符。
  • 请求示例 
    {
"remark":"test"
}

响应参数

响应示例 
{}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理