跳到主要内容

成员

成员属于 AISIX Cloud 组织。它们代表负责 Cloud 管理、API Key、用量和限制的人员或服务所有者。

AISIX Cloud 支持两种成员加入方式：

  • 当成员需要登录 Dashboard 时，邀请该成员。
  • 当你需要一个不登录 Dashboard 的 API Key Owner 时，直接创建成员。

两种方式都会创建组织成员。区别在于该成员是否会收到邀请，并是否可以使用 Dashboard。

邀请成员​

当某个人需要 Dashboard 访问权限来管理资源、查看用量或管理组织时，请使用邀请方式。

  1. 打开 Members，选择 Invite member。
  2. 输入成员邮箱并选择角色。
  3. 发送邀请，并分享一次性邀请链接。

受邀人打开链接、注册、设置密码后，会以所选角色加入组织。在受邀人接受前，该邀请会停留在 Pending invitations 标签页。

直接创建成员​

当成员只需要拥有 API Key，而不需要 Dashboard 访问权限时，可以直接创建成员。典型场景包括服务、应用，或在 Dashboard 访问受限的私有化部署中代表开发者。

直接创建的成员：

  • 会立即变为 active，不需要邀请链接或确认步骤。
  • 可以加入团队并分配 API Key。
  • 可以受限流和预算治理。
  • 没有密码，因此无法登录 Dashboard。

该成员仍然有名称和邮箱。请使用能够识别责任人、服务或应用所有者的值，以便正确归因用量和限制。

在 Dashboard 中操作​

  1. 打开 Members，选择 Create user。
  2. 输入能够识别责任归属的 Name 和 Email。
  3. 选择 Create user。

成员会立即出现在列表中。随后你可以将该成员加入团队，并从承载其流量的环境中签发 API Key。

使用 API​

当需要通过自动化供应成员时，请使用 API。

使用具有 write scope 的组织 Admin Token 认证。Admin Token 作用域绑定到一个组织，因此请求不需要额外的组织请求头。

curl -X POST "https://<your-cp-api-host>/api/members" \
  -H "Authorization: Bearer $AISIX_ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Responsible Person",
    "email": "svc-payments@example.com"
  }'

成功调用会返回 201 Created 和新成员：

{
  "member": {
    "id": "8f3b2a1c-9d4e-4f6a-b7c8-1e2d3f4a5b6c",
    "user_id": "2c7d6e5f-4a3b-4c2d-8e1f-9a0b1c2d3e4f",
    "email": "svc-payments@example.com",
    "display_name": "Responsible Person",
    "role": "member"
  }
}

邮箱地址必须有效，并且在部署内唯一。对于应用所有者，可以使用类似 svc-payments@example.com 的合成地址。复用已有邮箱会返回 409 Conflict。直接创建的成员始终使用 member 角色。

浏览和搜索成员​

Members 列表支持搜索和分页，便于管理大型组织。

  • 使用搜索框按名称或邮箱过滤。搜索在服务端执行，因此会匹配所有页面，而不只匹配当前页面中的行。
  • 使用列表下方控件调整页面大小或在页面之间切换。

使用 API 列出成员​

使用具有 read scope 的组织 Admin Token 认证。

curl "https://<your-cp-api-host>/api/members?page=1&page_size=20&q=payments" \
  -H "Authorization: Bearer $AISIX_ADMIN_TOKEN"

查询参数都是可选的：

  • q：对成员名称和邮箱执行不区分大小写的匹配。
  • page：从 1 开始的页码。需要同时设置 page_size；单独设置 page 会返回 400。
  • page_size：页面大小，最大为 200。如果同时省略 page 和 page_size，则禁用分页，并在单个响应中返回所有成员。

响应会在分页结构中包装成员列表：

{
  "data": [],
  "total": 128,
  "page": 1,
  "page_size": 20,
  "owner_count": 2
}

total 是所有页面中匹配过滤条件的成员数量，owner_count 是组织中的 Owner 数量。

下一步​

继续阅读连接托管网关，将网关接入为成员拥有的 API Key 承载流量的 Cloud 环境。