Todos los productos
Search
Centro de documentos

Alibaba Cloud Model Studio:DescribeFile

Última actualización: Oct 12, 2026

Consulta la información básica de un archivo en los datos de la aplicación, incluido el nombre, el tipo y el estado del archivo.

Descripción de la operación

  • Un usuario de Resource Access Management (RAM) debe obtener primero los permisos de API para Model Studio (AliyunBailianDataFullAccess o AliyunBailianDataReadOnlyAccess, ambos incluyen el permiso sfm:DescribeFile), y unirse a un espacio de trabajo antes de invocar esta operación. Una cuenta de Alibaba Cloud puede invocar esta operación directamente sin autorización. Utilice el SDK de Model Studio más reciente para invocar esta operación.
  • Esta operación es idempotente.

Limitación de velocidad: Esta operación se limita si se llama con demasiada frecuencia. No exceda las 10 llamadas por segundo. Si se aplica la limitación, reinténtelo más tarde.

Probar ahora

Pruebe esta API en OpenAPI Explorer; no es necesaria la firma manual. Las llamadas exitosas generan automáticamente código SDK que coincide con sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Prueba

Autorización de RAM

La siguiente tabla describe la autorización necesaria para llamar a esta API. Puede definirla en una política de Resource Access Management (RAM). Las columnas de la tabla se detallan a continuación:

  • Action: Las acciones se pueden utilizar en el elemento Action de las declaraciones de políticas de permisos de RAM para otorgar permisos para realizar la operación.

  • API: La API que puede llamar para realizar la acción.

  • Nivel de acceso: El nivel de acceso predefinido otorgado para cada API. Valores válidos: create, list, get, update y delete.

  • Tipo de recurso: El tipo de recurso que admite la autorización para realizar la acción. Indica si la acción admite permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción. De lo contrario, la política será ineficaz.

    • Para las API con permisos a nivel de recurso, los tipos de recursos requeridos están marcados con un asterisco (*). Especifique el Nombre de recurso de Alibaba Cloud (ARN) correspondiente en el elemento Resource de la política.
    • Para las API sin permisos a nivel de recurso, se muestra como Todos los recursos. Utilice un asterisco (*) en el elemento Resource de la política.
  • Clave de condición: Las claves de condición definidas por el servicio. La clave permite un control granular, aplicándose ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de claves de condición comunes aplicables a todos los servicios compatibles con RAM.

  • Acción dependiente: Las acciones dependientes necesarias para ejecutar la acción. Para completar la acción, el usuario de RAM o el rol de RAM debe tener los permisos para realizar todas las acciones dependientes.

Acción

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

sfm:DescribeFile

none

*Todos los recursos

*

NoneNone

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

WorkspaceId

string

Sí

El ID del espacio de trabajo al que pertenece el archivo. Para más información sobre cómo obtener el ID del espacio de trabajo, consulte Cómo usar un espacio de trabajo.

llm-3shx2gu255oqxxxx

FileId

string

Sí

El ID del archivo, que es el FileId devuelto por la operación AddFile. También puede obtener el ID del archivo haciendo clic en el icono de ID junto al nombre del archivo en la pestaña Datos de la aplicación - Archivos.

file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

Parámetros de solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

No se requieren parámetros.

Elementos de respuesta

Elemento

Tipo

Descripción

Ejemplo

object

Esquema de la respuesta

Code

string

El código de estado de error.

Éxito

Data

object

El campo de datos devuelto por la operación.

CategoryId

string

El ID de la categoría a la que pertenece el archivo.

cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx

CreateTime

string

La marca de tiempo cuando el archivo se agregó a Model Studio. Formato: yyyy-MM-dd HH:mm:ss. Zona horaria: UTC+8.

2024-09-09 12:45:43

FileId

string

El ID del archivo.

file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

FileName

string

El nombre del archivo.

XXX Product Introduction.pdf

FileType

string

El tipo de archivo (extensión). Valores posibles: pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp y gif.

pdf

Parser

string

El tipo de analizador utilizado para procesar el archivo. Valores posibles:

  • DASHSCOPE_DOCMIND: el analizador de documentos predeterminado.

DASHSCOPE_DOCMIND

SizeInBytes

integer

El tamaño del archivo, en bytes.

1234

Status

string

Para archivos utilizados en bases de conocimientos no estructuradas (tipo: UNSTRUCTURED), los valores posibles son:

  • INIT: Análisis pendiente.

  • IN_PARSE_QUEUE: En cola para análisis.

  • PARSING: En proceso de análisis.

  • PARSE_SUCCESS: Análisis completado.
    El documento solo se puede importar a una base de conocimientos después de que el estado cambie a PARSE_SUCCESS.
  • PARSE_FAILED: Error de análisis.

PARSE_SUCCESS

Etiquetas

array

La lista de etiquetas asociadas con el archivo. Un archivo puede estar asociado con múltiples etiquetas.

string

La etiqueta del archivo.

Introducción al producto

ParseResultDownloadUrl

string

ParseErrorMessage

string

El motivo del fallo de análisis.

Mensaje de error

Message

string

El mensaje de error.

Se activó la limitación de solicitudes.

RequestId

string

El ID de la solicitud.

17204B98-xxxx-4F9A-8464-2446A84821CA

Status

string

El código de estado devuelto por la operación.

200

Success

boolean

Indica si la llamada se realizó correctamente. Valores válidos:

  • true: Exitoso.

  • false: Fallido.

true

Ejemplos

Respuesta exitosa

Formato JSON

{
  "Code": "Success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
    "CreateTime": "2024-09-09 12:45:43",
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
    "FileName": "XXX产品介绍.pdf",
    "FileType": "pdf",
    "Parser": "DASHSCOPE_DOCMIND",
    "SizeInBytes": 1234,
    "Status": "PARSE_SUCCESS",
    "Tags": [
      "产品介绍"
    ],
    "ParseResultDownloadUrl": "",
    "ParseErrorMessage": "Error Message"
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Códigos de error

Consulte Códigos de error para obtener una lista completa.

Notas de lanzamiento

Consulte Notas de lanzamiento para obtener una lista completa.