Todos os produtos
Search

Este produto

    Cloud Parallel File Storage:DescribeFileSystems

    Central de documentação

    Cloud Parallel File Storage:DescribeFileSystems

    Última atualização: Sep 21, 2026

    Consulta as informações do sistema de arquivos.

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

    get

    *FileSystem

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

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    FileSystemId

    string

    Não

    O ID do sistema de arquivos.

    • NAS de uso geral: 31a8e4****.

    • NAS Extreme: deve começar com extreme-, como extreme-0015****.

    • Cloud Parallel File Storage (CPFS) (versão com redundância local): deve começar com cpfs-, como cpfs-125487****.

    • CPFS SE (versão com redundância de zona): deve começar com cpfsse-, como cpfsse-022c71b134****.

    31a8e4****
    FileSystemType

    string

    Não

    O tipo de sistema de arquivos.

    Valores válidos:

    • all (padrão): consulta todos os tipos.

    • standard: NAS de uso geral.

    • extreme: NAS Extreme.

    • cpfs: Cloud Parallel File Storage (CPFS) (versão com redundância local).

    • cpfsse: CPFS SE (versão com redundância de zona).

    Nota

    Para consultar vários tipos, separe-os por vírgulas (,).

    standard
    VpcId

    string

    Não

    O ID da nuvem privada virtual (VPC).

    A VPC deve ser a mesma VPC do servidor do Elastic Computing Service (ECS) no qual você deseja montar o sistema de arquivos.

    vpc-bp1sevsgtqvk5gxbl****
    PageSize

    integer

    Não

    O número de sistemas de arquivos em cada página durante uma consulta paginada.

    Valores válidos: 1 a 100.

    Valor padrão: 10.

    1
    PageNumber

    integer

    Não

    O número da página da lista de sistemas de arquivos.

    Valor inicial (valor padrão): 1.

    1
    StorageType

    string

    Não

    O tipo de armazenamento. Atualmente, apenas o CPFS para especificações Lingjun é suportado para consulta filtrada. Outros tipos de sistema de arquivos (FileSystemType) não são suportados. As seguintes especificações são suportadas:

    • bm_advance_400

    • bm_advance_400_large

    • bm_advance_new

    • bm_advance_100

    • cpfslight_100

    • bm_p100_stepsize_300

    • bm_p400_stepsize_1

    • bm_p400_stepsize_300

    Você pode especificar várias especificações separadas por vírgulas (,). Por exemplo: bm_advance_400,bm_advance_new.

    bm_advance_400
    Tag

    array<object>

    Não

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

    object

    Não

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

    Key

    string

    Não

    A chave da tag.

    Limites:

    • Valores válidos de N: 1 a 20.

    • A chave da tag pode ter até 128 caracteres de comprimento.

    • A chave da tag não pode começar com aliyun ou acs:.

    • A chave da tag não pode conter http:// ou https://.

    testKey
    Value

    string

    Não

    O valor da tag.

    Limites:

    • Valores válidos de N: 1 a 20.

    • O valor da tag pode ter até 128 caracteres de comprimento.

    • O valor da tag não pode começar com aliyun ou acs:.

    • O valor da tag não pode conter http:// ou https://.

    testValue
    ResourceGroupId

    string

    Não

    O ID do grupo de recursos.

    Você pode visualizar o ID do grupo de recursos no console de Gerenciamento de Recursos.

    rg-acfmwavnfef****

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    FileSystems

    object

    FileSystem

    array<object>

    A lista de sistemas de arquivos.

    array<object>

    AccessPointCount

    string

    O número de pontos de acesso.

    1
    AutoSnapshotPolicyId

    string

    O ID da política de snapshot automático.

    sp-extreme-09npwxadu1eqvw****
    AutoUpgradeConfig

    object

    A configuração de expansão automática.

    capacityUsedRatio

    integer

    O limite de uso, em porcentagem.

    80
    enabled

    boolean

    Especifica se a expansão automática deve ser ativada. Valores válidos:\n● true: Ativa a expansão automática.\n● false: Desativa a expansão automática.

    step

    integer

    O tamanho da etapa de expansão. Unidade: GiB.

    100
    time

    integer

    O limite de duração. Unidade: minutos.

    30
    Bandwidth

    integer

    A largura de banda do sistema de arquivos.\n\nUnidade: MB/s. Este campo não é retornado para sistemas de arquivos NAS de uso geral.

    150
    Capacity

    integer

    A capacidade do sistema de arquivos.\n\nUnidade: GiB.

    100
    ChargeType

    string

    O tipo de cobrança.\n\nValores válidos:\n- Subscription: assinatura.\n- PayAsYouGo: pay-as-you-go.\n- Package: um plano de armazenamento está vinculado.

    PayAsYouGo
    CreateTime

    string

    A hora em que o sistema de arquivos foi criado. A hora é exibida no fuso horário local CST no formato yyyy-MM-ddTHH:mm:ssCST. Exemplo: 2026-07-20T14:31:42CST.

    2026-07-20T14:31:42CST
    Description

    string

    A descrição do sistema de arquivos.

    test
    EncryptType

    integer

    O tipo de criptografia.\n\nValores válidos:\n\n- 0: não criptografado.\n- 1: chave gerenciada pelo NAS.\n- 2: chave personalizada (KMS).

    1
    ExpiredTime

    string

    A hora em que o sistema de arquivos expira. A hora segue o padrão ISO 8601 em UTC. Formato: yyyy-MM-ddTHH:mm:ssZ.

    2020-01-05T16:00:00Z
    FileSystemId

    string

    O ID do sistema de arquivos.

    109c04****
    FileSystemType

    string

    O tipo do sistema de arquivos.\n\nValores válidos:\n\n- standard: NAS de uso geral.\n- extreme: Extreme NAS.\n- cpfs: Cloud Parallel File Storage (localmente redundante).\n- cpfsse: Cloud Parallel File Storage SE (redundante entre zonas).

    standard
    KMSKeyId

    string

    O ID da chave KMS.

    0e478b7a-4262-4802-b8cb-00d3fb40****
    Ldap

    object

    As informações de configuração do LDAP.\n\nEste parâmetro é retornado apenas para sistemas de arquivos CPFS.

    BindDN

    string

    O nome distinto (DN) usado para vincular ao servidor LDAP.

    cn=alibaba,dc=com
    SearchBase

    string

    A base de pesquisa LDAP.

    dc=example
    URI

    string

    O endereço do servidor LDAP.

    ldap://ldap.example.example
    MeteredArchiveSize

    integer

    O uso de armazenamento da classe de armazenamento de arquivamento.\n\nUnidade: bytes.

    1611661312
    MeteredIASize

    integer

    O uso de armazenamento da classe de armazenamento IA.\n\nUnidade: bytes.

    362832
    MeteredSize

    integer

    O uso de armazenamento padrão do sistema de arquivos.\n\nEste não é o uso em tempo real. Ele representa o uso máximo na hora anterior. Unidade: bytes.\n> Para visualizar a capacidade total de armazenamento de um sistema de arquivos, consulte Consultar o uso de recursos do sistema de arquivos.

    1611661312
    MountTargets

    object

    MountTarget

    array<object>

    As informações do destino de montagem.

    array<object>

    AccessGroupName

    string

    O nome do grupo de permissões usado pelo destino de montagem.

    test-001
    ClientMasterNodes

    object

    ClientMasterNode

    array<object>

    As informações do nó de gerenciamento do cliente.\n\nEste parâmetro é retornado apenas para sistemas de arquivos CPFS.

    object

    DefaultPasswd

    string

    A senha de logon padrão do nó de gerenciamento.

    123456
    EcsId

    string

    O ID da instância ECS usada como nó de gerenciamento.

    i-hp3i3odi5ory1buo****
    EcsIp

    string

    O endereço IP da instância ECS usada como nó de gerenciamento.

    192.168.1.0
    DualStackMountTargetDomain

    string

    O domínio do destino de montagem de pilha dupla (IPv4 e IPv6).\n\n> Apenas sistemas de arquivos Extreme NAS em regiões na China continental suportam IPv6.

    174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
    MountTargetDomain

    string

    O domínio do destino de montagem.

    109c042666-w****.cn-hangzhou.nas.aliyuncs.com
    NetworkType

    string

    O tipo de rede. O valor é vpc, que indica uma nuvem privada virtual (VPC).

    vpc
    Status

    string

    O status do destino de montagem.\n\nValores válidos:\n\n- Active: disponível.\n- Inactive: indisponível.\n- Pending: a tarefa está sendo processada.\n- Deleting: o destino de montagem está sendo excluído.\n- Hibernating: o destino de montagem está entrando em hibernação.\n- Hibernated: o destino de montagem está hibernado.

    Active
    Tags

    object

    Tag

    array<object>

    As informações de tag do destino de montagem.

    object

    Key

    string

    A chave da tag.

    testKey
    Value

    string

    O valor da tag.

    testValue
    VpcId

    string

    O ID da VPC associada ao destino de montagem. Este campo é retornado apenas para sistemas de arquivos NAS de uso geral.

    vpc-bp1sevsgtqvk5gxbl****
    VswId

    string

    O ID do vSwitch associado ao destino de montagem. Este campo é retornado apenas para sistemas de arquivos NAS de uso geral.

    vsw-bp1omfzsszekkvaxn****
    Options

    object

    As opções.

    EnableABE

    boolean

    Indica se o recurso de controle de acesso de Enumeração Baseada em Acesso (ABE) do SMB está ativado.

    true
    EnableDataInsight

    boolean

    Indica se o recurso EBS Lens está ativado.

    false
    EnableOplock

    boolean

    Indica se o recurso OpLock está ativado.\nValores válidos:\n- true: Ativado.\n- false: Não ativado.\n> Apenas sistemas de arquivos com o tipo de protocolo SMB suportam este recurso.

    true
    VscAccessPointAccessOnly

    boolean

    Indica se o destino de montagem VSC para computação de IA suporta acesso apenas por meio de pontos de acesso.

    false
    Packages

    object

    Package

    array<object>

    As informações do plano de armazenamento.

    object

    ExpiredTime

    string

    A hora em que o plano de armazenamento expira. A hora segue o padrão ISO 8601 em UTC. Formato: yyyy-MM-ddTHH:mm:ssZ.

    2020-01-05T16:00:00Z
    PackageId

    string

    O ID do plano de armazenamento.

    naspackage-0be9c4b624-37****
    PackageType

    string

    O tipo do plano de armazenamento.\n\nValores válidos:\n\n- ssd: sistema de arquivos NAS de desempenho.\n- hybrid: sistema de arquivos NAS de capacidade.

    hybrid
    Size

    integer

    A capacidade do plano de armazenamento.\nUnidade: bytes.

    107374182400
    StartTime

    string

    A hora de início do plano de armazenamento. A hora segue o padrão ISO 8601 em UTC. Formato: yyyy-MM-ddTHH:mm:ssZ.

    2019-12-05T01:40:56Z
    ProtocolType

    string

    O tipo de protocolo do sistema de arquivos.\n\nValores válidos:\n\n- NFS: protocolo NFS.\n- SMB: protocolo SMB.\n- cpfs: o tipo de protocolo suportado por sistemas de arquivos CPFS ou CPFS SE.

    NFS
    QuorumVswId

    string

    O ID do vSwitch.

    vsw-bp1omfzsszekkvaxn****
    RedundancyType

    string

    O tipo de redundância de armazenamento. Este campo tem um valor apenas para sistemas de arquivos CPFS SE.

    ZRS
    RedundancyVSwitchIds

    object

    RedundancyVSwitchId

    array

    A lista de IDs de vSwitch redundantes entre zonas.

    string

    A lista de IDs de vSwitch redundantes entre zonas.\nEste campo tem um valor quando RedundancyType é definido como ZRS.

    vsw-123xxx
    RegionId

    string

    O ID da região.

    cn-hangzhou
    ResourceGroupId

    string

    O ID do grupo de recursos.

    rg-acfmwavnfef****
    Status

    string

    O status do sistema de arquivos. Valores válidos:\n- Pending: O sistema de arquivos está processando uma tarefa.\n- Running: O sistema de arquivos está ativo. Você pode realizar operações subsequentes (como criar destinos de montagem) apenas quando o status for Running.\n- Stopped: O sistema de arquivos está indisponível.\n- Extending: O sistema de arquivos está sendo expandido.\n- Stopping: O sistema de arquivos está sendo parado.\n- Deleting: O sistema de arquivos está sendo excluído.

    Pending
    StorageType

    string

    O tipo de armazenamento.\n\nValores válidos:\n\n- NAS de uso geral: Capacity, Performance ou Premium\n- Extreme NAS: standard ou advance\n- CPFS: advance_100 (linha de base de 100 MB/s/TiB), advance_200 (linha de base de 200 MB/s/TiB) ou economic\n- CPFS SE: advance_100 (linha de base de 100 MB/s/TiB)\n- AgenticFS: Agentic (disponível apenas quando FileSystemType é definido como standard)\n- CPFS for Lingjun: bm_advance_400, bm_advance_400_large, bm_advance_new, bm_advance_100, cpfslight_100, bm_p100_stepsize_300, bm_p400_stepsize_1 ou bm_p400_stepsize_300

    Performance
    SupportedFeatures

    object

    SupportedFeature

    array

    Os recursos suportados pelo sistema de arquivos.

    string

    O recurso suportado pelo sistema de arquivos.\n\nValores válidos:\n\n- Lifecycle: gerenciamento de ciclo de vida.\n- ACL: lista de controle de acesso.\n- Ipv6: IPv6.\n> Atualmente, apenas sistemas de arquivos Extreme NAS em regiões dentro da parte continental da China suportam IPv6.

    Lifecycle
    Tags

    object

    Tag

    array<object>

    As informações de tag do sistema de arquivos.

    object

    Key

    string

    A chave da tag.

    testKey
    Value

    string

    O valor da tag.

    testValue
    Version

    string

    O número da versão do sistema de arquivos.\n\nEste campo se aplica a sistemas de arquivos Extreme NAS e CPFS.

    2.3.4
    VpcId

    string

    O ID da VPC associada ao sistema de arquivos. Este campo é retornado apenas para sistemas de arquivos CPFS de uso geral.

    vpc-bp1sevsgtqvk5gxbl****
    VscTarget

    string
    Nota

    Este parâmetro ainda não está disponível para uso.

    cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com
    VswIds

    object

    VswId

    array

    As informações do vSwitch.

    string

    O ID do vSwitch associado ao sistema de arquivos. Este campo é retornado apenas para sistemas de arquivos CPFS de uso geral.

    vsw-2zeu1ncsckw5mv2j481gw
    ZoneId

    string

    A zona onde o sistema de arquivos reside.

    cn-hangzhou-b
    PageNumber

    integer

    O número da página da lista de sistemas de arquivos.

    1
    PageSize

    integer

    O número de sistemas de arquivos em cada página.

    1
    RequestId

    string

    O ID da solicitação.

    035B3A3A-E514-4B41-B906-5D906CFB****
    TotalCount

    integer

    O número total de sistemas de arquivos.

    1

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "FileSystems": {
    "FileSystem": [
      {
        "AccessPointCount": "1",
        "AutoSnapshotPolicyId": "sp-extreme-09npwxadu1eqvw****",
        "AutoUpgradeConfig": {
          "capacityUsedRatio": 80,
          "enabled": false,
          "step": 100,
          "time": 30
        },
        "Bandwidth": 150,
        "Capacity": 100,
        "ChargeType": "PayAsYouGo",
        "CreateTime": "2026-07-20T14:31:42CST",
        "Description": "test",
        "EncryptType": 1,
        "ExpiredTime": "2020-01-05T16:00:00Z",
        "FileSystemId": "109c04****",
        "FileSystemType": "standard",
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "Ldap": {
          "BindDN": "cn=alibaba,dc=com",
          "SearchBase": "dc=example",
          "URI": "ldap://ldap.example.example"
        },
        "MeteredArchiveSize": 1611661312,
        "MeteredIASize": 362832,
        "MeteredSize": 1611661312,
        "MountTargets": {
          "MountTarget": [
            {
              "AccessGroupName": "test-001",
              "ClientMasterNodes": {
                "ClientMasterNode": [
                  {
                    "DefaultPasswd": "123456",
                    "EcsId": "i-hp3i3odi5ory1buo****",
                    "EcsIp": "192.168.1.0"
                  }
                ]
              },
              "DualStackMountTargetDomain": "174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com",
              "MountTargetDomain": "109c042666-w****.cn-hangzhou.nas.aliyuncs.com",
              "NetworkType": "vpc",
              "Status": "Active",
              "Tags": {
                "Tag": [
                  {
                    "Key": "testKey",
                    "Value": "testValue"
                  }
                ]
              },
              "VpcId": "vpc-bp1sevsgtqvk5gxbl****",
              "VswId": "vsw-bp1omfzsszekkvaxn****"
            }
          ]
        },
        "Options": {
          "EnableABE": true,
          "EnableDataInsight": false,
          "EnableOplock": true,
          "VscAccessPointAccessOnly": false
        },
        "Packages": {
          "Package": [
            {
              "ExpiredTime": "2020-01-05T16:00:00Z",
              "PackageId": "naspackage-0be9c4b624-37****",
              "PackageType": "hybrid",
              "Size": 107374182400,
              "StartTime": "2019-12-05T01:40:56Z"
            }
          ]
        },
        "ProtocolType": "NFS",
        "QuorumVswId": "vsw-bp1omfzsszekkvaxn****",
        "RedundancyType": "ZRS",
        "RedundancyVSwitchIds": {
          "RedundancyVSwitchId": [
            "vsw-123xxx"
          ]
        },
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-acfmwavnfef****",
        "Status": "Pending",
        "StorageType": "Performance",
        "SupportedFeatures": {
          "SupportedFeature": [
            "Lifecycle"
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        },
        "Version": "2.3.4",
        "VpcId": "vpc-bp1sevsgtqvk5gxbl****",
        "VscTarget": "cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com",
        "VswIds": {
          "VswId": [
            "vsw-2zeu1ncsckw5mv2j481gw"
          ]
        },
        "ZoneId": "cn-hangzhou-b"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 1,
  "RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
  "TotalCount": 1
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 Region.NotSupported The specified Region is not supported for this API now. Este recurso não é suportado na região atual.
    404 InvalidFileSystem.NotFound The specified file system does not exist. O sistema de arquivos especificado não existe.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.