CreateContextDatabaseWorkspace - 创建 ContextDB Workspace

更新时间:
复制 MD 格式

创建上下文数据库工作区及首位成员,并按需生成初始 API Key。

接口说明

创建上下文数据库工作区及首位成员。

  • GenerateInitialKey 默认为 true,创建时生成首把 API Key,并返回一次明文密钥;请保存返回的密钥。设置为 false 时不生成初始 API Key,响应中的 ApiKeyName 和 ApiKey 无值。

  • 可通过 ClusterId 指定工作区所属集群。

  • 可通过 PermissionMode 选择兼容模式或高级权限模式。高级权限模式仅支持主账号选择,创建成功后立即生效,且无法关闭。

调试

您可以在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

ClusterId

string

否

工作区所属集群的 ID。可选。

  • 不传入:沿用账号独享存储优先的集群选择逻辑。

  • default:使用共享集群。

  • 以 acc- 开头的集群 ID:使用所属专属集群。

default

MemberName

string

否

创建工作区时首位成员的名称。该参数为可选参数。

my-member

GenerateInitialKey

boolean

否

是否生成初始 API Key。可选,默认值为 true。

  • true:生成首把 API Key,并返回密钥名称和明文密钥。

  • false:不生成初始 API Key,响应中的 ApiKeyName 和 ApiKey 无值。

true

PermissionMode

string

否

创建工作区时选择的权限模式。可选值:

  • compatibility:兼容模式。不传入本参数时使用此模式。

  • advanced:高级权限模式。仅主账号可选择,创建成功后立即生效,且创建后无法关闭。

本参数为字符串,不是布尔开关。合法值忽略大小写及首尾空白。显式传入空字符串、纯空白或其他取值时,返回 InvalidParameter(HTTP 400);RAM 子账号选择 advanced 时,返回 NoPermission(HTTP 403)。

advanced

返回参数

名称

类型

描述

示例值

object

创建成功

RequestId

string

请求 ID

FE9C65D7-930F-57A5-A207-8C396329****

ClusterId

string

工作区所属集群的 ID。共享集群返回 default,专属集群返回对应的集群 ID。

default

WorkspaceId

string

新建业务空间 ID

ws-as1llqmkol****

WorkspaceName

string

业务空间名称

my-workspace

MemberId

string

首位成员 ID

mb-cz51tnnp8****

MemberName

string

首位成员名称

my-member

Role

string

首位成员角色,固定为 owner

owner

ApiKeyName

string

首把 API Key 的名称,生成时名称为 default。GenerateInitialKey 为 false 时,该字段无值。

default

ApiKey

string

首把 API Key 的明文密钥,仅在创建时返回一次,请自行保存。GenerateInitialKey 为 false 时,该字段无值。

ctxdb-*****

Type

string

业务空间类型(personal:个人;enterprise:企业)

personal

Status

string

业务空间状态(Active:正常运行;Locked:欠费停机/过期锁定)

Active

CreatedAt

string

创建时间(ISO-8601 格式)

2026-05-28T17:59:55Z

PermissionMode

string

工作区创建完成后实际生效的权限模式,返回小写字符串:

  • personal_compatibility:兼容模式,对应请求值 compatibility。

  • advanced:高级权限模式。

该字段为可选字段。若响应中未返回,请通过 GetContextDatabaseWorkspace 查询工作区详情以确认实际模式,不应仅因该字段缺失而重复创建工作区。

advanced

ConsolePermissionMode

string

服务端解析本次调用身份时使用的权限模式。取值:

  • personal_compatibility:兼容模式。

  • advanced:高级权限模式。

该字段描述本次调用的身份上下文;工作区的实际权限模式以 PermissionMode 为准。 创建工作区使用账号级身份上下文,该字段可无值。

advanced

Viewer

object

本次调用的访问者身份信息,包括身份解析模式、调用方账号类型及成员信息。成员相关字段为可选字段。

IdentityMode

string

本次调用的身份解析模式。取值:

  • account_compatibility:账号兼容身份模式。

  • bound_member:绑定成员身份模式。

身份解析模式与工作区的权限模式是不同概念,不能据此推断工作区是否已开启高级权限。

account_compatibility

CallerType

string

本次调用方的账号类型,例如 customer。该字段描述调用方账号,不表示工作区成员的角色。

customer

BoundMemberId

string

本次调用身份信息中绑定的工作区成员 ID。可选;未提供绑定成员信息时无值。

member-example

BoundMemberRole

string

绑定成员在工作区中的角色,例如 Owner。可选;未提供绑定成员角色信息时无值。

Owner

BoundMemberStatus

string

绑定成员的状态,例如 active。可选;未提供绑定成员状态信息时无值。

active

SelectedMemberId

string

账号兼容身份模式下选中的工作区成员 ID。可选;本次调用未选择成员时无值。该字段与绑定成员 ID 分别表示成员选择结果和绑定关系。

member-example

Capabilities

object

本次调用的账号级能力信息,仅表示账号兼容适配器可执行的操作,不代表资源级授权。该字段为可选字段,未提供账号级可执行操作时不返回。

ExecutableActions

array

账号兼容适配器可执行的操作名称列表。列表内容不代表针对具体资源的读写、成员组或访问控制授权。

string

单个操作的名称。示例仅说明操作名称格式,实际可执行操作以本次返回的列表为准。

ListContextDatabaseMembers

示例

正常返回示例

JSON格式

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "ClusterId": "default",
  "WorkspaceId": "ws-as1llqmkol****",
  "WorkspaceName": "my-workspace",
  "MemberId": "mb-cz51tnnp8****",
  "MemberName": "my-member",
  "Role": "owner",
  "ApiKeyName": "default",
  "ApiKey": "ctxdb-*****",
  "Type": "personal",
  "Status": "Active",
  "CreatedAt": "2026-05-28T17:59:55Z",
  "PermissionMode": "advanced",
  "ConsolePermissionMode": "advanced",
  "Viewer": {
    "IdentityMode": "account_compatibility",
    "CallerType": "customer",
    "BoundMemberId": "member-example",
    "BoundMemberRole": "Owner",
    "BoundMemberStatus": "active",
    "SelectedMemberId": "member-example"
  },
  "Capabilities": {
    "ExecutableActions": [
      "ListContextDatabaseMembers"
    ]
  }
}

错误码

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. 指定资源不存在。
503 ServiceUnavailable Dependent service is not configured or unavailable.
503 PermissionModeUnavailable Workspace permission mode is temporarily unavailable.
429 QuotaExceeded Resource quota exceeded. 创建资源额度超限
409 ResourceAlreadyExists Resource state conflict. 资源状态冲突。

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

变更历史

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