API 访问

NSD 管理 API 用于把资产查询、授权配置和审计接入脚本、CI 或业务后端。进入 开发者 → API 访问,为每个集成单独创建一个个人访问令牌;令牌以 nsda_ 开头,明文只显示一次。

服务端调用令牌只进入受控后端、CI 密钥或密钥管理系统,不放入浏览器前端。
最小作用域每个集成独立令牌,优先只读和最短可用有效期。
完整契约API 参考列出参数、请求体、成功响应、错误状态和 JSON 示例。
安全边界

API 只返回当前令牌有权访问的资源。调用前核对令牌所属 Network 与作用域;管理员角色变化、账号停用或令牌吊销后,请相应调整集成。

不要混用两类凭据

凭据在哪里创建用途不能做什么
NSD 个人访问令牌 nsda_…开发者 → API 访问调用 NSD 管理 API不能超过创建者当前角色和权限
公网入口工作负载凭据公网访问 → 工作负载凭据用 API Key、Basic、mTLS 或 Signed URL 访问已发布应用不能调用 NSD 管理 API

两类凭据在认证链路和授权对象上相互隔离。工作负载 API Key 即使泄露,也不能被当作管理令牌使用。

创建最小权限令牌

  1. 打开 开发者 → API 访问,点击 创建令牌。
  2. 用集成用途命名,例如 inventory-readonly 或 billing-sync,不要用“test1”一类无法追踪的名称。
  3. 选择最小作用域和最短可用有效期。默认建议 只读 + 90 天。
  4. 创建后立即把明文保存到密钥管理系统。关闭弹窗后无法再次读取,只能创建新令牌并吊销旧令牌。

创建后列表只显示名称、前缀、作用域、状态、最近使用与过期时间。令牌前缀用于识别,不可用于还原秘密;完整令牌不会再次返回。

作用域实际权限适用场景
只读仅允许 GET、HEAD、OPTIONS清单同步、监控、报表,默认选择
Signed-URL 签发仅允许为符合条件的公网入口签发 Signed URL业务后端按需生成临时访问链接
完全允许读写,但仍受创建者当前角色和权限限制确实需要修改配置的受控自动化

用户被停用、令牌过期或令牌被吊销后,认证立即失败。创建者角色被收窄时,令牌也不会保留更高权限。

发起第一个请求

页面的“接入 API”区域按行提供 API Base URL、鉴权请求头、验证当前身份命令,每行右侧都可复制。验证命令完整显示,换行符可直接粘贴到终端;它使用环境变量,不包含你的令牌明文。

NSD API 访问页面:连接参数、请求头、验证命令与个人访问令牌
在 API 访问页获取当前服务地址、查看请求示例并管理令牌。请使用自己控制台显示的地址。

Base URL 是当前 NSD 地址加 /api/v1。不要把令牌直接写进命令历史、源码或流水线日志;使用环境变量或密钥注入。

export NSD_BASE_URL='https://nsd.example.com/api/v1'
export NSD_TOKEN='nsda_...'

curl -fsS "$NSD_BASE_URL/me" \
  -H "Authorization: Bearer $NSD_TOKEN" \
  -H 'Accept: application/json'

返回当前用户和 Network 信息表示鉴权成功。随后先调用一个只读资源确认可见范围,再用预期会被拒绝的操作验证最小权限边界。

最小集成模板

  1. 启动时从密钥管理系统读取 NSD_TOKEN,不把值写入日志。
  2. 设置连接、读取和总体超时,并限制最大响应体。
  3. 对 429 和可恢复的 5xx 使用带抖动的指数退避;不要重试 400、401 或权限明确不足的 403。
  4. 分页读取时保存服务端返回的 opaque cursor,不自行解析或拼接。
  5. 变更请求失败后重新读取当前资源,不盲目覆盖冲突状态。

正确处理响应

状态码含义应如何处理
200 / 201请求成功按响应结构处理;不要依赖未文档化字段
400请求格式或字段不合法修正请求,不要原样重试
401令牌缺失、错误、过期或已吊销换用有效令牌;不要探测具体失败原因
403身份有效但角色或作用域不足缩小操作,或由有权用户重新创建合适令牌
404资源不存在,或当前 Network 不可见核对稳定 ID 和当前 Space
409当前状态与变更冲突重新读取资源后再决定是否提交
429触发限流遵循 Retry-After,使用退避并避免并发风暴

错误响应使用 application/problem+json。自动化应依据 HTTP 状态和稳定错误代码分支,不要解析面向用户的提示文案。

为什么不提供浏览器内 Try it

管理令牌不应进入公开文档站点、浏览器本地存储或第三方脚本。示例使用可复制的 curl 和完整 JSON 契约,真实调用应在受控终端、CI 或后端执行。

轮换与吊销

  1. 在旧令牌仍有效时创建相同最小作用域的新令牌。
  2. 更新密钥管理系统并让调用方重新加载。
  3. 用新令牌验证成功路径与拒绝路径。
  4. 在 NSD 列表中吊销旧令牌,确认旧令牌返回 401。

每个集成使用独立令牌后,单独轮换或吊销不会影响其他系统。发现泄露时先吊销,再调查活动日志;不要等待原有效期结束。

合法请求/me 和获授权资源返回当前 Network 的准确数据。
越权请求只读令牌执行写操作稳定返回 403。
失效请求过期或吊销令牌稳定返回 401,且不会泄露具体原因。

下一步:查看受支持的 API 参考 · 配置 Webhook