Alibaba Cloud Model Studio:ListCategory

Recupera los detalles de una o más categorías en un workspace especificado.

Descripción de la operación

• Esta API no admite la consulta de tablas de datos.
• Para llamar a esta API, un usuario RAM debe obtener primero el permiso de API requerido para Model Studio y unirse a un workspace. Esto requiere el permiso AliyunBailianDataFullAccess, que incluye el permiso sfm:ListCategory. Las cuentas de Alibaba Cloud pueden llamar a esta API directamente. Utilice la versión más reciente del SDK de Model Studio.
• Esta operación admite paginación. Al realizar su primera solicitud, establezca el parámetro MaxResults para especificar el número máximo de elementos a devolver. Si hay más elementos disponibles, la respuesta incluye un NextToken. Para recuperar la siguiente página de resultados, establezca el parámetro NextToken en el valor de la respuesta anterior y especifique MaxResults nuevamente. Un NextToken vacío indica que no hay más resultados disponibles.
• Esta operación es idempotente.

Limitación de tasa: Esta API está sujeta a limitación de tasa. No exceda las 5 solicitudes por segundo. Si el sistema limita una solicitud, reinténtela después de un breve intervalo.

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 las acciones o a las 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:ListCategory	list	*Todos los recursos *	None	None

Sintaxis de la solicitud

POST /{WorkspaceId}/datacenter/categories HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	string	Sí	El ID del workspace. Para obtener más información, consulte Trabajar con workspaces.	llm-3shx2gu255oqxxxx

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ConnectorId	string	No	El ID del conector.	file_conn_xxxxx
CategoryType	string	Sí	El tipo de categoría a consultar. Valor válido: UNSTRUCTURED: Una categoría para datos no estructurados. Esta API no admite la consulta de tablas de datos estructurados.	UNSTRUCTURED
ParentCategoryId	string	No	El ID de la categoría principal.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
NextToken	string	No	El token de paginación. Para recuperar la siguiente página de resultados, pase el valor de NextToken de la respuesta anterior.	AAAAAdH70eOCSCKtacdomNzak4U=
MaxResults	integer	No	El número máximo de categorías a devolver por página. El rango válido es de 1 a 200. Valor predeterminado: 20. Si este parámetro no se especifica o se establece en un valor menor que 1, se utiliza el valor predeterminado. Si se especifica un valor mayor que 200, se utiliza el valor máximo de 200.	20
CategoryName	string	No	Filtra los resultados para incluir solo la categoría con este nombre exacto. Si se omite este parámetro, no se aplica ningún filtro.	Catálogo de productos

Elementos de respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El objeto de respuesta.
Code	string	El código de error.	success
Data	object	La carga útil de la respuesta.
CategoryList	array<object>	La lista de categorías.
	object	Un objeto de categoría.
CategoryId	string	El ID de la categoría.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CategoryName	string	El nombre de la categoría.	Categoría 1
CategoryType	string	El tipo de categoría. El único valor válido es: UNSTRUCTURED: Una categoría estándar.	UNSTRUCTURED
IsDefault	boolean	Indica si la categoría es la predeterminada. Valores válidos: true: La categoría es la predeterminada. false: La categoría no es la predeterminada. No puede eliminar la categoría predeterminada.	true
ParentCategoryId	string	El ID de la categoría principal.	cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
HasNext	boolean	Indica si hay más resultados disponibles para su recuperación. Valores válidos: true: Hay más resultados disponibles. false: Esta es la última página de resultados.	true
MaxResults	integer	El número máximo de resultados a devolver por página.	20
NextToken	string	El token utilizado para recuperar la siguiente página de resultados. Este parámetro se omite cuando no hay más resultados disponibles.	AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ
TotalCount	integer	El número total de categorías coincidentes.	20
Message	string	El mensaje de error.	el id del espacio de trabajo es null o no es válido.
RequestId	string	El ID de la solicitud.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	El código de estado de la solicitud.	200
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

Formato JSON

{
  "Code": "success",
  "Data": {
    "CategoryList": [
      {
        "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
        "CategoryName": "类目1",
        "CategoryType": "UNSTRUCTURED",
        "IsDefault": true,
        "ParentCategoryId": "cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx"
      }
    ],
    "HasNext": true,
    "MaxResults": 20,
    "NextToken": "AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ",
    "TotalCount": 20
  },
  "Message": "workspace id is null or invalid.",
  "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.