将复制 REST API 用于 Db2

重要信息: IBM Cloud Pak for Data 4.7 版本将于 2025 年 7 月 31 日结束支持 (EOS)。 欲了解更多信息,请参阅 IBM Cloud Pak for Data 版本 4.X 的停止服务公告

IBM Cloud Pak for Data 4.7 版本支持结束之前,升级到 IBM Software Hub 5.1 版本。 更多信息,请参阅 IBM Software Hub 版本 5.1 文档中的升级 IBM Software Hub。

复制提供了交互式 API 控制台,使您能够在使用产品 REST API 调用来自动执行复制运行状况检查或设置任务之前查看并尝试这些调用。

关于本任务

复制 REST API 使您能够灵活地开发自己的应用程序以使用复制功能,例如,根据业务需求定制特定类型的用户界面。 您可以使用 API 来执行以下功能以及其他功能:

运行状况
监视复制环境的运行状况
复制集
  • 创建,更新,删除,列示,启动,停止,添加或除去表
  • 对表启动或停止复制
  • 将模式级预订添加到集合,将其从集合中除去,然后启动或停止模式级预订
  • 监视复制集,获取历史度量数据
启用复制,激活复制,检查需求,检查 SSL 证书,验证连接,检查或更新凭证
目标
初始化,检查需求,验证连接,信任和交换证书,更新凭证,监视调用

过程

  1. 在 Web 浏览器中启动控制台。
    https://hostname:port/api/explorer

    其中 hostname 是运行源数据库的集群的主机名, port 是复制 REST API 服务器的外部端口号。

    要查找 REST 外部端口号,请运行以下命令:
    oc get svc -n ${PROJECT_CPD_INST_OPERANDS} | grep qrep
    结果应类似于以下示例:
    [root@api.db2u-dr4.cp.fyre.ibm.com ~]# oc get svc | grep db2
    c-db2oltp-1630636239936781-db2u                ClusterIP   172.30.56.242    <none>        50000/TCP,50001/TCP,25000/TCP,25001/TCP,25002/TCP,25003/TCP,25004/TCP,25005/TCP   33d
    c-db2oltp-1630636239936781-db2u-engn-svc       NodePort    172.30.33.105    <none>        50000:30350/TCP,50001:31715/TCP                                                   33d
    c-db2oltp-1630636239936781-db2u-internal       ClusterIP   None             <none>        50000/TCP,9443/TCP,50052/TCP                                                      33d
    c-db2oltp-1630636239936781-etcd                ClusterIP   None             <none>        2379/TCP,2380/TCP                                                                 33d
    c-db2oltp-1630636239936781-qrep-mq-svc         NodePort    172.30.91.42     <none>        1414:31535/TCP,1415:31667/TCP                                                     33d
    c-db2oltp-1630636239936781-qrep-rest-svc       NodePort    172.30.89.122    <none>        9444:31313/TCP
    查找 c-instance-ID-qrep-rest-svc 条目。 右列中的值包含复制端口号,在此示例中为 9444:31313/TCP31313 部分是复制端口号。
  2. 单击其中一个 API 类别以将其打开。
    单击 "获取" 以打开运行状况 API 调用
  3. 单击 用于打开授权窗口的图标 图标,输入有权在复制源系统上运行命令和访问源数据库的用户 ID 和密码。
    授权窗口

    实现说明 字段描述 API 调用的用途。 响应消息 字段显示可以在应用程序或脚本中使用的来自调用的返回码。

  4. 要查看 API 调用的使用情况信息和响应,请单击 试用!

    此图显示了 "运行状况" 部分中的按钮:

    请试一试! 按钮

    UI 生成以下信息:

    cURL 命令
    API 请求显示为 Curl 命令,您可以将该命令复制到命令 shell 或脚本中。
    注: 如果要在 API 控制台外部运行 curl 命令,请指定以下选项:
    • 用户认证 (-u 或 --user) )
    • 如果未在环境中安装 CA 签名的证书,请使用不安全的选项 (-k--insecure)
    要获取其他帮助,请运行 curl -- help 命令。
    请求 URL
    当网络客户端向服务器请求资源时使用的 URL。
    响应主体
    从 API 调用返回的 Java 代码,您可以将其合并到应用程序中。
    响应代码
    从 API 调用返回的响应代码。
    响应头
    HTTP中使用的 HTTP ,与消息内容无关。

    对于要求您以指定格式提供输入参数的 API,控制台会显示示例参数值,例如 dbHost, dbPort, 或 dbName。 例如,以下图像显示源数据库连接的示例值:

    源数据库连接的样本输入参数值
    定位格

    源数据库连接的更多示例输入参数值