跳转到主要内容
1签 (OneSign)

SessionIssued

本页内容

临时只读凭据的签发结果。首次取得时保存完整凭据组;幂等重放可能不再交付 credentials。

如何阅读本模型

先从下方相关接口确认该模型用于请求还是响应,再按字段层级读取。请求模型由调用方填写,响应模型由平台返回;同名字段在不同模型中可能含义不同。

应用、版本、任务和回执的区别见基本概念。需要一份可跟做的示例时,从相关接口进入对应产品指南。

字段定义

“必需”指字段所在的对象出现时,该字段是否必须存在。类型中含 null 表示值允许为空;未返回、null、空字符串和零分别处理。

字段必需说明
id 是

该条记录的公开标识。调用后续接口时请完整保留,包括前缀。

类型:string

查看取值约束
  • 格式 ^AKT[a-f0-9]{40}$
app_id 是

业务应用的完整 ID,来自列出应用或预留新应用的响应。

类型:string

查看取值约束
  • 格式 ^A[a-f0-9]{32}$
name 是

签发时填写的临时只读凭据名称。

类型:string

查看取值约束
  • 最多字符 80
actions 是

授权动作名称。查询或修改资源时仍须满足资源范围和来源 IP 条件。

类型:string[]

actions[] 是

数组中每个元素的取值要求。

类型:string

查看取值约束
  • 可选值 enterprise:ReadApps / enterprise:ReadVersions / enterprise:ReadJobs / distribution:ReadApps / distribution:ReadVersions / distribution:ReadSettings / enterprise:ReadStatistics / distribution:ReadStatistics / enterprise:ReadPricing / distribution:ReadPricing / enterprise:ReadVersionStatistics
rpm 是

每分钟最多允许的请求次数,同时受账号和 API 应用额度约束。

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 60
created_at 是

记录创建时间,Unix 秒。

类型:integer

expires_at 是

此临时凭据的截止时间,Unix 秒。

类型:integer

last_used_at 是

最近一次使用凭据的时间,Unix 秒。0 表示尚无记录。

类型:integer

state 是

当前记录的处理状态或请求筛选的状态。

类型:string

查看取值约束
  • 可选值 active / expired / revoked
  • active — 有效
  • expired — 已过期
  • revoked — 已撤销
credentials 是

首次成功签发时交付的 ID、Secret 与安全令牌。幂等重放时可能为 null。

类型:null | object

credentials.access_key_id 是

签名请求的凭据标识。

类型:string

查看取值约束
  • 格式 ^AKT[a-f0-9]{40}$
credentials.access_key_secret 是

用于本地计算签名的 Secret,在服务端安全保存。

类型:string

查看取值约束
  • 格式 ^CSK_[A-Za-z0-9_-]{43}$
credentials.security_token 是

临时会话令牌,AKT 请求须放进 X-Api-Security-Token。

类型:string

查看取值约束
  • 格式 ^CST_[A-Za-z0-9_-]{43}$

相关接口

下面根据接口定义列出使用本模型的操作,包括嵌套在其他对象中的情况。接口示例展示完整请求和响应;模型本身不会增加任何权限。

作为成功响应