GetMetaCategory - DataWorks - Centro de documentación de Alibaba Cloud

Consulta el árbol de categorías.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican 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 common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:*

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ParentCategoryId	integer	No	El ID del árbol de categorías.	333
PageNum	integer	No	El número de página. Se utiliza para la paginación.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos de la respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
ErrorMessage	string	El mensaje de error.	The connection does not exist.
RequestId	string	El ID de la solicitud.	0bc1ec92159376
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists
Data	object	Los datos de negocio.
PageNum	integer	El número de página. Se utiliza para la paginación.	1
PageSize	integer	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
TotalCount	integer	El número total de categorías.	10
DataEntityList	array<object>	La lista de entidades de datos.
	object	Los detalles de la categoría.
Depth	integer	El nivel de profundidad de la categoría.	1
Comment	string	Los comentarios de la categoría.	category 1
ModifiedTime	integer	La hora en que se modificó por última vez la categoría. El valor es un número de 13 dígitos, como `1541576644000`.	1541576644000
CreateTime	integer	La hora en que se creó la categoría. El valor es un número de 13 dígitos, como `1541576644000`.	1541576644000
CategoryId	integer	El ID de la categoría.	133
LastOperatorId	string	El ID del usuario que realizó la última operación.	12345
Name	string	El nombre de la categoría.	category 1
ParentCategoryId	integer	El ID de la categoría principal.	12
OwnerId	string	El ID del propietario de la categoría.	123

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "La conexión no existe",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "DataEntityList": [
      {
        "Depth": 1,
        "Comment": "categoría 1",
        "ModifiedTime": 1541576644000,
        "CreateTime": 1541576644000,
        "CategoryId": 133,
        "LastOperatorId": "12345",
        "Name": "categoría 1",
        "ParentCategoryId": 12,
        "OwnerId": "123"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Invalid.Meta.CategoryIllegalDepth	A category can contain a maximum of 4 levels.
400	Invalid.Meta.CategoryNameDuplicate	The category name is duplicated at this level.
400	Invalid.Meta.TableNotExist	The table does not exist.
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.
400	InvalidParameter.Meta.NotExist	The object does not exist.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.
500	Invalid.Meta.CategoryRelationDuplicate"	The table is already bound to the category.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.
403	Invalid.Meta.CategoryForbidden	Failed to delete the category. The current category is associated with a table and cannot be operated.
403	Invalid.Meta.CategoryIllegalTenant	The tenant ID is different in the parent and child categories.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.