API 接入说明

本页面为您介绍 OB Cloud 数据库 Open API 的接入方式。

前提条件

获取 AccessKey ID、AccessKey Secret，详情参见访问密钥管理

调用方式

OB Cloud 数据库 Open API 调用包含以下部分：

• 接口调用域名：不同地区请选择对应的域名，详情参见服务接入点。
• Open API 密钥：需要公钥和私钥进行身份验证。
• 请求方式：当通过 POST、PATCH 或 PUT 向资源提交数据时，必须使用 JSON 提交有效载荷。

请求头

调用 Open API 终端节点

将 AccessKey ID、 AccessKey Secret填写为对应的 ID 和密钥，在终端中运行如下命令：

```
curl  --digest   -u 'AccessKey ID:AccessKey Secret' \
    --request GET \
    -H 'X-Ob-Project-Id':'projectId' \
    --url   https://< Open API 域名>/< Open API 请求 path> 
```

返回示例

• 成功调用后，响应中的状态代码为 200，您将看到了接口中的详细信息：

  {
      "success":true,
      "data":{
      },
      "requestId":"request-id-uuid"
  }
  

• 调用失败后，您将收到除 200 以外的状态代码，返回内容如下：

  {
      "success":false,
      "errorCode":"E001R000",
      "errorMessage":"未知错误",
      "requestId":"uuid"
  }