ContextDB Data API 通用功能-云数据库 RDS(RDS)-阿里云帮助中心

本文介绍RDS ContextDB Data API的基础地址、鉴权方式，以及异步事件查询和健康检查接口。

公共信息

基础地址

https://context-database.aliyuncs.com

鉴权方式

所有数据面接口通过workspace级API Key鉴权，以下方式任选其一：

方式	Header格式
X-API-Key	`X-API-Key: <YOUR_API_KEY>`
Bearer	`Authorization: Bearer <YOUR_API_KEY>`

Data API概览

下表列出本文介绍的接口及其功能概述。

API	描述
GetEvent	查询单个异步事件的执行状态和结果。
Ping	健康检查与API Key校验。

Event API

GetEvent

接口说明

查询单个异步事件的执行状态和结果。事件不存在或无权限访问时返回400。

请求语法

GET /v1/event/{eventId}

请求参数

名称	类型	必填	描述	示例值
eventId	string	是	事件ID（路径参数）	`evt-abc123`

返回参数

名称	类型	描述	示例值
id	string	事件ID	`evt-abc123`
event_type	string	事件类型映射值	`ADD`
status	string	事件状态	`SUCCEEDED`
payload	object	事件载荷；无则为空对象	`{}`
metadata	object	元数据；当前为空对象	`{}`
results	array	执行结果；无则为空数组	`[{"memory_id":"mem-001"}]`
created_at	string	创建时间	`2026-07-01T08:00:00Z`
updated_at	string	更新时间	`2026-07-01T08:00:05Z`
started_at	string	开始执行时间；未开始为null	`2026-07-01T08:00:01Z`
completed_at	string	完成时间；未完成为null	`2026-07-01T08:00:05Z`
resource_type	string	关联资源类型	`memory`
resource_id	string	关联资源ID；可为null	`mem-001`
latency	integer	执行耗时；单位毫秒	`4000`

示例

正常返回：

{
  "id": "evt-abc123",
  "event_type": "ADD",
  "status": "SUCCEEDED",
  "payload": {},
  "metadata": {},

  "results": [ ],

  "created_at": "2026-07-01T08:00:00Z",
  "updated_at": "2026-07-01T08:00:05Z",
  "started_at": "2026-07-01T08:00:01Z",
  "completed_at": "2026-07-01T08:00:05Z",
  "resource_type": "memory",
  "resource_id": "mem-001",
  "latency": 4000
}

健康检查

Ping

接口说明

健康检查与API Key校验。

请求语法

GET /v1/ping

请求参数

无。

返回参数

名称	类型	描述	示例值
status	string	服务状态	`ok`
org_id	string	工作空间ID	`ws-001`
project_id	string	项目标识；固定值	`default`

示例

正常返回：

{
  "status": "ok",
  "org_id": "ws-001",
  "project_id": "default"
}