diff --git a/docs/organization/access-token.md b/docs/organization/access-token.md index a869f1dfc2f8584f61156a6b5a9483e4394f5678..8a70eab473c7cb0513fc592a9aaff79128d5eab8 100644 --- a/docs/organization/access-token.md +++ b/docs/organization/access-token.md @@ -1,9 +1,85 @@ # 访问令牌 +## 访问令牌 +### 功能描述 + 访问令牌用于验证您的身份,可通过访问令牌使用模型引擎 API、Serverless API 等功能。支持在个人和组织工作台下创建,可选择授权访问所有或指定可访问资源。 + - 个人创建的访问令牌,仅用于访问个人资源。 + - 组织创建的访问令牌,可访问组织下的资源,组织访问令牌需组织创建者和管理员创建,可将已保存的访问令牌,发送给组织成员使用。 +### 操作方式 + +可在"**工作台->设置->**[**访问令牌**](https://ai.gitee.com/dashboard/settings/tokens)"页面中查看、创建、编辑、删除"访问令牌"。 + +具体页面如下图所示: +![alt text](/img/organization/access-token-image2.png) + +### 授权方式 +1. 授权全部资源 + +**说明:** 授权所有购买的Serverless资源包时,如果同一个模型归属多个资源包,则按照有效且最新购买的资源包进行扣款。如果无需指定固定资源包,建议使用该方式。 + +2. 授权部分资源 + +**说明:** 如需指定固定资源进行扣款,可通过创建不同的"访问令牌"授权不同的资源来进行权限控制。建议通过创建多个"访问令牌"或购买多个不同的资源包进行授权,灵活使用实现权限控制。 + +### 常见问题 + +- 提示令牌无效,请核对"令牌"是否正确或检查令牌是否被删除无法使用。 + +- 提示令牌无任何可用资源,请核对"令牌"是否授权已购买资源,或检查授权资源是否过期或使用完毕。 + +:::warning +1. 系统默认会创建"**免费体验访问令牌**",该令牌用于给用户体验使用,无法编辑或删除,无需购买资源即可体验接口调用,使用该令牌不会产生任何扣费。该令牌体验次数有限制,请勿用于生产环境,如需正式使用请购买资源使用付费令牌。 + +2. 资源用量会提醒用户,收到提醒后建议尽早续费,避免影响后续使用。 +::: +___ + +## 临时令牌 + +"临时令牌"用于验证您的身份,该令牌有效期更短,可通过该令牌使用模型引擎 API、Serverless API 等功能。 + +为了安全起见,如果需要在客户端或浏览器中使用令牌,建议使用"临时令牌"。 + +### 操作方式 + +生成"访问令牌"后,调用API生成临时令牌,详情请看"[创建临时的Access Token](https://ai.gitee.com/docs/openapi/v1#tag/account/POST/account/temporary-token)"。 + +### 常见问题 + +- 提示"令牌无效",请核对"令牌"是否正确或绑定的"访问令牌"已删除或该令牌已失效 + +- 提示"令牌无任何可用资源",请核对绑定"访问令牌"是否授权已购买资源,或检查授权资源是否过期或使用完毕。 + +:::warning + +1. 创建的临时令牌是绑定在创建临时令牌鉴权的"访问令牌"上,因此该"访问令牌"权限变更及删除操作都会影响到临时令牌。建议单独创建一个"访问令牌"用于生成临时令牌,并且避免变更该令牌。 +::: +___ + +## 使用技巧 + +**1. 提升模型的并发能力** + +通过购买多个资源并创建多个“访问令牌”,每个令牌授权不同的资源。每个资源可以独立并发处理请求,从而实现客户端的并发能力提升。 + +**2. 实现不同环境的隔离** + +为每个环境购买独立的资源包,分别创建不同的“访问令牌”。各个环境使用专属的“访问令牌”,从而实现不同环境的完全隔离。 + +**3. 使用指定的资源包进行扣款** + +通过创建特定的“访问令牌”并授权指定资源,API 调用时使用对应的令牌,以确保资源消耗与扣费精确对应。 + +___ -已创建好的令牌请妥善保存在本地,以方便再次使用,请不要将其共享给他人或暴露在浏览器或其他客户端代码中。 +## 接口调用常见问题 -![alt text](/img/organization/accesstokenimg1.png) +| 状态码 | 异常信息(中文) | 异常信息(英文) | 备注 | +| --- | --- | --- |----------------------------------------------------------------------| +| 400 | 服务不存在 | Service not found | 请求路径不正确,请重新在体验接口中复制URL | +| 400 | 已达到最大当日免费API使用次数, 请购买资源后继续使用API。 | Today the free API access limit exceeded. | 当前调用接口的访问令牌为"**免费体验访问令牌**",每日限制接口调用次数,当前已达到最大调用次数,可付费购买资源包后配置付费访问令牌。 | +| 400 | 该令牌不能访问任何资源,请绑定或购买资源后使用 | The access token cannot access any resources, purchase or authorize resources to use the access token | 请核实该"访问令牌"是否授权已够买资源包,并且该资源包可用于调用该接口,可在"[**访问令牌**](https://ai.gitee.com/dashboard/settings/tokens)"界面进行重新配置。 | +| 400 | 资源未购买或未授权,请购买或授权资源后再使用 | Resources are not purchased or authorized. Purchase or authorize resources before using them. | 请核实是否已购买资源包或该资源包是否已用尽或过期,并且该访问凭证已授权该资源,可在"[**访问令牌**](https://ai.gitee.com/dashboard/settings/tokens)"界面进行重新配置或续费"[**资源包**](https://ai.gitee.com/dashboard/serverless)"。 | diff --git a/static/img/organization/access-token-image2.png b/static/img/organization/access-token-image2.png new file mode 100644 index 0000000000000000000000000000000000000000..ea2015a2560c1e64c22ad0b6e40c2e4886a0e33e Binary files /dev/null and b/static/img/organization/access-token-image2.png differ