获取素材列表:获取素材库中素材列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
aimiaobi:ListMaterialDocuments | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AgentKey | string | 是 | 业务空间唯一标识: AgentKey | 33a2658aaabf4c24b45d50e575125311_p_beebot_public |
Query | string | 否 | 支持对 title、content、content 的综合查询 | 小猫 |
Id | long | 否 | 素材主键 ID | 69 |
Title | string | 否 | 根据素材标题全文检索 | 新闻标题 |
DocType | string | 否 | 文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine) | jsonLine |
DocTypeList | array | 否 | 文档类型列表 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine) | |
string | 否 | 文件类型对象。 | html | |
Content | string | 否 | 文档内容全文检索 | 新闻内容 |
ShareAttr | integer | 否 | 共享属性:0:个人私有,1:业务空间范围内共享 | 1 |
Keywords | array | 否 | 文档关键词 | |
string | 否 | 关键词 | 关键词 | |
CreateTimeStart | string | 否 | 创建时间-开始范围,格式:yyyy-MM-dd HH:mm:ss | 2023-02-19 07:28:11 |
CreateTimeEnd | string | 否 | 创建时间-结束范围,格式:yyyy-MM-dd HH:mm:ss | 2023-03-18 02:00:00 |
UpdateTimeStart | string | 否 | 更新时间-开始范围,格式:yyyy-MM-dd HH:mm:ss | 2023-03-18 02:00:00 |
UpdateTimeEnd | string | 否 | 更新时间-结束范围,格式:yyyy-MM-dd HH:mm:ss | 2023-03-18 03:00:00 |
GeneratePublicUrl | boolean | 否 | 是否生成文件公共 URL | true |
Current | integer | 否 | 当前页码 | 1 |
Size | integer | 否 | 每页条数:默认 10 | 10 |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "DataNotExists",
"Current": 1,
"Data": [
{
"Author": "作者\n\n",
"CreateTime": "2023-03-18 02:00:00\n",
"CreateUser": "1",
"CreateUserName": "创建用户名",
"DocKeywords": [
"关键词"
],
"DocType": "pdf",
"ExternalUrl": "https://www.example.com\n",
"HtmlContent": "网页内容",
"Id": 35,
"PubTime": "2023-03-18 02:00:00\n",
"PublicUrl": "https://www.example.com\n",
"ShareAttr": 1,
"SrcFrom": "user_upload",
"Summary": "摘要",
"TextContent": "文档内容",
"ThumbnailInBase64": "base64编码的图像二进制数据",
"Title": "文档标题\n\n",
"UpdateTime": "2023-03-18 02:00:00\n",
"UpdateUser": "1",
"UpdateUserName": "更新用户名",
"Url": "https://www.example.com"
}
],
"HttpStatusCode": 200,
"Message": "数据不存在",
"RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
"Size": 10,
"Success": false,
"Total": 100
}
错误码
访问错误中心查看更多错误码。