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

Consulta uma lista de versões de arquivo.

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

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
FileId	integer	Sim	O ID do arquivo. Você pode chamar a operação ListFiles para consultar o ID.	100000001
ProjectId	integer	Não	O ID do espaço de trabalho do DataWorks. Você pode clicar no ícone Gerenciar Espaço de Trabalho no canto superior direito da página do Data Studio para acessar a página de gerenciamento do espaço de trabalho e visualizar o ID do espaço de trabalho.	100001
ProjectIdentifier	string	Não	O identificador exclusivo em inglês do espaço de trabalho do DataWorks, exibido no seletor de espaços de trabalho na parte superior da página do Data Studio.\n\n\n\nVocê deve especificar este parâmetro ou ProjectId para determinar o espaço de trabalho do DataWorks ao qual a operação é aplicada.	dw_project
PageNumber	integer	Não	O número da página.	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
HttpStatusCode	integer	O código de status HTTP retornado.	200
ErrorMessage	string	A mensagem de erro retornada.	The connection does not exist.
RequestId	string	O ID da solicitação.	0000-ABCD-EFG****
ErrorCode	string	O código de erro retornado.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	As versões de arquivo.
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas retornadas por página.	10
TotalCount	integer	O número total de entradas que correspondem às condições de consulta.	13
FileVersions	array<object>	Os detalhes das versões de arquivo.
	object
FileContent	string	O código no arquivo da versão atual.	SHOW TABLES;
Status	string	O status do arquivo da versão atual. Valores válidos: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED e CANCELLED.	COMMITTED
IsCurrentProd	boolean	Indica se a versão do arquivo é igual à versão mais recente do arquivo no ambiente de produção.	false
CommitUser	string	O ID da conta Alibaba Cloud usada para criar o arquivo da versão atual.	73842342****
NodeContent	string	As configurações de agendamento para o nó que corresponde ao arquivo da versão atual.	{"cycleType":0,"cronExpress":"00 05 00 * * ?"}
Comment	string	A descrição da versão do arquivo.	Second version submission
FilePropertyContent	string	As informações básicas sobre o arquivo da versão atual.	{"fileName":"ods_user_info_d","fileType":10}
FileName	string	O nome do arquivo da versão atual.	ods_user_info_d
UseType	string	O módulo funcional ao qual o arquivo pertence. Valores válidos:\n\n\n\n- 0: NORMAL (Data Studio).\n- 1: MANUAL (tarefas acionadas manualmente).\n- 2: MANUAL_BIZ (workflows acionados manualmente).\n- 3: SKIP (agendamento de dry run no Data Studio).\n- 10: ADHOCQUERY (consultas ad hoc).\n- 30: COMPONENT (gerenciamento de componentes).	NORMAL
ChangeType	string	O tipo de alteração no arquivo da versão atual. Valores válidos: CREATE, UPDATE e DELETE.	UPDATE
FileVersion	integer	A versão do arquivo.	2
CommitTime	integer	A hora em que a versão do arquivo foi criada. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1593881265000
NodeId	integer	O ID do nó acionado automaticamente que corresponde ao arquivo da versão atual.	1234

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "FileVersions": [
      {
        "FileContent": "SHOW TABLES;",
        "Status": "COMMITTED",
        "IsCurrentProd": false,
        "CommitUser": "73842342****",
        "NodeContent": "{\"cycleType\":0,\"cronExpress\":\"00 05 00 * * ?\"}",
        "Comment": "Second version submission",
        "FilePropertyContent": "{\"fileName\":\"ods_user_info_d\",\"fileType\":10}",
        "FileName": "ods_user_info_d",
        "UseType": "NORMAL",
        "ChangeType": "UPDATE",
        "FileVersion": 2,
        "CommitTime": 1593881265000,
        "NodeId": 1234
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
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.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.