查询规则库后处理的进度。与 ConfirmAndPostProcessAuditNote 接口配合使用,供您查询当前后处理任务的状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
-
操作:是指具体的权限点。
-
访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
-
资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
-
条件关键字:是指云产品自身定义的条件关键字。
-
关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aimiaobi:GetAuditNotePostProcessingStatus | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 阿里云百炼业务空间唯一标识:获取业务空间 ID(Workspace ID) | llm-xx |
| TaskId | string | 是 | 用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。 | xxx_Default_12847192741412 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| 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 | 返回数据 | |
| NoteId | string | 该规则库的 ID,现有版本默认为 "Default"。 | Default |
| Status | string | 本次后处理任务的状态。可选值:PENDING(待处理)、RUNNING(处理中)、SUCCESSED(成功)、FAILED(失败) | RUNNING |
| TotalLines | integer | 结构化规则库的总行数。 | 666 |
| ProcessedLines | integer | 已后处理完成的行数。 | 233 |
| ErrorMessage | string | 错误消息,仅在后处理失败时会返回。 | error |
| CreateTime | string | 本次后处理任务的创建时间(YYYY-MM-DD HH:mm:ss)。 | 1970-01-01 12:34:56 |
| CompletionTime | string | 本次后处理任务的完成时间(YYYY-MM-DD HH:mm:ss)。 | 1970-01-01 23:34:45 |
示例
正常返回示例
JSON格式
{
"RequestId": "F2F366D6-E9FE-1006-BB70-2C650896AAB5",
"Success": true,
"Code": "DataNotExists",
"Message": "success",
"HttpStatusCode": 200,
"Data": {
"NoteId": "Default",
"Status": "RUNNING",
"TotalLines": 666,
"ProcessedLines": 233,
"ErrorMessage": "error",
"CreateTime": "1970-01-01 12:34:56",
"CompletionTime": "1970-01-01 23:34:45"
}
}
错误码
访问错误中心查看更多错误码。