POST https://ark.cn-beijing.volcengineapi.com/?Action=GetRightAuthLetterApplicationSession&Version=2024-01-01
查询授权书免登申请会话的当前状态,并在授权书生成成功且未作废时获取文件名和短期下载地址。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
SessionId string 必选 | 申请会话 ID
申请会话 ID。填写调用 CreateRightAuthLetterApplicationSession 接口时返回并保存的 SessionId;仅可查询当前账号创建的会话。
不得包含首尾空白,UTF-8 编码后最多 64 字节。
响应参数#
Session object | 申请会话
查询到的授权书申请会话信息,包含申请会话 ID、当前状态以及按状态返回的授权书文件。
SessionId string | 申请会话 ID
Session.SessionId
本次授权书申请的会话 ID,与请求参数 SessionId 一致。
Status string | 申请状态
Session.Status
授权书申请的当前状态。
CREATED:申请入口已创建,用户尚未完成提交。引导用户打开创建接口返回并保存的申请链接。PROCESSING:用户已提交资料,平台正在处理申请或生成授权书。SUCCEEDED:授权书已生成成功且未作废,可通过 File.URL 下载。FAILED:授权书申请处理失败。停止等待;业务确认仍需申请后,创建新的会话。VOIDED:已生成的授权书被作废,不再返回文件。EXPIRED:用户未提交资料,申请入口已超过首次进入期限或总访问期限。旧入口不能继续使用;仍需申请时,创建新的会话。
File object | 授权书文件
Session.File
授权书文件信息。仅当 Status 为 SUCCEEDED 且授权书未作废时返回;其他状态不返回。
FileName string | 文件名
Session.File.FileName
授权书文件名。
URL string | 下载 URL
Session.File.URL
授权书文件的短期 HTTPS 签名下载地址。链接失效后,重新调用本接口即可获取新的下载地址,无需重新申请。