全部产品
Search

搜索本产品

    云原生数据仓库AnalyticDB：DescribeDocument - 查看文档详细信息

    文档中心

    云原生数据仓库AnalyticDB：DescribeDocument - 查看文档详细信息

    更新时间：Oct 10, 2024

    查看文档详细信息。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    gpdb:DescribeDocumentcreate
    • Document
      acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    DBInstanceIdstring是

    实例 ID。

    说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。
    		gp-xxxxxxxxx
    Namespacestring否

    命名空间，默认为 public。

    说明 您可以通过 CreateNamespace 接口创建，通过 ListNamespaces 接口查看列表。
    		mynamespace
    NamespacePasswordstring是

    命名空间对应的密码。

    说明 本值为 CreateNamespace 接口指定。
    		testpassword
    Collectionstring是

    文档库名称。

    说明 由 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。
    		document
    RegionIdstring是

    实例所在 Region ID。

    		cn-hangzhou
    FileNamestring是

    文档名。

    说明 可以通过 ListDocuments 接口查看文档列表。
    		music.txt

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		ABB39CC3-4488-4857-905D-2E4A051D0521
    Messagestring

    接口返回详细信息。

    		success
    Statusstring

    API 执行状态，取值如下：

    • success：执行成功。
    • fail：执行失败。
    		success
    FileNamestring

    文件名。

    		music.txt
    FileExtstring

    文件扩展名。

    		txt
    FileVersioninteger

    文档版本。每次更新上传同一文档时，此值会+1。

    		1
    FileMtimestring

    文档最新修改时间。

    		2023-11-01 10:01:01.123456
    Sourcestring

    文档来源。

    		OSS
    DocumentLoaderstring

    文档加载器名称。

    		RapidOCRPDFLoader
    TextSplitterstring

    文档切分器名称。

    		ChineseRecursiveTextSplitter
    FileSizelong

    文件大小，单位为字节。

    		10000
    FileMd5string

    文件 MD5 值。

    		b8078c9591413550f8963e37e24abcea
    DocsCountinteger

    文档被切分的数量。

    		100
    FileUrlstring

    文档的下载地址，有效期为 2h。

    		http://oss.xxx/music.txt
    PlainChunkFileUrlstring

    被切分后的纯文本(不带 Metadata)下载地址，每行是一个 chunk，有效期为 2h。

    		http://oss.xxx/music_plain_chunk.txt
    ChunkFileUrlstring

    切分后的文件链接，有效期为 2h。文件格式为 JSONL，每一行的格式为{"page_content":"*****", "metadata": {"**":"***","**":"***"}

    		http://oss.xxx/music_chunk.jsonl

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "FileName": "music.txt",
  "FileExt": "txt",
  "FileVersion": 1,
  "FileMtime": "2023-11-01 10:01:01.123456",
  "Source": "OSS\n",
  "DocumentLoader": "RapidOCRPDFLoader",
  "TextSplitter": "ChineseRecursiveTextSplitter",
  "FileSize": 10000,
  "FileMd5": "b8078c9591413550f8963e37e24abcea",
  "DocsCount": 100,
  "FileUrl": "http://oss.xxx/music.txt",
  "PlainChunkFileUrl": "http://oss.xxx/music_plain_chunk.txt",
  "ChunkFileUrl": "http://oss.xxx/music_chunk.jsonl"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-07-03OpenAPI 返回结构发生变更查看变更详情