Crea una categoría en un espacio de trabajo especificado para clasificar y gestionar archivos. Cada espacio de trabajo admite un máximo de 500 categorías.
Descripción de la operación
- No puede utilizar una API para agregar tablas de datos. Para agregar tablas de datos, vaya a la página Datos de la aplicación en la consola.
- Un usuario de RAM debe obtener los permisos de API necesarios para Alibaba Cloud Model Studio y unirse a un espacio de trabajo antes de llamar a esta operación. Se requiere el permiso
AliyunBailianDataFullAccess, que incluye el permisosfm:AddCategory. Una cuenta de Alibaba Cloud puede llamar a esta operación directamente sin necesidad de autorización. Para llamar a esta operación, utilice la versión más reciente del SDK de Alibaba Cloud Model Studio. - Esta operación no es idempotente.
Limitación de velocidad: Las llamadas frecuentes a esta operación están sujetas a limitación de velocidad. No exceda una frecuencia de 5 llamadas por segundo. Si se activa la limitación de velocidad, inténtelo de nuevo 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.
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
Actionde 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
Resourcede la política. - Para las API sin permisos a nivel de recurso, se muestra como Todos los recursos. Utilice un asterisco (*) en el elemento
Resourcede la política.
- 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
-
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:AddCategory | create | *Todos los recursos
| None | None |
Sintaxis de la solicitud
POST /{WorkspaceId}/datacenter/category/ HTTP/1.1
Parámetros de ruta
Parámetro | Tipo | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|---|
WorkspaceId | string | Sí | El ID del espacio de trabajo donde usted want crear la categoría. Para obtener más información sobre cómo conseguir un ID de espacio de trabajo, consulte Trabajar con espacios de trabajo. | llm-3z7uw7fwz0vxxxx |
Parámetros de solicitud
Parámetro | Tipo | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|---|
CategoryName | string | Sí | El nombre de la categoría. El nombre debe tener de 1 a 20 caracteres de longitud. Puede contener letras Unicode, como letras en inglés y caracteres chinos, junto con dígitos, dos puntos (:), guiones bajos (_), puntos (.) y guiones (-). | Lista de productos |
CategoryType | string | Sí | El tipo de la categoría. Valor válido:
| UNSTRUCTURED |
ParentCategoryId | string | No | El ID de la categoría principal bajo la cual se crea la nueva categoría. Si deja este parámetro vacío, se crea una categoría de nivel superior. | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
ConnectorId | string | No | El ID de la instancia del conector. Puede obtener el ID desde la consola de Alibaba Cloud Model Studio. | conn_xxxx |
Elementos de respuesta
Elemento | Tipo | Descripción | Ejemplo |
|---|---|---|---|
object | El objeto de respuesta. | ||
Code | string | El código de error. | success |
Data | object | Los datos devueltos. | |
CategoryId | string | El ID de la categoría. Guarde este ID para futuras llamadas a la API que utilicen esta categoría. | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
CategoryName | string | El nombre de la categoría. | Nombre de la categoría |
Message | string | El mensaje de error. | Se activó la limitación de solicitudes. |
RequestId | string | El ID de la solicitud. | 778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
Status | string | El código de estado HTTP devuelto. | 200 |
Éxito | boolean | Indica si la solicitud fue exitosa. Valores válidos:
| true |
Ejemplos
Respuesta exitosa
Formato JSON
{
"Code": "success",
"Data": {
"CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
"CategoryName": "Category name"
},
"Message": "Requests throttling triggered.",
"RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
"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.