查询用户上传规则库的处理状态。通过该接口,用户可以查询到当前规则库上传任务的状态,并获取到解析后的规则库文件大小、存储路径等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
-
操作:是指具体的权限点。
-
访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
-
资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
-
条件关键字:是指云产品自身定义的条件关键字。
-
关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aimiaobi:GetAuditNoteProcessingStatus | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 阿里云百炼业务空间唯一标识:获取业务空间 ID(Workspace ID) | llm-xx |
| TaskId | string | 是 | 用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。 | xxx_Default_129873419274 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | Schema of Response | ||
| RequestId | string | Id of the request | F2F366D6-E9FE-1006-BB70-2C650896AAB5 |
| Success | boolean | 此次请求是否成功 | true |
| Code | string | 状态码 | DataNotExists |
| Message | string | 错误说明 | success |
| HttpStatusCode | integer | http 状态码 | 200 |
| Data | object | 返回数据。 | |
| Status | string | 任务处理状态(PENDING/RUNNING/SUCCESSED/FAILED) | SUCCESSED |
| UpdateTime | long | 更新时间。 | 2024-11-25 11:40:50 |
| TaskId | string | 任务 ID,本次任务的唯一标识。 | 111_Default_20250708142918 |
| FileKey | string | 后端业务存储本次规则库解析结果的路径。 | oss://default/path/to/audit/note |
| FileSize | long | 规则库文件大小。 | 504 |
| NoteName | string | 解析之后的规则库名称。 | 错题本2025-07-07_解析结果 |
示例
正常返回示例
JSON格式
{
"RequestId": "F2F366D6-E9FE-1006-BB70-2C650896AAB5",
"Success": true,
"Code": "DataNotExists",
"Message": "success",
"HttpStatusCode": 200,
"Data": {
"Status": "SUCCESSED",
"UpdateTime": 0,
"TaskId": "111_Default_20250708142918",
"FileKey": "oss://default/path/to/audit/note",
"FileSize": 504,
"NoteName": "错题本2025-07-07_解析结果"
}
}
错误码
访问错误中心查看更多错误码。
该文章对您有帮助吗?