文档首页/ 数据库安全服务 DBSS/ API参考（联盟区域）/ API说明/ 审计实例/ 更新审计实例信息
更新时间：2025-12-31 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新审计实例信息

功能介绍

更新审计实例信息

调用方法

请参见如何调用API。

URI

PUT /v1/{project_id}/dbss/audit/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

instance_id

是

String

实例ID。可在查询实例列表接口的ID字段获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

实例名称。只能由中文字符,英文字母,数字,下划线,中划线组成的字符串,长度小于等于64。不能为空字符串。

comment

否

String

实例描述信息，只能由中文字符,英文字母,数字,下划线,中划线,空格组成的字符串，长度小于等于255。可以为空字符串。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

result

String

响应状态

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表6 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表8 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表10 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

请求示例

/v1/{project_id}/dbss/audit/instances/{instance_id}

{
  "name" : "DBSS-test1"
}

响应示例

状态码： 400

失败

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码

状态码

描述

200

成功

400

失败

403

认证失败

500

服务端错误

错误码

请参见错误码。

父主题： 审计实例