DescribeFileSystems - File Storage NAS: Central de Documentação do Alibaba Cloud

Consulta 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

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**. Extreme NAS: deve começar com extreme-, como extreme-0015. Cloud Parallel File Storage (CPFS) (localmente redundante): deve começar com cpfs-, como cpfs-125487. CPFS SE (redundante por 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: Extreme NAS. cpfs: Cloud Parallel File Storage (CPFS) (localmente redundante). cpfsse: CPFS SE (redundante por zona). Nota Para consultar vários tipos, separe-os com vírgulas (,).	standard
VpcId	string	Não	O ID da nuvem privada virtual (VPC). A VPC deve ser a mesma VPC do servidor 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
Tag	array<object>	Não	As informações da tag.
	object	Não	As informações da tag.
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>
Status	string	O status do sistema de arquivos. Valores válidos: Pending: O sistema de arquivos está processando um nó. Running: O sistema de arquivos está ativo. Você pode executar as próximas etapas (como criar um destino de montagem) somente quando o status for Running. Stopped: O sistema de arquivos está indisponível. Extending: O sistema de arquivos está sendo expandido. Stopping: O sistema de arquivos está sendo parado. Deleting: O sistema de arquivos está sendo excluído.	Pending
MeteredIASize	integer	O uso de armazenamento da classe de armazenamento IA. Unidade: bytes.	362832
Capacity	integer	A capacidade do sistema de arquivos. Unidade: GiB.	100
CreateTime	string	A hora em que o sistema de arquivos foi criado.	2020-01-05T16:00:00Z
ChargeType	string	O método de cobrança. Valores válidos: Subscription: assinatura. PayAsYouGo: pay-as-you-go. Package: um plano de armazenamento está anexado.	PayAsYouGo
Tags	object
Tag	array<object>	As informações da tag do sistema de arquivos.
	object
Key	string	A chave da tag.	testKey
Value	string	O valor da tag.	testValue
StorageType	string	O tipo de armazenamento. Valores válidos: NAS de uso geral: Capacity, Performance, Premium Extreme NAS: standard, advance CPFS: advance_100 (linha de base de 100 MB/s/TiB), advance_200 (linha de base de 200 MB/s/TiB), economic CPFS SE: advance_100 (linha de base de 100 MB/s/TiB)	Performance
MeteredSize	integer	O uso de armazenamento padrão do sistema de arquivos. Este não é um valor em tempo real. Ele representa o uso máximo na hora anterior. Unidade: bytes. Nota Para visualizar a capacidade total de armazenamento de um sistema de arquivos, consulte Consultar uso de recursos do sistema de arquivos.	1611661312
Description	string	A descrição do sistema de arquivos.	test
Bandwidth	integer	A largura de banda do sistema de arquivos. Unidade: MB/s. Este campo não é retornado para sistemas de arquivos NAS de uso geral.	150
SupportedFeatures	object
SupportedFeature	array	Os recursos suportados pelo sistema de arquivos.
	string	O recurso suportado pelo sistema de arquivos. Valores válidos: Lifecycle: gerenciamento de ciclo de vida. ACL: lista de controle de acesso. Ipv6: IPv6. Nota Atualmente, apenas sistemas de arquivos Extreme NAS nas regiões da China continental suportam IPv6.	Lifecycle
Version	string	O número da versão do sistema de arquivos. Este campo se aplica a sistemas de arquivos Extreme NAS e CPFS.	2.3.4
ProtocolType	string	O tipo de protocolo do sistema de arquivos. Valores válidos: NFS: protocolo NFS. SMB: protocolo SMB. cpfs: o tipo de protocolo suportado por sistemas de arquivos CPFS ou CPFS SE.	NFS
MountTargets	object
MountTarget	array<object>	As informações do destino de montagem.
	array<object>
VpcId	string	O ID da VPC.	vpc-bp1sevsgtqvk5gxbl****
Status	string	O status do destino de montagem. Valores válidos: Active: disponível. Inactive: indisponível. Pending: processando uma tarefa. Deleting: sendo excluído. Hibernating: entrando em hibernação. Hibernated: hibernado.	Active
ClientMasterNodes	object
ClientMasterNode	array<object>	As informações do nó de gerenciamento de cliente. Este parâmetro é retornado apenas para sistemas de arquivos CPFS.
	object
EcsId	string	O ID da instância ECS do nó de gerenciamento.	i-hp3i3odi5ory1buo****
DefaultPasswd	string	A senha de logon padrão do nó de gerenciamento.	123456
EcsIp	string	O endereço IP da instância ECS do nó de gerenciamento.	192.168.1.0
MountTargetDomain	string	O domínio do destino de montagem.	109c042666-w****.cn-hangzhou.nas.aliyuncs.com
AccessGroupName	string	O nome do grupo de permissões usado pelo destino de montagem.	test-001
DualStackMountTargetDomain	string	O domínio do destino de montagem dual-stack (IPv4 e IPv6). Nota Apenas sistemas de arquivos Extreme NAS nas regiões da China continental suportam IPv6.	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
VswId	string	O ID do vSwitch.	vsw-bp1omfzsszekkvaxn****
Tags	object
Tag	array<object>	As informações da tag do destino de montagem.
	object
Key	string	A chave da tag.	testKey
Value	string	O valor da tag.	testValue
NetworkType	string	O tipo de rede. O valor é vpc, que indica VPC.	vpc
KMSKeyId	string	O ID da chave KMS.	0e478b7a-4262-4802-b8cb-00d3fb40****
AutoSnapshotPolicyId	string	O ID da política de snapshot automático.	sp-extreme-09npwxadu1eqvw****
RegionId	string	O ID da região.	cn-hangzhou
FileSystemType	string	O tipo de sistema de arquivos. Valores válidos: standard: NAS de uso geral. extreme: Extreme NAS. cpfs: Cloud Parallel File Storage (CPFS), localmente redundante. cpfsse: CPFS SE, redundante por zona.	standard
FileSystemId	string	O ID do sistema de arquivos.	109c04****
EncryptType	integer	O tipo de criptografia. Valores válidos: 0: não criptografado. 1: chave gerenciada pelo NAS. 2: Chave personalizada (KMS).	1
Ldap	object	As informações de configuração LDAP. Este 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
ExpiredTime	string	A hora de expiração do sistema de arquivos.	2020-01-05T16:00:00Z
ZoneId	string	A zona na qual o sistema de arquivos reside.	cn-hangzhou-b
VpcId	string	O ID da VPC.	vpc-bp1sevsgtqvk5gxbl****
VswIds	object
VswId	array	As informações do vSwitch.
	string	O ID do vSwitch.	vsw-bp1omfzsszekkvaxn****
Packages	object
Package	array<object>	As informações do plano de armazenamento.
	object
StartTime	string	A hora de início do plano de armazenamento.	2019-12-05T01:40:56Z
ExpiredTime	string	A hora de expiração do plano de armazenamento.	2020-01-05T16:00:00Z
Size	integer	A capacidade do plano de armazenamento. Unidade: bytes.	107374182400
PackageId	string	O ID do plano de armazenamento.	naspackage-0be9c4b624-37****
PackageType	string	O tipo de plano de armazenamento. Valores válidos: ssd: Performance. hybrid: Capacity.	hybrid
AccessPointCount	string	O número de pontos de acesso.	1
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmwavnfef****
MeteredArchiveSize	integer	O uso de armazenamento da classe de armazenamento de arquivamento. Unidade: bytes.	1611661312
Options	object	As opções.
EnableOplock	boolean	Indica se o recurso OpLock está ativado. Valores válidos: true: Ativado. false: Desativado. Nota Apenas sistemas de arquivos que usam o Tipo de Protocolo SMB suportam este recurso.	true
VscAccessPointAccessOnly	boolean
EnableABE	boolean
QuorumVswId	string	O ID do vSwitch.	vsw-bp1omfzsszekkvaxn****
VscTarget	string	Nota Este parâmetro ainda não está disponível.	cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com
RedundancyType	string	O tipo de redundância de armazenamento. Este campo tem valor apenas para sistemas de arquivos CPFS SE.	LRS
RedundancyVSwitchIds	object
RedundancyVSwitchId	array	A lista de IDs de vSwitch redundantes por zona.
	string	A lista de IDs de vSwitch redundantes por zona. Este campo tem valor quando RedundancyType está definido como ZRS.	vsw-123xxx
RequestId	string	O ID da solicitação.	035B3A3A-E514-4B41-B906-5D906CFB****
TotalCount	integer	O número total de sistemas de arquivos.	1
PageSize	integer	O número de sistemas de arquivos em cada página.	1
PageNumber	integer	O número da página da lista de sistemas de arquivos.	1

Exemplos

Resposta de sucesso

JSON formato

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