---
title: "API 接入说明 - OB Cloud 云数据库 master | OceanBase 文档中心"
description: API 接入说明 本页面为您介绍 OB Cloud 数据库 Open API 的接入方式。 前提条件 获取 AccessKey ID、AccessKey Secret，详情参见 访问密钥管理 调用方式 OB Cloud 数据库 Open API 调用包含以下部分： 接口调用域名：不同地区请选择对应的域名，详情参见 服…
image: https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*OSPzQ6GUQF4AAAAAQHAAAAgAeiGDAQ/original
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*qbZXRo_94ZEAAAAAAAAAAAAADiGDAQ/original) OB Cloud 云数据库

# API 接入说明

更新时间：2026-06-06 19:35:31

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

## 前提条件

获取 AccessKey ID、AccessKey Secret，详情参见[访问密钥管理](https://www.oceanbase.com/docs/common-oceanbase-cloud-0000000002295194)

## 调用方式

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

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

### 请求头

| **名称** | **类型** | **是否必选** | **描述** | **示例值** |
| --- | --- | --- | --- | --- |
| X-Ob-Project-Id | string | 否 | 项目 ID。在请求头传入项目 ID，用于获取指定项目下的相关信息，如果没有传入 projectId，则默认获取当前账户最近登录的 projectId。 | li15c8s987d2arse******** |

### 调用 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"
  }

  ```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线