# 查询授权书免登申请会话

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

`POST https://ark.cn-beijing.volcengineapi.com/?Action=GetRightAuthLetterApplicationSession&Version=2024-01-01`

查询授权书免登申请会话的当前状态，并在授权书生成成功且未作废时获取文件名和短期下载地址。

> **说明：查询建议**
>
> * 当 *Status* 为 `CREATED` 或 `PROCESSING` 时，建议每隔 5～10 秒查询一次，具体频率可按业务需要调整。
> * 查询暂时出错或本轮等待超时不代表申请失败。请保存 *SessionId*，稍后继续查询同一会话，不要因此重复创建申请。
> * 失败或过期的申请记录从会话创建起保留 15 天，之后可能无法查询，请及时保存需要的业务结果。

> **说明：错误处理**
>
> * `MissingParameter.SessionId`：缺少申请会话 ID。补齐 *SessionId* 后重新请求。
> * `InvalidParameter.*`：申请会话 ID 不合法。按参数说明修正后重新请求。
> * `ResourceNotFound.RightAuthLetterApplicationSession`：当前账号下找不到指定会话。检查调用账号和 *SessionId*；已清理的记录也无法查询。
> * `InternalError`：服务内部错误。可稍后重试；多次重试仍失败时，记录响应中的 *RequestId* 并联系技术支持。

## 鉴权

本接口支持鉴权方式如下，详情请参见 [Base URL 及鉴权](/docs/base-url-and-authentication)。

* Access Key 鉴权，请在 [Access Key 管理](https://console.volcengine.com/iam/keymanage) 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。

---

<span id="request-parameters"></span>
## 请求参数

### 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`：用户未提交资料，申请入口已超过首次进入期限或总访问期限。旧入口不能继续使用；仍需申请时，创建新的会话。

> **说明**
>
> 申请入口过期不等于已生成的授权书失效。用户已提交的申请仍可继续查询；状态为 `SUCCEEDED` 的授权书在被作废前仍可获取文件。

**File** `object` | 授权书文件

`Session.File`

授权书文件信息。仅当 *Status* 为 `SUCCEEDED` 且授权书未作废时返回；其他状态不返回。

**FileName** `string` | 文件名

`Session.File.FileName`

授权书文件名。

**URL** `string` | 下载 URL

`Session.File.URL`

授权书文件的短期 HTTPS 签名下载地址。链接失效后，重新调用本接口即可获取新的下载地址，无需重新申请。

> **注意**
>
> 下载地址可直接访问授权书，请勿公开或记录到普通日志中。下载文件时无需附加 OpenAPI 访问凭证。