文档

CreateDBLink - 创建DBLink

更新时间:

创建DBLink。

接口说明

DBLink可以连接两个PolarDB PostgreSQL版(兼容Oracle)集群,也可以连接PolarDB PostgreSQL版(兼容Oracle)集群和ECS自建PostgreSQL数据库。您可以通过DBLink跨集群查询数据。

说明
  • 一个集群最多可创建10条DBLink。
  • DBLink的源集群和目标集群均会占用自身1条DBLink。
  • 源集群与目标集群或目标ECS必须位于同一个地域。
  • 调试

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

    调试

    授权信息

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

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

    请求参数

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

    资源组ID。

    rg-************
    DBClusterIdstring

    DBLink的源集群ID。

    说明 您可以通过DescribeDBClusters接口查看PolarDB集群列表。
    pc-a************
    DBLinkNamestring

    DBLink名称。

    • 由小写字母、数字、下划线(_)其中一到三种组成,必须包含小写字母。
    • 以字母开头,字母或数字结尾。
    • 长度不超过64个字符。
    dblink_test
    TargetDBInstanceNamestring

    DBLink的目标集群ID。

    说明
  • 如果目标为ECS自建Oracle数据库,该参数请传入null
  • 您可以通过DescribeDBClusters接口查看PolarDB集群列表。
  • pc-b************
    TargetDBAccountstring

    目标数据库账号。

    说明 您可以通过DescribeAccounts接口查看PolarDB集群的数据库账号。
    testacc
    TargetDBPasswdstring

    目标数据库账号的密码。

    Test1111
    TargetDBNamestring

    目标数据库名称。

    说明 您可以通过DescribeDatabases接口查询PolarDB集群中的数据库信息。
    testdb2
    SourceDBNamestring

    源数据库名称。

    说明 您可以通过DescribeDatabases接口查询PolarDB集群中的数据库信息。
    testdb1
    TargetIpstring

    ECS自建Oracle数据库的IP地址。

    192.**.**.46
    TargetPortstring

    ECS自建Oracle数据库的端口号。

    1521
    VpcIdstring

    VPC ID。

    说明 可通过接口DescribeVpcs查看VPC信息详情。
    vpc-bp1qpo0kug3a20qqe****
    RegionIdstring

    地域ID。

    说明 可通过接口DescribeRegions查看地域信息详情。
    cn-hangzhou
    ClientTokenstring

    用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过64个ASCII字符。

    6000170000591aed949d0f54a343f1a4233c1e7d1c5c******

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求ID。

    F9F1CB1A-B1D5-4EF5-A53A-************

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "F9F1CB1A-B1D5-4EF5-A53A-************"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidDBLinkName.MalformedThe specified parameter DBLinkName is not valid.指定的参数DBLinkName无效。
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。
    404DBLinkSourceDBNotFoundSpecified source db does not exist.指定的源数据库不存在。

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

    变更历史

    变更时间变更内容概要操作
    2023-09-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 404 变更
      新增错误码:400
    • 本页导读 (0)
    文档反馈