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

Consulta as informações de fluxo de dados de um sistema de arquivos CPFS.

Descrição da operação

O fluxo de dados é compatível apenas com o CPFS 2.2.0 e posterior, e o CPFS for Lingjun 2.4.0 e posterior. Você pode visualizar as informações da versão na página de detalhes do sistema de arquivos no console.
Entre as chaves de filtro em Filters, FsetIds, DataFlowIds, SourceStorage, ThroughputList e Status exigem correspondência exata, enquanto FileSystemPath, Description e SourceStoragePath aceitam correspondência aproximada.
Há suporte para consultas combinadas.

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:DescribeDataFlows

list

*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. CPFS: O ID deve começar com cpfs-, como cpfs-125487**. CPFS for Lingjun: O ID deve começar com bmcpfs-, como bmcpfs-0015**.	cpfs-099394bd928c****
Filters	array<object>	Não	As chaves de filtro usadas para consultar fluxos de dados.
	object	Não
Key	string	Não	O nome da chave de filtro. Valores válidos: DataFlowIds: Filtra fluxos de dados por ID de fluxo de dados. FsetIds: Filtra fluxos de dados por ID de Fileset. FileSystemPath: Filtra fluxos de dados pelo caminho do Fileset no sistema de arquivos CPFS. SourceStorage: Filtra fluxos de dados pelo caminho de acesso do armazenamento de origem. ThroughputList: Filtra fluxos de dados pela largura de banda de transmissão. Description: Filtra fluxos de dados pela descrição do Fileset. Status: Filtra fluxos de dados pelo status do fluxo de dados. Valores válidos: FileSystemPath : Filtra fluxos de dados pelo caminho do Fileset no sistema de arquivos CPFS. Status : Filtra fluxos de dados pelo status do fluxo de dados. SourceStorage : Filtra fluxos de dados pelo caminho de acesso do armazenamento de origem. Description : Filtra fluxos de dados pela descrição do Fileset. SourceStoragePath : Filtra fluxos de dados pelo caminho de acesso no armazenamento de origem. ThroughputList : Filtra fluxos de dados pela largura de banda de transmissão. DataFlowIds : Filtra fluxos de dados por ID de fluxo de dados. FsetIds : Filtra fluxos de dados por ID de Fileset.	FsetIds
Value	string	Não	O valor da chave de filtro. Este parâmetro não aceita curingas. Se Key estiver definido como DataFlowIds, Value será definido como um ID de fluxo de dados ou parte de um ID de fluxo de dados. Você pode especificar um ou mais IDs de fluxo de dados. Podem ser especificados no máximo 10 IDs de fluxo de dados. Exemplo: df-194433a5be31** ou df-194433a512a2,df-234533a5be31. Se Key estiver definido como FsetIds, Value será definido como um ID de Fileset ou parte de um ID de Fileset. Você pode especificar um ou mais IDs de Fileset. Podem ser especificados no máximo 10 IDs de Fileset. Exemplo: fset-1902718ea0ae ou fset-235718ea0ae,fset-5122718ea0ae**. Se Key estiver definido como FileSystemPath, Value será definido como um caminho ou parte de um caminho no sistema de arquivos CPFS. O valor deve ter de 1 a 1.024 caracteres. Se Key estiver definido como SourceStorage, Value será definido como o caminho de acesso do armazenamento de origem. O valor pode ter até 1.024 caracteres. Se Key estiver definido como ThroughputList, Value será definido como a largura de banda de transmissão do fluxo de dados. Há suporte para consultas combinadas. Se Key estiver definido como Description, Value será definido como a descrição ou parte da descrição do fluxo de dados. Se Key estiver definido como Status, Value será definido como o status do fluxo de dados. Se Key estiver definido como SourceStoragePath, Value será definido como o caminho de acesso ou parte do caminho de acesso no armazenamento de origem. O valor pode ter até 1.024 caracteres.	FsetIds
NextToken	string	Não	O token de paginação. Se os resultados retornados forem truncados, você pode usar este token para recuperar os resultados restantes.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	Não	O número máximo de resultados a serem retornados por consulta. Valores válidos: 10 a 100. Valor padrão: 20.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
DataFlowInfo	object
DataFlow	array<object>	A coleção de informações de fluxo de dados.
	array<object>
AutoRefresh	object
AutoRefresh	array<object>	A coleção de informações da política de atualização automática. Nota Este recurso é compatível apenas com o CPFS.
	object
RefreshPath	string	O diretório de atualização automática. O CPFS verifica automaticamente se os dados de origem neste diretório foram atualizados e importa automaticamente os dados atualizados. Limites: O valor deve ter de 2 a 1.024 caracteres. O valor deve ser codificado em UTF-8. O valor deve começar e terminar com uma barra (/). Nota O diretório deve ser um diretório existente no CPFS e deve estar localizado em um Fileset para o qual o fluxo de dados esteja ativado.	/prefix1/prefix2/
AutoRefreshInterval	integer	O intervalo de atualização automática. O CPFS verifica se os dados no diretório foram atualizados neste intervalo. Se os dados forem atualizados, uma tarefa de atualização automática será iniciada. Unidade: minutos. Valores válidos: 5 a 526600. Valor padrão: 10. Nota Este recurso é compatível apenas com o CPFS.	10
AutoRefreshPolicy	string	A política de atualização automática, que especifica como os dados de origem atualizados são importados para o CPFS. Valores válidos: None: Os dados de origem atualizados não são importados automaticamente para o CPFS. Você pode importar os dados de origem atualizados usando tarefas de fluxo de dados. ImportChanged: Os dados de origem atualizados são importados automaticamente para o CPFS. Nota Este recurso é compatível apenas com o CPFS.	None
CreateTime	string	A hora em que o Fileset foi criado. A hora segue o padrão ISO 8601 e é retornada no formato yyyy-MM-ddTHH:mm:ssZ. Nota Este recurso é compatível apenas com o CPFS.	2021-09-30T10:08:08Z
DataFlowId	string	O ID do fluxo de dados.	df-194433a5be31****
Description	string	A descrição do fluxo de dados. Limites: O valor deve ter de 2 a 128 caracteres. O valor deve começar com uma letra ou um caractere chinês e não pode começar com http:// ou https://. O valor pode conter dígitos, dois-pontos (:), sublinhados (_) e hifens (-).	Bucket01 data flow
ErrorMessage	string	A mensagem de erro. Valores válidos: None (padrão): O fluxo de dados está em um estado normal. SourceStorageUnreachable: O caminho de acesso do armazenamento de origem não pode ser encontrado. ThroughputTooLow: A largura de banda do fluxo de dados é muito baixa.	SourceStorageUnreachable
FileSystemId	string	O ID do sistema de arquivos.	cpfs-099394bd928c****
FileSystemPath	string	O caminho do Fileset no sistema de arquivos CPFS. Limites: O valor deve ter de 2 a 1.024 caracteres. O valor deve ser codificado em UTF-8. O valor deve começar e terminar com uma barra (/). O diretório deve ser um diretório de Fileset no CPFS. Nota Este recurso é compatível apenas com o CPFS.	/a/b/c/
FsetDescription	string	A descrição da atualização automática. Nota Este recurso é compatível apenas com o CPFS.	Auto-refresh 01
FsetId	string	O ID do Fileset. Nota Este recurso é compatível apenas com o CPFS.	fset-1902718ea0ae****
SourceSecurityType	string	O tipo de proteção de segurança do armazenamento de origem. Se o armazenamento de origem precisar ser acessado por meio de proteção de segurança, especifique o tipo de proteção de segurança. Valores válidos: None (padrão): O armazenamento de origem não requer proteção de segurança para acesso. SSL: O acesso é protegido por um certificado SSL.	SSL
SourceStorage	string	O caminho de acesso do armazenamento de origem. Formato: ://[:]. onde: tipo de armazenamento: Apenas o OSS é compatível. id da conta: O UID da conta à qual o armazenamento de origem pertence. caminho: O nome do bucket do OSS. O nome pode conter apenas letras minúsculas, dígitos e hifens (-) e deve começar e terminar com uma letra minúscula ou um dígito. O nome deve ter de 8 a 128 caracteres. O nome deve ser codificado em UTF-8. O nome não pode começar com http:// ou https://. Nota O bucket do OSS deve existir na região atual. O parâmetro id da conta é compatível apenas com o CPFS for Lingjun 2.6.0 e posterior.	oss://178321033379****:bucket-01
SourceStoragePath	string	O caminho de acesso no bucket de armazenamento de origem. Nota Este recurso é compatível apenas com o CPFS for Lingjun.	/prefix/
Status	string	O status do fluxo de dados. Valores válidos: Starting: O fluxo de dados está sendo criado ou iniciado. Running: O fluxo de dados foi criado e está em execução normal. Updating: O fluxo de dados está sendo modificado, como o aumento da largura de banda de transmissão ou a modificação do intervalo de atualização automática. Deleting: O fluxo de dados está sendo excluído. Stopping: O fluxo de dados está sendo interrompido. Stopped: O fluxo de dados está interrompido. Misconfigured: A configuração do fluxo de dados está anormal, como o armazenamento de origem inacessível ou a largura de banda de transmissão muito baixa para concluir a atualização automática.	Running
Throughput	integer	A largura de banda máxima de transmissão do fluxo de dados. Unidade: MB/s. Valores válidos: 600 1200 1500 Nota A largura de banda de transmissão do fluxo de dados deve ser menor que a largura de banda de E/S do sistema de arquivos. Este recurso é compatível apenas com o CPFS.	600
UpdateTime	string	A última vez que o Fileset foi atualizado. A hora segue o padrão ISO 8601 e é retornada no formato yyyy-MM-ddTHH:mm:ssZ. Nota Este recurso é compatível apenas com o CPFS.	2021-09-30T10:08:08Z
NextToken	string	O token de paginação. Se os resultados retornados forem truncados, você pode usar este token para recuperar os resultados restantes.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
RequestId	string	O ID da solicitação.	2D69A58F-345C-4FDE-88E4-BF518948****

Exemplos

Resposta de sucesso

JSON formato

{
  "DataFlowInfo": {
    "DataFlow": [
      {
        "AutoRefresh": {
          "AutoRefresh": [
            {
              "RefreshPath": "/prefix1/prefix2/"
            }
          ]
        },
        "AutoRefreshInterval": 10,
        "AutoRefreshPolicy": "None",
        "CreateTime": "2021-09-30T10:08:08Z",
        "DataFlowId": "df-194433a5be31****",
        "Description": "Bucket01 data flow",
        "ErrorMessage": "SourceStorageUnreachable",
        "FileSystemId": "cpfs-099394bd928c****",
        "FileSystemPath": "/a/b/c/",
        "FsetDescription": "Auto-refresh 01",
        "FsetId": "fset-1902718ea0ae****",
        "SourceSecurityType": "SSL",
        "SourceStorage": "oss://178321033379****:bucket-01",
        "SourceStoragePath": "/prefix/\n",
        "Status": "Running",
        "Throughput": 600,
        "UpdateTime": "2021-09-30T10:08:08Z"
      }
    ]
  },
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****"
}

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 de API atual não oferece suporte a esta versão do sistema de arquivos.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.	O sistema de arquivos não oferece suporte a fluxos de dados.
404	InvalidFilterValue	The specified parameter Filter.1.Value is invalid.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	O sistema de arquivos especificado não existe.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	O parâmetro Filter.N.Key especificado é inválido.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	O parâmetro MaxResults especificado é inválido.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invalid.	O parâmetro NextToken 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.