DescribeDataFlowTasks - Cloud Parallel File Storage: Central de Documentação do Alibaba Cloud

Consulta os detalhes das tarefas de fluxo de dados.

Descrição da operação

Somente o CPFS 2.2.0 e versões posteriores e o CPFS for Lingjun 2.4.0 e versões posteriores suportam a consulta de tarefas de fluxo de dados. Você pode visualizar as informações da versão na página de detalhes do sistema de arquivos no console.

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

nas:DescribeDataFlowTasks

get

*DataFlow

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
FileSystemId	string	Sim	O ID do sistema de arquivos.	bmcpfs-290w65p03ok64ya****
Filters	array<object>	Não	As condições de filtro.
	object	Não
Key	string	Não	O nome da chave de filtro. Valores válidos: Status : filtra pelo status do fluxo de dados. TaskIds : filtra por ID de tarefa de fluxo de dados. Originator : filtra pelo iniciador da tarefa de fluxo de dados. CreateTimeEnd : filtra tarefas de fluxo de dados criadas antes do horário especificado. EndTimeBegin : filtra tarefas de fluxo de dados encerradas após o horário especificado. DataFlowIds : filtra por ID de fluxo de dados. StartTimeEnd : filtra tarefas de fluxo de dados iniciadas antes do horário especificado. TaskActions : filtra pelo tipo da tarefa de fluxo de dados. EndTimeEnd : filtra tarefas de fluxo de dados encerradas antes do horário especificado. StartTimeBegin : filtra tarefas de fluxo de dados iniciadas após o horário especificado. CreateTimeBegin : filtra tarefas de fluxo de dados criadas após o horário especificado. DataTypes : filtra pelo tipo de dados da tarefa de fluxo de dados.	DataFlowIds
Value	string	Não	O valor da chave de filtro. Curingas não são suportados.	df-194433a5be31****
NextToken	string	Não	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Se os resultados retornados forem truncados, você pode usar NextToken para iniciar uma nova solicitação e recuperar o conteúdo após o ponto de truncamento atual.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	Não	O número de resultados para cada consulta.	20
WithReports	boolean	Não	Especifica se as informações do relatório devem ser consultadas.	True

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	2D69A58F-345C-4FDE-88E4-BF518948****
NextToken	string	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Se os resultados retornados forem truncados, você pode usar NextToken para iniciar uma nova solicitação e recuperar o conteúdo após o ponto de truncamento atual.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
TaskInfo	object
Task	array<object>	A coleção de informações da tarefa de fluxo de dados.
	array<object>
FilesystemId	string	O ID do sistema de arquivos.	bmcpfs-290w65p03ok64ya****
DataFlowId	string	O ID do fluxo de dados.	df-194433a5be31****
TaskId	string	O ID da tarefa de fluxo de dados.	task-38aa8e890f45****
SourceStorage	string	O caminho de acesso do armazenamento de origem. Formato: `<tipo de armazenamento>://[<ID da conta>:]<caminho>`. Onde: tipo de armazenamento: somente oss é suportado. ID da conta: o UID da conta proprietária do armazenamento de origem. caminho: o nome do bucket do OSS. Limites: Somente letras minúsculas, dígitos e hifens (-) são suportados. O nome deve começar e terminar com uma letra minúscula ou dígito. O comprimento máximo é de 128 caracteres. A codificação UTF-8 é utilizada. Nota O bucket do OSS já deve existir na região. O parâmetro ID da conta é suportado apenas pelo CPFS for Lingjun 2.6.0 e versões posteriores.	oss://178321033379****:bucket-01
FileSystemPath	string	O caminho do fileset no sistema de arquivos CPFS. Limites: O comprimento é de 2 a 1.024 caracteres. A codificação UTF-8 é utilizada. O caminho deve começar e terminar com uma barra (/). O diretório deve ser um diretório de fileset no CPFS. Nota Somente o CPFS suporta este parâmetro.	/a/b/c/
Originator	string	O iniciador da tarefa de fluxo de dados. Valores válidos: User: a tarefa é iniciada por um usuário. System: a tarefa é uma tarefa de atualização automática iniciada pelo CPFS com base no intervalo de atualização automática. Nota Somente o CPFS suporta este parâmetro.	User.
TaskAction	string	O tipo do nó de fluxo de dados. Valores válidos: Import: realiza a importação de dados especificados do armazenamento de origem para o CPFS. Export: exporta dados especificados do CPFS para o armazenamento de origem. StreamImport: realiza a importação de dados especificados do armazenamento de origem para o CPFS como um nó de fluxo de dados. StreamExport: exporta dados especificados do CPFS para o armazenamento de origem como um nó de fluxo de dados. Evict: libera blocos de dados de arquivos no CPFS. Após a liberação, apenas os metadados são retidos no CPFS. Você ainda pode consultar o arquivo, mas os blocos de dados são removidos e não ocupam capacidade de armazenamento no CPFS. Quando os dados do arquivo são acessados, eles são carregados do armazenamento de origem sob demanda. Inventory: obtém a lista de verificação de arquivos gerenciados pelo fluxo de dados no CPFS, que fornece o status de cache dos arquivos no fluxo de dados. Nota StreamImport e StreamExport são suportados apenas pelo CPFS for Lingjun 2.6.0 e versões posteriores.	Import.
DataType	string	O tipo de dados da tarefa de fluxo de dados. Valores válidos: Metadata: os metadados dos arquivos, incluindo carimbo de data/hora, propriedade, permissão e outros atributos. Se Metadata for selecionado, apenas os metadados dos arquivos serão importados. Os usuários podem ver o arquivo, mas quando os dados do arquivo são acessados, os dados são carregados do armazenamento de origem sob demanda. Data: os blocos de dados dos arquivos. MetaAndData: os metadados e blocos de dados dos arquivos. Nota O CPFS for Lingjun suporta apenas o tipo MetaAndData.	MetaAndData.
Progress	integer	O progresso da tarefa de fluxo de dados. O número de operações que foram executadas pela tarefa de fluxo de dados atual.	50
Status	string	O status da tarefa de fluxo de dados. Valores válidos: Pending: a tarefa de fluxo de dados foi criada e está na fila, mas não foi iniciada. Executing: a tarefa de fluxo de dados está sendo executada. Failed: a tarefa de fluxo de dados falhou. Você pode visualizar o relatório da tarefa de fluxo de dados para obter o motivo da falha. Completed: a tarefa de fluxo de dados foi concluída. Você pode visualizar o relatório da tarefa de fluxo de dados para verificar se todos os arquivos foram transferidos corretamente. Canceled: a tarefa de fluxo de dados foi cancelada e não foi concluída. Canceling: a tarefa de fluxo de dados está sendo cancelada.	Failed.
ReportPath `deprecated`	string	O caminho onde o relatório da tarefa de fluxo de dados é armazenado no sistema de arquivos CPFS. Para o CPFS, o relatório da tarefa é gerado no diretório `.dataflow_report` do sistema de arquivos CPFS. Para o CPFS for Lingjun, um link de download do OSS é retornado. Você pode usar o link para baixar o relatório da tarefa.	/path_in_cpfs/reportfile.cvs.
CreateTime	string	A hora em que a tarefa foi criada. A hora segue o padrão ISO 8601. Formato: yyyy-MM-dd HH:mm:ss.	2021-08-04 18:27:35
StartTime	string	A hora em que a tarefa foi iniciada. A hora segue o padrão ISO 8601. Formato: yyyy-MM-dd HH:mm:ss.	2021-08-04 18:27:35
EndTime	string	A hora em que a tarefa terminou. A hora segue o padrão ISO 8601. Formato: yyyy-MM-dd HH:mm:ss.	2021-08-04 18:27:35
FsPath	string	O caminho do diretório inteligente.	/aa/
ConflictPolicy	string	A política de conflito para arquivos com o mesmo nome. SKIP_THE_FILE: ignora arquivos com o mesmo nome. KEEP_LATEST: compara a hora de atualização e mantém a versão mais recente. OVERWRITE_EXISTING: substitui forçadamente arquivos com o mesmo nome. Valores válidos: KEEP_LATEST : Compara a hora de atualização e mantém a versão mais recente. OVERWRITE_EXISTING : Substitui forçadamente arquivos com o mesmo nome. SKIP_THE_FILE : Ignora arquivos com o mesmo nome.	KEEP_LATEST.
Directory	string	O diretório no qual a tarefa de fluxo de dados é executada.	/path_in_cpfs/
DstDirectory	string	O diretório de destino para o qual a tarefa de fluxo de dados é mapeada.	/path_in_cpfs/
ErrorMsg	string	A mensagem de erro da tarefa. Nota Se este campo não for retornado ou estiver vazio, nenhum erro ocorreu.	{"ErrorKey":"PATH_NOT_ACCESSIBLE","ErrorDetail":"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory"}
ProgressStats	object	As informações de progresso da tarefa de fluxo de dados.
FilesTotal	integer	O número total de arquivos verificados na origem.	3
FilesDone	integer	O número de arquivos para os quais o fluxo de dados foi concluído, incluindo arquivos ignorados.	3
ActualFiles	integer	O número real de arquivos transferidos.	3
BytesTotal	integer	A quantidade total de dados verificados na origem. Unidade: bytes.	131092971520
BytesDone	integer	A quantidade de dados para os quais o fluxo de dados foi concluído, incluindo dados ignorados. Unidade: bytes.	131092971520
ActualBytes	integer	A quantidade real de dados transferidos. Unidade: bytes.	131092971520
RemainTime	integer	O tempo restante estimado. Unidade: segundos.	437
AverageSpeed	integer	A velocidade média de transferência. Unidade: bytes por segundo.	342279299
Reports	object
Report	array<object>	A lista de relatórios. Nota Tarefas de streaming não suportam relatórios. Se WithReport estiver definido como True, este parâmetro retorna dados de relatório para o CPFS for Lingjun. Somente o CPFS for Lingjun suporta o parâmetro WithReport.
	object
Name	string	O nome do relatório. CPFS: TotalFilesReport: o relatório da tarefa. CPFS for Lingjun: FailedFilesReport: o relatório de arquivos com falha. SkippedFilesReport: o relatório de arquivos ignorados. SuccessFilesReport: o relatório de arquivos bem-sucedidos.	TotalFilesReport.
Path	string	O link do relatório.	https://a-hbr-temp-cn-hangzhou-staging.oss-cn-hangzhou.aliyuncs.com/temp/report/162319438359**/job-000bb6fwqficjbxk/job-000bb6fwqficjbxk_failed.zip?Expires=1721201422&OSSAccessKeyId=LTA**************&Signature=Fp%2BvauORTIVxooXY2tec6z0T%2Bp4%3D.
Includes	string	Os diretórios a serem filtrados dentro do diretório. O conteúdo dos diretórios filtrados é transferido. Nota Somente o CPFS for Lingjun suporta este recurso.	["/test/","/test1/"]
TransferFileListPath	string	O diretório especificado do OSS. Os dados são sincronizados com base no conteúdo dos arquivos CSV no diretório do OSS. Nota Somente o CPFS for Lingjun suporta este recurso.	/path_in_cpfs/
EntryList	string		["/path_in_cpfs/file1", "/path_in_cpfs/file2"]

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "TaskInfo": {
    "Task": [
      {
        "FilesystemId": "bmcpfs-290w65p03ok64ya****",
        "DataFlowId": "df-194433a5be31****",
        "TaskId": "task-38aa8e890f45****",
        "SourceStorage": "oss://178321033379****:bucket-01",
        "FileSystemPath": "/a/b/c/",
        "Originator": "User.",
        "TaskAction": "Import.",
        "DataType": "MetaAndData.",
        "Progress": 50,
        "Status": "Failed.",
        "ReportPath": "/path_in_cpfs/reportfile.cvs.",
        "CreateTime": "2021-08-04 18:27:35",
        "StartTime": "2021-08-04 18:27:35",
        "EndTime": "2021-08-04 18:27:35",
        "FsPath": "/aa/",
        "ConflictPolicy": "KEEP_LATEST.",
        "Directory": "/path_in_cpfs/",
        "DstDirectory": "/path_in_cpfs/",
        "ErrorMsg": "{\"ErrorKey\":\"PATH_NOT_ACCESSIBLE\",\"ErrorDetail\":\"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory\"}",
        "ProgressStats": {
          "FilesTotal": 3,
          "FilesDone": 3,
          "ActualFiles": 3,
          "BytesTotal": 131092971520,
          "BytesDone": 131092971520,
          "ActualBytes": 131092971520,
          "RemainTime": 437,
          "AverageSpeed": 342279299
        },
        "Reports": {
          "Report": [
            {
              "Name": "TotalFilesReport.",
              "Path": "https://a-hbr-temp-cn-hangzhou-staging.oss-cn-hangzhou.aliyuncs.com/temp/report/162319438359****/job-000bb6fwqficjbxk****/job-000bb6fwqficjbxk****_failed.zip?Expires=1721201422&OSSAccessKeyId=LTA****************&Signature=Fp%2BvauORTIVxooXY2tec6z0T%2Bp4%3D."
            }
          ]
        },
        "Includes": "[\"/test/\",\"/test1/\"]",
        "TransferFileListPath": "/path_in_cpfs/",
        "EntryList": "[\"/path_in_cpfs/file1\", \"/path_in_cpfs/file2\"]"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalCharacters	The parameter contains illegal characters.	O parâmetro é inválido.
400	MissingFileSystemId	FileSystemId is mandatory for this action.	O parâmetro FileSystemId não foi especificado.
400	InvalidFilesystemVersion.NotSupport	This Api does not support this fileSystem version.	A operação atual não suporta esta versão do sistema de arquivos.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.	O sistema de arquivos não suporta fluxos de dados.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	O sistema de arquivos especificado não existe.
404	InvalidDataFlow.NotFound	The specified data flow does not exist.	O dataflow especificado não existe.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	O MaxResults especificado é inválido.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	O parâmetro Filter.N.Key especificado é inválido.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.