文档

ModifyDBClusterDescription - 变更集群描述

更新时间:

修改指定集群的描述信息,方便集群的维护管理。

接口说明

当前服务的接入地址请参见服务接入点

调试

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

授权信息

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

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

请求参数

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

企业版、基础版或湖仓版的集群 ID。

amv-bp1r053byu48p****
DBClusterDescriptionstring

集群描述。

  • 不能以http://或者https开头;
  • 长度为 2~256 个字符。
adb_test

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidDBClusterDescription.MalformedThe specified parameter DBClusterDescription is not valid.DBClusterDescription参数不正确,请确认参数是否符合规范。
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
2023-03-31OpenAPI 错误码发生变更查看变更详情