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

*All Resource

*

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 workspace do DataWorks. Você pode clicar no ícone Gerenciar Workspace no canto superior direito da página do DataStudio para acessar a página Workspace e visualizar o ID do workspace.	100001
ProjectIdentifier	string	Não	O identificador exclusivo do workspace do DataWorks. Você pode clicar no identificador no canto superior esquerdo da página do DataStudio para alternar para outro workspace. Você deve especificar este parâmetro ou ProjectId para determinar o workspace do DataWorks ao qual a operação será 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 do 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 retornadas.	13
FileVersions	array<object>	Os detalhes das versões do arquivo.
	object
FileContent	string	The code in the file of the current version.	SHOW TABLES;
Status	string	The status of the file of the current version. Valid values: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED.	COMMITTED
IsCurrentProd	boolean	Indicates whether the file version is the same as the latest file version in the production environment.	false
CommitUser	string	The ID of the Alibaba Cloud account used to create the file of the current version.	73842342****
NodeContent	string	The scheduling configurations for the node that corresponds to the file of the current version.	{"cycleType":0,"cronExpress":"00 05 00 * * ?"}
Comment	string	The description of the file version.	Second version submission
FilePropertyContent	string	The basic information about the file of the current version.	{"fileName":"ods_user_info_d","fileType":10}
FileName	string	The name of the file of the current version.	ods_user_info_d
UseType	string	The functional module to which the file belongs. Valid values: NORMAL, MANUAL, MANUAL_BIZ, SKIP, ADHOCQUERY, and COMPONENT. The value SKIP indicates that the node corresponding to the file is run in dry-run mode.	NORMAL
ChangeType	string	The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.	UPDATE
FileVersion	integer	The version of the file.	2
CommitTime	integer	The time when the file version was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1593881265000
NodeId	integer	The ID of the auto triggered node that corresponds to the file of the current version.	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	Descrição
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.	No permission, please authorize
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.