文档

ModifyDBDescription - 修改数据库备注说明

更新时间:

该接口用于修改数据库的备注。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:ModifyDBDescriptionWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
DBNamestring

数据库名称。

testdb
DBDescriptionstring

数据库描述。

testdb01

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

17F57FEE-EA4F-4337-8D2E-9C23CAA63D74

示例

正常返回示例

JSON格式

{
  "RequestId": "17F57FEE-EA4F-4337-8D2E-9C23CAA63D74"
}

错误码

HTTP status code错误码错误信息描述
400Database.ConnectErrorDatabase connect error. please check instance status and database processlist数据库连接异常,请检查实例状态及数据库的连接池
400IncorrectDBInstanceLockMode.ValueNotSupportedThe Current DB instance lock mode does not support this operation.操作失败,当前数据库实例锁模式不支持此操作。
400InvalidDBDescription.FormatSpecified DB description is not valid.DB描述不规范,请检查。
400InvalidDBName.NotFoundSpecified DB name does not exist.指定的数据库名称不存在。请输入正确的数据库账号名称。
400Database.UpdateErrorUpdate Db failed, please check input value and instance status.更新数据库失败,请检查输入参数及实例状态。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
403IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.操作失败,当前数据库实例引擎和类型不支持。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2022-10-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    新增错误码:403
    新增错误码:404
2022-06-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)
文档反馈