ListDocumentRetrieve - 公文库检索

根据复杂条件进行政务公文库的检索。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aimiaobi:ListDocumentRetrievelist
*全部资源
*

请求参数

名称类型必填描述示例值
Actionstring

系统规定参数。取值:ListDocumentRetrieve

ListDocumentRetrieve
WorkspaceIdstring

百炼业务空间唯一标识:获取 workspaceId

llm-
MaxResultsinteger

最大返回结果数

94
NextTokenstring

下一页的 token

cEoBWREAXdxaOyjq/cqAbg==
Querystring

搜索条件

检索Query
ContentTypestring

文章体裁,0(null):全部(默认值), 1:公文,2:重要文章 5:政策解读 6:法律条文 7:规章法规 8:总书记

1
SubContentTypestring
  • 文章体裁二级分类,文章体裁为总书记时:1:动态 2:讲话 3:思想 4:理论
    • 文章体裁为公文时:-1: 其他 0:决议 1:决定 2:令 3:公报 4:公告 5:通告 6:意见 7:通知 8:通报 9:报告 10:请示 11:批复 12: 议案 13:函
    • 14: 纪要
    • 文章体裁为重要文章时:1:重要评论 2:重要理论 3:其他文章
    • 文章体裁为规章法规时:3:行政法规 4:监察法规 5:地方性法规 7:部门规章 8:其他 9:党章党规
    • 文章体裁为法律条文时:1:宪法 2:法律 6:司法解释
1
Regionstring

区域 可直接输入 省 或者市 如吉林省 或者北京市

北京市
Sourcestring

来源,0:内部(本单位) 1:外部(外单位)

1
StartDatestring

发文起始时间,yyyy-MM-dd

2025-10-10
EndDatestring

发文结束时间,yyyy-MM-dd

2025-07-03
Officestring

发文单位

国务院办公室
WordSizestring

发文字号

宁民规〔2020〕5
ElementScopestring

检索要素范围,1:标题 0:全文(标题和内容),默认

0
SubjectClassifystring

支持如下分类

一级分类二级分类
国防和交流合作事务国防, 对外事务, 军事工作, 港澳台侨工作
综合政务二十大, 政务公开与督查, 联合政务, 党建工作, 会议及提案, 政务文件管理, 其他政务
国务院组织机构国务院, 国务院办公厅, 国务院机构
行政监管与市场监管行政监管, 信用监管, 产品质量监督, 安全生产监管, 市场监管
经济管理国民经济, 市场经济, 经济体制改革, 国有资产监管
财政金融商贸财政, 金融, 审计, 商贸, 海关
人事工作与社会保障人事工作, 人口与计划生育, 妇女儿童工作, 扶贫, 减灾救灾, 公共服务, 社会福利与救助, 优抚安置, 社会保障
公共安全与社会管理公安, 安全, 司法, 消防, 民族, 宗教
科教文体文化, 科技创新, 教育, 知识产权, 新闻出版, 广电与互联网, 体育, 旅游
医疗卫生卫生, 医疗, 动物医学
城乡建设与工业发展城乡建设, 工业, 交通
自然资源与环境保护国土资源、能源, 土木, 气象, 环境保护
农林水渔牧类农业, 林业, 水利, 渔业, 畜牧业
其他其他
国防和交流合作事务

返回参数

名称类型描述示例值
object

Schema of Response

Codestring

状态码

successful
Dataarray<object>

业务数据

data
Dataobject

业务数据

Titlestring

标题

文章标题
Essaystring

正文

文章正文
IssuingAuthoritystring

发布机构

发布机构
PublicationDatestring

发布日期

2023-02-01
HttpStatusCodeinteger

http 状态码

200
MaxResultsinteger

返回的最大记录数

71
Messagestring

错误说明

success
NextTokenstring

下一页 Token

cEoBWREAXdxaOyjq/cqAbg==
RequestIdstring

Id of the request

F2F366D6-E9FE-1006-BB70-2C650896AAB5
Successboolean

是否成功:true 成功,false 失败

true
TotalCountinteger

总数

100

示例

正常返回示例

JSON格式

{
  "Code": "successful",
  "Data": [
    {
      "Title": "文章标题",
      "Essay": "文章正文",
      "Link": "文章链接",
      "IssuingAuthority": "发布机构",
      "PublicationDate": "2023-02-01"
    }
  ],
  "HttpStatusCode": 200,
  "MaxResults": 71,
  "Message": "success",
  "NextToken": "cEoBWREAXdxaOyjq/cqAbg==",
  "RequestId": "F2F366D6-E9FE-1006-BB70-2C650896AAB5",
  "Success": true,
  "TotalCount": 100
}

错误码

HTTP status code错误码错误信息描述
403NoPermissionYou are not authorized to perform this action.请检查workspaceId的赋值

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-12-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2025-12-04新增 OpenAPI查看变更详情