DescribeDoc - 根据文档ID获取单个文档信息_大模型服务平台百炼-阿里云帮助中心

根据文档ID获得单个文档信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
sfm:DescribeDoc	Read	acs:sfm::{#accountId}:*	无	无

请求参数

名称	类型	必填	描述	示例值
DocId	string	是	文档 ID	8C8FxxxxC3EE
AgentKey	string	是	业务空间 key，具体查看地址	2818xxxx_p_efm

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	778C0B3B-xxxx-5FC1-A947-36EDD13606AB
DocId	string	文档 ID	8C8FxxxxC3EE
Name	string	文档名称	文档1
Size	string	文档名称	1.12MB
Status	string	文档状态	导入完成
Type	string	文档类型 RAW FAQ	RAW
OwnerId	string	文档归属用户 ID	19539
FailReason	string	导入失败的原因	导入索引失败
UploadTime	string	上传时间。	2024-01-12 10:43:02
Tags	object []	标签 ID 列表
TagId	string	标签 ID	471dxxxx3427
TagName	string	标签名称。	标签1

示例

正常返回示例

JSON格式

{
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "DocId": "8C8FxxxxC3EE",
  "Name": "文档1",
  "Size": "1.12MB",
  "Status": "导入完成",
  "Type": "RAW",
  "OwnerId": "19539",
  "FailReason": "导入索引失败",
  "UploadTime": "2024-01-12 10:43:02",
  "Tags": [
    {
      "TagId": "471dxxxx3427",
      "TagName": "标签1"
    }
  ]
}

错误码

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