DescribeFileSystems - 查詢檔案系統資訊 - Cloud Parallel File Storage

查詢檔案系統資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

nas:DescribeFileSystems

get

*FileSystem

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

無

請求參數

名稱	類型	必填	描述	樣本值
FileSystemId	string	否	檔案系統 ID。通用型 NAS：31a8e4**。極速型 NAS：必須以 extreme-開頭，例如 extreme-0015。 CPFS（本地冗餘版本）：必須以 cpfs-開頭，例如 cpfs-125487。 CPFS SE（同城冗餘版本）：必須以 cpfsse-開頭，例如 cpfsse-022c71b134**。	31a8e4****
FileSystemType	string	否	檔案系統類型。取值： all（預設值）：同時查詢所有類型。 standard：通用型 NAS。 extreme：極速型 NAS。 cpfs：檔案儲存體 CPFS（本地冗餘版本）。 cpfsse：檔案儲存體 CPFS SE（同城冗餘版本）。說明如果查詢多個類型，使用英文逗號隔開。	standard
VpcId	string	否	專用網路 ID。必須與待掛載的Elastic Compute Service 選擇相同的 VPC 網路。	vpc-bp1sevsgtqvk5gxbl****
PageSize	integer	否	分頁查詢時，每個分頁包含的檔案系統個數。取值範圍：1~100。預設值：10。	1
PageNumber	integer	否	檔案系統列表的分頁頁碼。起始值（預設值）：1。	1
Tag	array<object>	否	標籤資訊集合。
	object	否	標籤資訊集合。
Key	string	否	標籤鍵。限制： N 的取值範圍為 1~20。最多支援 128 個字元。不能以`aliyun`或`acs:`開頭。不能包含`http://`和`https://`。	testKey
Value	string	否	標籤值。限制： N 的取值範圍為 1~20。最多支援 128 個字元。不能以`aliyun`或`acs:`開頭。不能包含`http://`和`https://`。	testValue
ResourceGroupId	string	否	資源群組 ID。您可以通過資源管理主控台查看資源群組 ID。	rg-acfmwavnfef****

返回參數

名稱	類型	描述	樣本值
	object
FileSystems	object
FileSystem	array<object>	檔案系統列表。
	array<object>
Status	string	檔案系統狀態。包括： Pending：當前檔案系統正在處理任務中。 Running：當前檔案系統可用，當狀態為 Running 時才可以進行後續操作（例如：建立掛載點等）。 Stopped：當前檔案系統不可用。 Extending：當前檔案系統擴容中。 Stopping：當前檔案系統停機中。 Deleting：當前檔案系統刪除中。	Pending
MeteredIASize	integer	低頻儲存用量。單位：Byte。	362832
Capacity	integer	檔案系統的容量。單位：GiB。	100
CreateTime	string	檔案系統的建立時間。	2020-01-05T16:00:00Z
ChargeType	string	計費類型。包括： Subscription：訂用帳戶。 PayAsYouGo：隨用隨付。 Package：已綁定儲存包。	PayAsYouGo
Tags	object
Tag	array<object>	檔案系統標籤資訊集合。
	object
Key	string	標籤鍵。	testKey
Value	string	標籤值。	testValue
StorageType	string	儲存類型。包括：通用型 NAS：Capacity（容量型）、Performance（效能型）、Premium（進階型）極速型 NAS：standard（標準型）、advance（進階型） CPFS：advance_100（100 MB/s/TiB 基準）、advance_200（200 MB/s/TiB 基準）、economic（經濟型） CPFS SE：advance_100（100 MB/s/TiB 基準）	Performance
MeteredSize	integer	檔案系統的標準儲存使用量。非即時使用量，為上一小時最大使用量，單位：Byte。說明如果您需要查看檔案系統總儲存容量，請參見查詢檔案系統資源使用量。	1611661312
Description	string	檔案系統的描述資訊。	test
Bandwidth	integer	檔案系統的頻寬。單位：MB/s。通用型 NAS 沒有該欄位。	150
SupportedFeatures	object
SupportedFeature	array	檔案系統支援的功能集合。
	string	檔案系統支援的功能。包括： Lifecycle：生命週期管理。 ACL：存取控制清單。 Ipv6：IPv6 功能。說明當前僅極速型 NAS 中國內地各地區支援 IPv6 功能。	Lifecycle
Version	string	檔案系統版本號碼。該欄位適用於極速型 NAS 和 CPFS。	2.3.4
ProtocolType	string	檔案系統協議類型。包括： NFS：NFS 檔案協議。 SMB：SMB 檔案協議。 cpfs：CPFS 或 CPFS SE 檔案系統支援的協議類型。	NFS
MountTargets	object
MountTarget	array<object>	掛載點資訊集合。
	array<object>
VpcId	string	專用網路 ID。	vpc-bp1sevsgtqvk5gxbl****
Status	string	掛載點狀態。包括： Active：可用。 Inactive：不可用。 Pending：任務處理中。 Deleting：刪除中。 Hibernating：休眠中。 Hibernated：已休眠。	Active
ClientMasterNodes	object
ClientMasterNode	array<object>	用戶端管理節點資訊集合。僅 CPFS 檔案系統返回該參數。
	object
EcsId	string	管理節點 ECS 執行個體 ID。	i-hp3i3odi5ory1buo****
DefaultPasswd	string	管理節點預設登入密碼。	123456
EcsIp	string	管理節點 ECS 執行個體 IP。	192.168.1.0
MountTargetDomain	string	掛載點。	109c042666-w****.cn-hangzhou.nas.aliyuncs.com
AccessGroupName	string	掛載點使用的許可權組名稱。	test-001
DualStackMountTargetDomain	string	IPv4 和 IPv6 雙棧掛載點。說明僅極速型 NAS 中國內地各地區支援 IPv6 功能。	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
VswId	string	交換器 ID。	vsw-bp1omfzsszekkvaxn****
Tags	object
Tag	array<object>	掛載點標籤資訊集合。
	object
Key	string	標籤鍵。	testKey
Value	string	標籤值。	testValue
NetworkType	string	網路類型。取值為 vpc，表示專用網路類型。	vpc
KMSKeyId	string	KMS 金鑰識別碼。	0e478b7a-4262-4802-b8cb-00d3fb40****
AutoSnapshotPolicyId	string	自動快照策略 ID。	sp-extreme-09npwxadu1eqvw****
RegionId	string	地區 ID。	cn-hangzhou
FileSystemType	string	檔案系統類型。包括： standard：通用型 NAS。 extreme：極速型 NAS。 cpfs：檔案儲存體 CPFS（本地冗餘版本）。 cpfsse：檔案儲存體 CPFS SE（同城冗餘版本）。	standard
FileSystemId	string	檔案系統 ID。	109c04****
EncryptType	integer	加密類型。包括： 0：不加密。 1：NAS 託管密鑰。 2：使用者管理密鑰。	1
Ldap	object	LDAP 配置資訊集合。僅 CPFS 檔案系統返回該參數。
BindDN	string	綁定 LDAP 的指定條目。	cn=alibaba,dc=com
SearchBase	string	LDAP 搜尋起始點。	dc=example
URI	string	LDAP 服務地址。	ldap://ldap.example.example
ExpiredTime	string	檔案系統到期時間。	2020-01-05T16:00:00Z
ZoneId	string	檔案系統所在的可用性區域。	cn-hangzhou-b
VpcId	string	專用網路 ID。	vpc-bp1sevsgtqvk5gxbl****
VswIds	object
VswId	array	交換器資訊集合。
	string	交換器 ID。	vsw-bp1omfzsszekkvaxn****
Packages	object
Package	array<object>	儲存包資訊集合。
	object
StartTime	string	儲存包起始時間。	2019-12-05T01:40:56Z
ExpiredTime	string	儲存包到期時間。	2020-01-05T16:00:00Z
Size	integer	儲存包容量。單位：Byte。	107374182400
PackageId	string	儲存包 ID。	naspackage-0be9c4b624-37****
PackageType	string	儲存包類型。包括： ssd：效能型。 hybrid：容量型。	hybrid
AccessPointCount	string	存取點數量。	1
ResourceGroupId	string	資源群組 ID	rg-acfmwavnfef****
MeteredArchiveSize	integer	Archive Storage用量。單位：Byte。	1611661312
Options	object	選項。
EnableOplock	boolean	是否開啟 OpLock 功能。取值： true：開啟。 false：不開啟。說明僅支援 SMB 協議類型的檔案系統。	true
VscAccessPointAccessOnly	boolean
EnableABE	boolean
QuorumVswId	string	交換器 ID。	vsw-bp1omfzsszekkvaxn****
VscTarget	string	說明該參數暫未開放使用。	cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com
RedundancyType	string	儲存冗餘類型。僅 CPFS SE 時有值。	LRS
RedundancyVSwitchIds	object
RedundancyVSwitchId	array	同城冗餘交換器 ID 列表。
	string	同城冗餘交換器 ID 列表。當設定 RedundancyType 為 ZRS 時，該欄位有值。	vsw-123xxx
RequestId	string	請求 ID。	035B3A3A-E514-4B41-B906-5D906CFB****
TotalCount	integer	檔案系統的總個數。	1
PageSize	integer	每個分頁包含的檔案系統個數。	1
PageNumber	integer	檔案系統列表的分頁頁碼。	1

樣本

正常返回樣本

JSON格式

{
  "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": true,
          "EnableABE": true
        },
        "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
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Region.NotSupported	The specified Region is not supported for this API now.	當前地區暫不支援該功能。
404	InvalidFileSystem.NotFound	The specified file system does not exist.	指定的檔案系統不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。