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

修改实例备注

接口说明

修改实例的备注。

约束说明

不支持修改已删除实例。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

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

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/remark

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

参数解释：

从IAM服务获取的用户Token。请参考认证鉴权。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

project_id

string

path

是

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

string

path

是

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求消息

  • 参数说明
    表2 请求Body参数

    参数

    是否必选

    参数类型

    描述

    remark

    是

    String

    参数解释：

    实例备注内容。

    约束限制：

    长度不能超过64位，不支持回车和>!<"&'=特殊字符。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求示例

修改实例备注为test。 
{
"remark":"test"
}

响应消息

响应示例 
{}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理

相关文档