Todos os produtos
Search
Central de documentação

Cloud Parallel File Storage:DescribeFilesets

Última atualização: Aug 13, 2026

Consulta a lista de filesets criados.

Descrição da operação

  • Apenas o CPFS 2.2.0 e versões posteriores e o CPFS for Lingjun 2.7.0 e versões posteriores suportam filesets. Você pode visualizar as informações da versão na página de detalhes do sistema de arquivos no console.

  • Para chaves de filtro (Filters), FsetIds requer correspondência exata, enquanto FileSystemPath e Description suportam correspondência aproximada.

  • Consultas combinadas são suportadas.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

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-099394bd928c****.

  • CPFS for Lingjun: O ID deve começar com bmcpfs-, como bmcpfs-290w65p03ok64ya****.

Nota

Esta operação suporta apenas sistemas de arquivos CPFS (com prefixos de ID cpfs-* ou bmcpfs-*). Sistemas de arquivos NAS de uso geral e NAS Extreme não são suportados.

bmcpfs-290w65p03ok64ya****

Filters

array<object>

Não

As informações de chave de filtro para os filesets a serem consultados.

object

Não

Key

string

Não

O nome da chave de filtro. Valores válidos:

  • FsetIds: filtra por ID do fileset.

  • FileSystemPath: filtra pelo caminho do fileset no sistema de arquivos CPFS.

  • Description: filtra pela descrição do fileset.

  • QuotaExists: filtra pela existência de cota.

Nota

Apenas o CPFS for Lingjun 2.7.0 e versões posteriores suportam filtragem pelo parâmetro QuotaExists.

Valores válidos:

  • FileSystemPath :

    filtra pelo caminho do fileset no sistema de arquivos CPFS.

  • Description :

    filtra pela descrição do fileset.

  • FsetIds :

    filtra por ID do fileset.

  • QuotaExists :

    filtra pela existência de cota.

FsetIds

Value

string

Não

O valor da chave de filtro. Caracteres curinga não são suportados para este parâmetro.

  • Se Key estiver definido como FsetIds, Value será definido como um ID de fileset. Você pode especificar um ou mais IDs de fileset, até um máximo de 10. Separe vários valores com vírgulas (,). Exemplo: fset-1902718ea0ae**** ou fset-1902718ea0ae****,fset-3212718ea0ae****.

  • Se Key estiver definido como FileSystemPath, Value será definido como o caminho ou um caminho parcial do fileset no sistema de arquivos CPFS. O valor deve ter de 2 a 1.024 caracteres e ser codificado em UTF-8.

  • Se Key estiver definido como Description, Value será definido como a descrição ou uma descrição parcial do fileset.

  • Se Key estiver definido como QuotaExists, Value será definido como true ou false. Se este parâmetro for deixado vazio, todos os filesets serão retornados.

fset-1902718ea0ae****

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, use NextToken para iniciar uma nova solicitação e recuperar o conteúdo após o ponto de truncamento.

TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=

MaxResults

integer

Não

O número de resultados para cada consulta.

Valores válidos: 10 a 100. Valor padrão: 20.

20

OrderByField

string

Não

O campo usado para ordenação.

  • FileCountLimit: o limite de contagem de arquivos da cota.

  • SizeLimit: o limite de capacidade da cota.

  • FileCountUsage: o uso de contagem de arquivos.

  • SpaceUsage: o uso de capacidade.

Valores válidos:

  • SpaceUsage :

    uso de capacidade.

  • FileCountLimit :

    limite de contagem de arquivos da cota.

  • SizeLimit :

    limite de capacidade da cota.

  • FileCountUsage :

    uso de contagem de arquivos.

FileCountLimit

SortOrder

string

Não

A ordem de classificação.

  • asc (padrão): ordem crescente, que classifica os resultados do menor para o maior.

  • desc: ordem decrescente, que classifica os resultados do maior para o menor.

Nota

Este campo só tem efeito quando o parâmetro OrderByField é especificado.

Valores válidos:

  • asc :

    ordem crescente.

  • desc :

    ordem decrescente.

asc

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, use NextToken para iniciar uma nova solicitação e recuperar o conteúdo após o ponto de truncamento.

TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=

FileSystemId deprecated

string

O ID do sistema de arquivos.

  • CPFS: O ID começa com cpfs-, como cpfs-099394bd928c****.

  • CPFS for Lingjun: O ID começa com bmcpfs-, como bmcpfs-290w65p03ok64ya****.

bmcpfs-290w65p03ok64ya****

Entries

object

Entrie

array<object>

A coleção de informações de fileset.

array<object>

A coleção de informações de arquivo.

Description

string

A descrição do fileset.

test

FileSystemPath

string

O caminho do fileset.

pathtoroot/fset

FsetId

string

ID do fileset.

fset-1902718ea0ae****

Status

string

O status do fileset. Valores válidos:

  • CREATING: O fileset está sendo criado.

  • CREATED: O fileset foi criado e está funcionando normalmente.

  • RELEASING: O fileset está sendo liberado.

  • RELEASED: O fileset foi excluído.

CREATED

CreateTime

string

A hora em que o fileset foi criado.

A hora segue o padrão ISO 8601 no formato: yyyy-MM-ddTHH:mm:ssZ.

2021-09-30T10:08:08Z

UpdateTime

string

A hora da última atualização do fileset.

A hora segue o padrão ISO 8601 no formato: yyyy-MM-ddTHH:mm:ssZ.

2021-09-30T10:08:08Z

DeletionProtection

boolean

O atributo de proteção contra liberação que especifica se a instância pode ser liberada pelo console ou chamando a operação DeleteFileset.

  • true: A proteção contra liberação está ativada.

  • false: A proteção contra liberação está desativada.

Nota

Este atributo restringe apenas operações de liberação manual e não se aplica a operações de liberação iniciadas pelo sistema.

true

FileCountUsage

integer

O uso de contagem de arquivos.

Nota

Apenas o CPFS for Lingjun 2.7.0 e versões posteriores suportam este parâmetro.

1024

SpaceUsage

integer

O uso de capacidade. Unidade: bytes.

Nota

Apenas o CPFS for Lingjun 2.7.0 e versões posteriores suportam este parâmetro.

1024

Quota

object

As informações da cota.

Nota

Apenas o CPFS for Lingjun 2.7.0 e versões posteriores suportam este parâmetro.

SizeLimit

integer

O limite de capacidade da cota. Unidade: bytes.

  • Valor mínimo: 10.737.418.240 (10 GiB).

  • Incremento: 1.073.741.824 (1 GiB).

10737418240

FileCountLimit

integer

O limite de contagem de arquivos da cota. Valores válidos:

  • Valor mínimo: 10.000.

  • Valor máximo: 10.000.000.000.

10000

FileSystemId

string

O ID do sistema de arquivos.

  • CPFS: O ID começa com cpfs-, como cpfs-099394bd928c****.

  • CPFS for Lingjun: O ID começa com bmcpfs-, como bmcpfs-290w65p03ok64ya****.

bmcpfs-290w65p03ok64ya****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "FileSystemId": "bmcpfs-290w65p03ok64ya****",
  "Entries": {
    "Entrie": [
      {
        "Description": "test",
        "FileSystemPath": "pathtoroot/fset",
        "FsetId": "fset-1902718ea0ae****",
        "Status": "CREATED",
        "CreateTime": "2021-09-30T10:08:08Z",
        "UpdateTime": "2021-09-30T10:08:08Z",
        "DeletionProtection": true,
        "FileCountUsage": 1024,
        "SpaceUsage": 1024,
        "Quota": {
          "SizeLimit": 10737418240,
          "FileCountLimit": 10000
        },
        "FileSystemId": "bmcpfs-290w65p03ok64ya****"
      }
    ]
  }
}

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 InvalidParameter.SortOrder Invalid sort order. O parâmetro SortOrder é inválido.
400 InvalidParameter.SortOrderField Invalid sort order field. O parâmetro SortOrderField é inválido.
400 InvalidFilesystemType.NotSupport The API operation does not support the file system type. A operação atual não suporta este tipo de sistema de arquivos.
403 OperationDenied.FilesetNotSupported The operation is not supported. O sistema de arquivos não suporta Fileset.
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 InvalidFilterValue The specified Filter.N.Value is invalid. O parâmetro Filter.N.Value especificado é inválido.
404 InvalidParameter.InvalidNextToken The specified NextToken is invaild.
404 InvalidParameter.InvalidMaxResults The specified MaxResults is invalid. O MaxResults 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.