获取 API Key
GET
/web/v1/workspaces/{workspaceId}/api-keys/{keyId}JWT通过业务 ID 获取单个 API Key 的详细信息。响应中不包含密钥值。
鉴权
Auth Chain: WEB Chain — 需要
Authorization: Bearer <jwt>需要工作空间 OWNER 角色。 以下请求头由系统自动注入(前端无需处理):X-PORTAL-ACCESS-CODE(Nginx),X-Request-Id(Gateway)
请求参数
| Name | Type | Required | In | Description |
|---|---|---|---|---|
workspaceId | string | Yes | path | 工作空间业务 ID |
keyId | string | Yes | path | API Key 业务 ID |
成功响应
成功200
{
"version": "1.3.0",
"timestamp": 1709337600000,
"success": true,
"code": "2000",
"message": "SUCCESS",
"data": {
"apiKeyId": "sk_live_abc123",
"name": "Production Key",
"status": "ACTIVE",
"mode": "LIVE",
"permissions": [
"payment:read",
"payment:write"
],
"ipWhitelist": [
"192.168.1.0/24"
],
"createdAt": "2026-03-21T00:00:00Z",
"lastUsedAt": "2026-03-21T12:00:00Z",
"createdBy": "acc_owner123"
}
}错误响应
未授权401
{
"success": false,
"code": "4010",
"message": "Invalid or expired token"
}未找到404
{
"success": false,
"code": "4040",
"message": "API key not found"
}说明
- API Key 密钥在初次创建后不会再返回。
- 仅工作空间 OWNER 可以获取 API Key 详情。