GetMetaCategory - DataWorks: Central de Documentação do Alibaba Cloud

Consulta a árvore de categorias.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:*

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ParentCategoryId	integer	Não	O ID da árvore de categorias.	333
PageNum	integer	Não	O número da página. Usado para paginação.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
RequestId	string	O ID da solicitação.	0bc1ec92159376
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Data	object	Os dados de negócios.
PageNum	integer	O número da página. Usado para paginação.	1
PageSize	integer	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
TotalCount	integer	O número total de categorias.	10
DataEntityList	array<object>	A lista de entidades de dados.
	object	Os detalhes da categoria.
Depth	integer	O nível de profundidade da categoria.	1
Comment	string	Os comentários da categoria.	category 1
ModifiedTime	integer	A hora em que a categoria foi modificada pela última vez. O valor é um número de 13 dígitos, como 1541576644000.	1541576644000
CreateTime	integer	A hora em que a categoria foi criada. O valor é um número de 13 dígitos, como 1541576644000.	1541576644000
CategoryId	integer	O ID da categoria.	133
LastOperatorId	string	O ID do usuário que realizou a última operação.	12345
Name	string	O nome da categoria.	category 1
ParentCategoryId	integer	O ID da categoria pai.	12
OwnerId	string	O ID do proprietário da categoria.	123

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "A conexão não existe",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "DataEntityList": [
      {
        "Depth": 1,
        "Comment": "categoria 1",
        "ModifiedTime": 1541576644000,
        "CreateTime": 1541576644000,
        "CategoryId": 133,
        "LastOperatorId": "12345",
        "Name": "categoria 1",
        "ParentCategoryId": 12,
        "OwnerId": "123"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.Meta.CategoryIllegalDepth	A category can contain a maximum of 4 levels.	A hierarquia de categorias excede 4 níveis.
400	Invalid.Meta.CategoryNameDuplicate	The category name is duplicated at this level.	O nome da categoria está duplicado no mesmo nível.
400	Invalid.Meta.TableNotExist	The table does not exist.	A tabela não existe.
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	O parâmetro da solicitação é inválido.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	O parâmetro do aplicativo é inválido.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.	O formato de data é inválido.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	As informações de paginação são inválidas.
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.	A rede da interface está desconectada.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	Ocorreu um erro desconhecido.
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.	O usuário atual não é o proprietário de nenhum locatário.
403	Invalid.Meta.CategoryForbidden	Failed to delete the category. The current category is associated with a table and cannot be operated.	Falha ao excluir a categoria. A categoria está associada a uma tabela e não pode ser excluída.
403	Invalid.Meta.CategoryIllegalTenant	The tenant ID is different in the parent and child categories.	Os IDs de locatário das categorias pai e filho são inconsistentes.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acesso negado. Autorize o acesso.
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.