ListDocs_AI妙笔_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
aimiaobi:ListDocs
List
全部资源
*

请求参数

字段名称字段详情
WorkspaceIdstring

百炼业务空间 Id

示例值:llm-2setzb9x4ewsd
DocNamestring

文档名称

示例值:企业2022年報参考取值来源:
    UploadDoc
    GetDocInfo
DocTypestring

文档类型

示例值:pdf参考取值来源:
    GetDocInfo
Skipinteger<int32>

跳过 n 条记录,用于分页

示例值:10
MaxResultsinteger<int32>

返回的最大结果数

示例值:20
NextTokenstring

下一页的 token

示例值:52a33dc83779f63641e16f5146cd7125
Statusesarray<integer<int32>>

文档状态列表

CategoryIdstring

文档所在目录

示例值:default

返回参数

字段名称字段详情
Codestring

返回结果编码。

示例值:successful
Dataarray<object>

返回数据结果列表

HttpStatusCodeinteger<int32>

http 状态码

示例值:200
MaxResultsinteger<int32>

最大返回结果数

示例值:10
Messagestring

返回消息。

示例值:successful
NextTokenstring

下一页 Token

示例值:CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4mYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc=
RequestIdstring

请求 Id

示例值:1813ceee-7fe5-41b4-87e5-982a4d18cca5
Successboolean

是否成功

示例值:true
TotalCountinteger<int32>

总记录数

示例值:70

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
403
NoPermission
You are not authorized to perform this action.诊断

变更历史

变更时间变更内容概要操作
2024-12-16
新增OpenAPI,获取文档列表

相关示例

2024年08月20日