DescribeFile_大模型服务平台百炼_API调试-阿里云OpenAPI开发者门户

接口说明

RAM 用户（子账号）需要首先获取百炼的数据权限（AliyunBailianDataFullAccess或AliyunBailianDataReadOnlyAccess均可，已包括 sfm:DescribeFile 权限点），然后才能调用本接口，详见为 RAM 用户授予数据权限。阿里云账号（主账号）可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
调用该接口前请确保您的文档已经成功上传到百炼数据管理中。
如果您是通过 API 进行文档上传操作，请确保您已经调用 AddFile 接口成功获取到FileId。
您在百炼数据管理中上传的非结构化文档，也可以通过此接口进行查询。
本接口具有幂等性。

限流说明： 本接口频繁调用会被限流，频率请勿超过 5 次/秒。如遇限流，请稍后重试。

GET /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1

字段名称	字段详情
WorkspaceIdstring	文档所属的业务空间 ID。获取方式请参见如何使用业务空间。示例值:llm-3shx2gu255oqxxxx
FileIdstring	文档 ID，即 AddFile 接口返回的`FileId`。您也可以在数据管理页面，单击文件名称旁的 ID 图标获取。示例值:file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx参考取值来源: AddFile ListFile UpdateFileTag

字段名称	字段详情
Codestring	错误状态码。示例值:Success
Dataobject	接口业务数据字段。
Messagestring	错误信息。示例值:Requests throttling triggered.
RequestIdstring	请求 ID。示例值:17204B98-xxxx-4F9A-8464-2446A84821CA
Statusstring	接口返回的状态码。示例值:200
Successboolean	接口调用是否成功，可能值为：展开详情示例值:true

变更历史

	变更时间	变更内容概要	操作
	2024-09-18	变更返回参数