CreateContextDatabaseWorkspace - 创建 ContextDB Workspace-云数据库 RDS(RDS)-阿里云帮助中心

创建业务空间、首位成员和首把 API Key 的一次性引导流程

接口说明

创建 workspace + 首位成员 + 首把 API Key 的一次性引导，返回明文 apiKey。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rdsai:CreateContextDatabaseWorkspace

create

*全部资源

*

无

请求语法

GET / HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkspaceName	string	是	业务空间名称	my-workspace
MemberName	string	是	首位成员名称	my-member
PermissionMode	string	否	创建工作区时选择的权限模式。可选值： `compatibility`：兼容模式。未传入本参数时使用此模式。 `advanced`：高级权限模式。仅主账号可选择，创建成功后立即生效，且创建后无法关闭。本参数为字符串，不是布尔开关。合法值忽略大小写及首尾空白；显式传入空字符串、纯空白或其他取值时，返回 `InvalidParameter`（HTTP 400）。RAM 子账号选择 `advanced` 时，返回 `NoPermission`（HTTP 403）。	advanced

返回参数

名称	类型	描述	示例值
	object	创建成功
ApiKey	string	明文 API Key，仅创建时返回一次，调用方需自行持久化	ctxdb-*****
ApiKeyName	string	首把 API Key 名称，固定为 default	default
CreatedAt	string	创建时间（ISO-8601 格式）	2026-05-28T17:59:55Z
MemberId	string	首位成员 ID	mb-cz51tnnp8****
MemberName	string	首位成员名称	my-member
PermissionMode	string	工作区创建完成后实际生效的权限模式，返回小写字符串： `personal_compatibility`：兼容模式，对应请求值 `compatibility`。 `advanced`：高级权限模式。该字段为可选字段。若响应中未返回，请通过工作区详情确认实际模式，不应仅因该字段缺失而重复创建工作区。	advanced
RequestId	string	请求 ID	FE9C65D7-930F-57A5-A207-8C396329****
Role	string	首位成员角色，固定为 owner	owner
Status	string	业务空间状态（Active：正常运行；Locked：欠费停机/过期锁定）	Active
Type	string	业务空间类型（personal：个人；enterprise：企业）	personal
WorkspaceId	string	新建业务空间 ID	ws-as1llqmkol****
WorkspaceName	string	业务空间名称	my-workspace

示例

正常返回示例

JSON格式

{
  "ApiKey": "ctxdb-*****",
  "ApiKeyName": "default",
  "CreatedAt": "2026-05-28T17:59:55Z",
  "MemberId": "mb-cz51tnnp8****",
  "MemberName": "my-member",
  "PermissionMode": "advanced",
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "Role": "owner",
  "Status": "Active",
  "Type": "personal",
  "WorkspaceId": "ws-as1llqmkol****",
  "WorkspaceName": "my-workspace"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Request parameter is invalid.	请求参数不合法。
401	Unauthorized	Unauthorized.
500	InternalError	Internal server error.	服务端处理请求失败。
403	NoPermission	Permission denied.	没有执行操作的权限。
502	UpstreamError	Upstream service returned an error.	上游服务返回错误。
404	ResourceNotFound	Resource not found.	指定资源不存在。
429	QuotaExceeded	Resource quota exceeded.	创建资源额度超限
409	ResourceAlreadyExists	Resource state conflict.	资源状态冲突。

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

变更历史

更多信息，参考变更详情。