DescribeFileSystems - File Storage NAS - Centre de documentation Alibaba Cloud

Consulte les informations du système de fichiers.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

nas:DescribeFileSystems

get

*FileSystem

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
FileSystemId	string	Non	L'identifiant du système de fichiers. NAS à usage général : 31a8e4**. NAS Extreme : doit commencer par extreme-, par exemple extreme-0015. Cloud Parallel File Storage (CPFS) (version à redondance locale) : doit commencer par cpfs-, par exemple cpfs-125487. CPFS SE (version à redondance de zone) : doit commencer par cpfsse-, par exemple cpfsse-022c71b134**.	31a8e4****
FileSystemType	string	Non	Le type de système de fichiers. Valeurs valides : all (par défaut) : interroge tous les types. standard : NAS à usage général. extreme : NAS Extreme. cpfs : Cloud Parallel File Storage (CPFS) (version à redondance locale). cpfsse : CPFS SE (version à redondance de zone). Remarque Pour interroger plusieurs types, séparez-les par des virgules (,).	standard
VpcId	string	Non	L'identifiant du cloud privé virtuel (VPC). Le VPC doit être identique à celui du serveur Elastic Compute Service (ECS) sur lequel vous souhaitez monter le système de fichiers.	vpc-bp1sevsgtqvk5gxbl****
PageSize	integer	Non	Le nombre de systèmes de fichiers par page lors d'une requête paginée. Valeurs valides : 1 à 100. Valeur par défaut : 10.	1
PageNumber	integer	Non	Le numéro de page de la liste des systèmes de fichiers. Valeur par défaut : 1.	1
StorageType	string	Non	Le type de stockage. Actuellement, seules les spécifications CPFS pour Lingjun sont prises en charge pour les requêtes filtrées. Les autres types de systèmes de fichiers (FileSystemType) ne sont pas pris en charge. Les spécifications suivantes sont prises en charge : 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 Vous pouvez spécifier plusieurs spécifications séparées par des virgules (,). Par exemple : bm_advance_400,bm_advance_new.	bm_advance_400
Tag	array<object>	Non	Les informations de balise.
	object	Non	Les informations de balise.
Key	string	Non	La clé de balise. Limites : Valeurs valides de N : 1 à 20. La clé de balise peut comporter jusqu'à 128 caractères. La clé de balise ne peut pas commencer par `aliyun` ou `acs:`. La clé de balise ne peut pas contenir `http://` ou `https://`.	testKey
Value	string	Non	La valeur de balise. Limites : Valeurs valides de N : 1 à 20. La valeur de balise peut comporter jusqu'à 128 caractères. La valeur de balise ne peut pas commencer par `aliyun` ou `acs:`. La valeur de balise ne peut pas contenir `http://` ou `https://`.	testValue
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Vous pouvez consulter l'identifiant du groupe de ressources dans la console Resource Management.	rg-acfmwavnfef****

Éléments de réponse

Élément	Type	Description	Exemple
	object
FileSystems	object
FileSystem	array<object>	La liste des systèmes de fichiers.
	array<object>
AccessPointCount	string	Le nombre de points d'accès.	1
AutoSnapshotPolicyId	string	L'identifiant de la stratégie d'instantanés automatiques.	sp-extreme-09npwxadu1eqvw****
AutoUpgradeConfig	object	La configuration de l'extension automatique.
capacityUsedRatio	integer	Le seuil d'utilisation, en pourcentage.	80
enabled	boolean	Indique si l'extension automatique doit être activée. Valeurs valides :\n● true : active l'extension automatique.\n● false : désactive l'extension automatique.
step	integer	La taille de l'étape d'extension. Unité : Gio.	100
time	integer	Le seuil de durée. Unité : minutes.	30
Bandwidth	integer	La bande passante du système de fichiers.\n\nUnité : Mo/s. Ce champ n'est pas renvoyé pour les systèmes de fichiers NAS à usage général.	150
Capacity	integer	La capacité du système de fichiers.\n\nUnité : Gio.	100
ChargeType	string	Le type de facturation. Valeurs valides : Subscription : abonnement. PayAsYouGo : paiement à l'usage. Package : un plan de stockage est associé.	PayAsYouGo
CreateTime	string	L'heure de création du système de fichiers. L'heure est affichée dans le fuseau horaire local CST au format yyyy-MM-ddTHH:mm:ssCST. Exemple : 2026-07-20T14:31:42CST.	2026-07-20T14:31:42CST
Description	string	La description du système de fichiers.	test
EncryptType	integer	Le type de chiffrement. Valeurs valides : 0 : non chiffré. 1 : clé gérée par NAS. 2 : clé personnalisée (KMS).	1
ExpiredTime	string	L'heure d'expiration du système de fichiers. L'heure suit la norme ISO 8601 en UTC. Format : yyyy-MM-ddTHH:mm:ssZ.	2020-01-05T16:00:00Z
FileSystemId	string	L'identifiant du système de fichiers.	109c04****
FileSystemType	string	Le type de système de fichiers. Valeurs valides : standard : NAS à usage général. extreme : NAS Extreme. cpfs : Cloud Parallel File Storage (CPFS) (à redondance locale). cpfsse : CPFS SE (à redondance de zone).	standard
KMSKeyId	string	L'identifiant de la clé KMS.	0e478b7a-4262-4802-b8cb-00d3fb40****
Ldap	object	Les informations de configuration LDAP.\n\nCe paramètre n'est renvoyé que pour les systèmes de fichiers CPFS.
BindDN	string	Le nom distinctif (DN) utilisé pour se lier au serveur LDAP.	cn=alibaba,dc=com
SearchBase	string	La base de recherche LDAP.	dc=example
URI	string	L'adresse du serveur LDAP.	ldap://ldap.example.example
MeteredArchiveSize	integer	L'utilisation du stockage de la classe de stockage Archive.\n\nUnité : octets.	1611661312
MeteredIASize	integer	L'utilisation du stockage de la classe de stockage IA.\n\nUnité : octets.	362832
MeteredSize	integer	L'utilisation du stockage standard du système de fichiers.\n\nIl ne s'agit pas d'une utilisation en temps réel. La valeur représente l'utilisation maximale au cours de l'heure précédente. Unité : octets.\n> Pour consulter la capacité de stockage totale d'un système de fichiers, consultez Interroger l'utilisation des ressources du système de fichiers.	1611661312
MountTargets	object
MountTarget	array<object>	Les informations de la cible de montage.
	array<object>
AccessGroupName	string	Le nom du groupe d'autorisations utilisé par la cible de montage.	test-001
ClientMasterNodes	object
ClientMasterNode	array<object>	Les informations du nœud de gestion client.\n\nCe paramètre n'est renvoyé que pour les systèmes de fichiers CPFS.
	object
DefaultPasswd	string	Le mot de passe de connexion par défaut du nœud de gestion.	123456
EcsId	string	L'identifiant de l'instance ECS du nœud de gestion.	i-hp3i3odi5ory1buo****
EcsIp	string	L'adresse IP de l'instance ECS du nœud de gestion.	192.168.1.0
DualStackMountTargetDomain	string	Le domaine de la cible de montage à double pile (IPv4 et IPv6).\n\n> Seuls les systèmes de fichiers NAS Extreme dans les régions de Chine continentale prennent en charge IPv6.	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
MountTargetDomain	string	Le domaine de la cible de montage.	109c042666-w****.cn-hangzhou.nas.aliyuncs.com
NetworkType	string	Le type de réseau. La valeur vpc indique un cloud privé virtuel (VPC).	vpc
Status	string	L'état de la cible de montage. Valeurs valides : Active : disponible. Inactive : indisponible. Pending : la tâche est en cours de traitement. Deleting : la cible de montage est en cours de suppression. Hibernating : la cible de montage entre en hibernation. Hibernated : la cible de montage est en hibernation.	Active
Tags	object
Tag	array<object>	Les informations de balise de la cible de montage.
	object
Key	string	La clé de la balise.	testKey
Value	string	La valeur de la balise.	testValue
VpcId	string	L'identifiant du VPC associé à la cible de montage. Ce champ n'est renvoyé que pour les systèmes de fichiers NAS à usage général.	vpc-bp1sevsgtqvk5gxbl****
VswId	string	L'identifiant du vSwitch associé à la cible de montage. Ce champ n'est renvoyé que pour les systèmes de fichiers NAS à usage général.	vsw-bp1omfzsszekkvaxn****
Options	object	Les options.
EnableABE	boolean	Indique si la fonctionnalité de contrôle d'accès SMB Access-Based Enumeration (ABE) est activée.	true
EnableDataInsight	boolean	Indique si la fonctionnalité EBS Lens est activée.	false
EnableOplock	boolean	Indique si la fonctionnalité OpLock est activée. Valeurs valides : true : Activée. false : Non activée. Remarque Seuls les systèmes de fichiers de type de protocole SMB prennent en charge cette fonctionnalité.	true
VscAccessPointAccessOnly	boolean	Indique si la cible de montage VSC pour le calcul IA prend en charge l'accès uniquement via des points d'accès.	false
Packages	object
Package	array<object>	Les informations du plan de stockage.
	object
ExpiredTime	string	L'heure d'expiration du plan de stockage. L'heure suit la norme ISO 8601 en UTC. Format : yyyy-MM-ddTHH:mm:ssZ.	2020-01-05T16:00:00Z
PackageId	string	L'identifiant du plan de stockage.	naspackage-0be9c4b624-37****
PackageType	string	Le type de plan de stockage. Valeurs valides : ssd : système de fichiers NAS Performance. hybrid : système de fichiers NAS Capacité.	hybrid
Size	integer	La capacité du plan de stockage.\nUnité : octets.	107374182400
StartTime	string	L'heure de début du plan de stockage. L'heure suit la norme ISO 8601 en UTC. Format : yyyy-MM-ddTHH:mm:ssZ.	2019-12-05T01:40:56Z
ProtocolType	string	Le type de protocole du système de fichiers. Valeurs valides : NFS : protocole NFS. SMB : protocole SMB. cpfs : le type de protocole pris en charge par les systèmes de fichiers CPFS ou CPFS SE.	NFS
QuorumVswId	string	L'identifiant du vSwitch.	vsw-bp1omfzsszekkvaxn****
RedundancyType	string	Le type de redondance de stockage. Ce champ n'a de valeur que pour les systèmes de fichiers CPFS SE.	ZRS
RedundancyVSwitchIds	object
RedundancyVSwitchId	array	La liste des identifiants de vSwitch à redondance de zone.
	string	La liste des identifiants de vSwitch à redondance de zone.\nCe champ a une valeur lorsque RedundancyType est défini sur ZRS.	vsw-123xxx
RegionId	string	L'identifiant de la région.	cn-hangzhou
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmwavnfef****
Status	string	L'état du système de fichiers. Valeurs valides : Pending : le système de fichiers traite un nœud. Running : le système de fichiers est actif. Vous pouvez effectuer les opérations suivantes (telles que la création de points de montage) uniquement lorsque l'état est Running. Stopped : le système de fichiers est indisponible. Extending : le système de fichiers est en cours d'extension. Stopping : le système de fichiers est en cours d'arrêt. Deleting : le système de fichiers est en cours de suppression.	Pending
StorageType	string	Le type de stockage. Valeurs valides : NAS à usage général : Capacity, Performance ou Premium NAS Extreme : standard ou advance CPFS : advance_100 (débit de base de 100 Mo/s/Tio), advance_200 (débit de base de 200 Mo/s/Tio) ou economic CPFS SE : advance_100 (débit de base de 100 Mo/s/Tio) AgenticFS : Agentic (disponible uniquement lorsque FileSystemType est défini sur standard) CPFS pour 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	Les fonctionnalités prises en charge par le système de fichiers.
	string	La fonctionnalité prise en charge par le système de fichiers. Valeurs valides : Lifecycle : gestion du cycle de vie. ACL : liste de contrôle d'accès. Ipv6 : IPv6. Remarque Actuellement, seuls les systèmes de fichiers Extreme NAS dans les régions de Chine continentale prennent en charge IPv6.	Lifecycle
Tags	object
Tag	array<object>	Les informations de balise du système de fichiers.
	object
Key	string	La clé de la balise.	testKey
Value	string	La valeur de la balise.	testValue
Version	string	Le numéro de version du système de fichiers.\n\nCe champ s'applique aux systèmes de fichiers NAS Extreme et CPFS.	2.3.4
VpcId	string	L'identifiant du VPC associé au système de fichiers. Ce champ n'est renvoyé que pour les systèmes de fichiers CPFS à usage général.	vpc-bp1sevsgtqvk5gxbl****
VscTarget	string	Remarque Ce paramètre n'est pas disponible.	cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com
VswIds	object
VswId	array	Les informations du vSwitch.
	string	L'identifiant du vSwitch associé au système de fichiers. Ce champ n'est renvoyé que pour les systèmes de fichiers CPFS à usage général.	vsw-2zeu1ncsckw5mv2j481gw
ZoneId	string	La zone où réside le système de fichiers.	cn-hangzhou-b
PageNumber	integer	Le numéro de page de la liste des systèmes de fichiers.	1
PageSize	integer	Le nombre de systèmes de fichiers par page.	1
RequestId	string	L'identifiant de la requête.	035B3A3A-E514-4B41-B906-5D906CFB****
TotalCount	integer	Le nombre total de systèmes de fichiers.	1

Exemples

JSON format

{
  "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
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	Region.NotSupported	The specified Region is not supported for this API now.	Cette fonctionnalité n'est pas prise en charge dans la région actuelle.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	Le système de fichiers spécifié n'existe pas.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.