全部产品
Search
文档中心

云原生数据库 PolarDB:CheckDBName - 校验数据库名称是否合法

更新时间:Jun 17, 2024

校验数据库名称是否合法或当前集群中是否已存在重名的数据库。

调试

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

授权信息

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

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

请求参数

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

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息,包括集群 ID。
pc-****************
DBNamestring

数据库名称。

test_db

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

CDB3258F-B5DE-43C4-8935-CBA0CA******
DBNamestring

数据库名称

test_db
  • 若输入的数据库名称不合法,会返回错误信息Specified DB name is not valid
  • 若输入的数据库名称与已有数据库名称重复,会返回错误信息Specified DB name already exists

示例

正常返回示例

JSON格式

{
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "DBName": "test_db"
}

错误码

HTTP status code错误码错误信息描述
400InvalidDBName.DuplicateThe specified DB name already exists.操作失败,指定的数据库名称已存在。
400InvalidAccountName.MalformedThe specified parameter AccountName is not valid.指定的参数AccountName无效。
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效
404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    新增错误码:404