DescribeFileSystems - Amazon Elastic File System
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DescribeFileSystems

返回特定 Amazon EFS 文件系统的描述(如果该文件系统之一)CreationToken或者FileSystemId已提供。否则,它返回调用方拥有的所有文件系统的描述。Amazon Web Services 账户中的Amazon Web Services 区域调用的终端节点。

检索所有文件系统描述时,您可选择性地指定MaxItems参数限制响应中的描述数。目前,此数字自动设置为 10。如果还有更多文件系统描述,Amazon EFS 将返回NextMarker,在响应中是不透明的令牌。在这种情况下,您应使用发送后续请求Marker请求参数设置为的值NextMarker.

要检索文件系统描述的列表,此操作在迭代过程中使用,其中DescribeFileSystems首先被称为没有Marker然后操作继续用Marker参数设置为的值NextMarker从之前的回复直到回复没有NextMarker.

在回应中返回的文件系统的顺序DescribeFileSystems调用以及在多调用迭代的响应中返回的文件系统的顺序未指定。

此操作需要 elasticfilesystem:DescribeFileSystems 操作的权限。

请求语法

GET /2015-02-01/file-systems?CreationToken=CreationToken&FileSystemId=FileSystemId&Marker=Marker&MaxItems=MaxItems HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

CreationToken

(可选)使用此创建令牌 (String) 将列表限制为文件系统。您在创建 Amazon EFS 文件系统时指定创建令牌。

长度约束:最小长度为 1。最大长度为 64。

模式:.+

FileSystemId

(可选)要检索其描述的文件系统的 ID(字符串)。

长度约束:长度上限为 128。

模式:^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

Marker

(可选)从上一个返回的不透明分页标记DescribeFileSystems操作(字符串)。如果存在,则指定继续列表从回电中断的位置。

长度约束:最小长度为 1。长度上限为 128。

模式:.+

MaxItems

(可选)指定要在响应中返回的文件系统的最大数量(整数)。此数字将自动设置为 100。如果您有 100 个以上的文件系统,则响应按每页 100 个分页。

有效范围:最小值为 1。

请求正文

该请求没有请求体。

响应语法

HTTP/1.1 200 Content-type: application/json { "FileSystems": [ { "AvailabilityZoneId": "string", "AvailabilityZoneName": "string", "CreationTime": number, "CreationToken": "string", "Encrypted": boolean, "FileSystemArn": "string", "FileSystemId": "string", "KmsKeyId": "string", "LifeCycleState": "string", "Name": "string", "NumberOfMountTargets": number, "OwnerId": "string", "PerformanceMode": "string", "ProvisionedThroughputInMibps": number, "SizeInBytes": { "Timestamp": number, "Value": number, "ValueInIA": number, "ValueInStandard": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThroughputMode": "string" } ], "Marker": "string", "NextMarker": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

FileSystems

一组文件系统说明。

类型: 数组FileSystemDescriptionobjects

Marker

如果调用者在请求中提供,则显示(String)。

类型: String

长度约束:最小长度为 1。长度上限为 128。

模式:.+

NextMarker

如果响应中返回的文件系统多于返回的文件系统(String),则显示。您可以使用NextMarker在接下来的获取描述的请求中。

类型: String

长度约束:最小长度为 1。长度上限为 128。

模式:.+

Errors

BadRequest

如果请求格式不正确或包含错误,例如无效的参数值或缺少必需参数,则返回此选项。

HTTP 状态代码:400

FileSystemNotFound

返回指定的FileSystemId请求者中不存在该值Amazon Web Services 账户.

HTTP 状态代码:404

InternalServerError

如果服务器端发生错误,则返回。

HTTP 状态代码:500

Examples

检索 10 个文件系统的列表

下面的示例将 GET 请求发送到file-systems终端节点 (elasticfilesystem.us-west-2.amazonaws.com/2015-02-01/file-systems)。该请求指定一个MaxItems将文件系统描述数限制为 10。

示例请求

GET /2015-02-01/file-systems?MaxItems=10 HTTP/1.1 Host: elasticfilesystem.us-west-2.amazonaws.com x-amz-date: 20140622T191208Z Authorization: <...>

示例响应

HTTP/1.1 200 OK x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: application/json Content-Length: 499 { "FileSystems":[ { "OwnerId":"251839141158", "CreationToken":"MyFileSystem1", "FileSystemId":"fs-01234567", "PerformanceMode" : "generalPurpose", "CreationTime":"1403301078", "LifeCycleState":"created", "Name":"my first file system", "NumberOfMountTargets":1, "SizeInBytes":{ "Timestamp": 1403301078, "Value": 29313417216, "ValueInIA": 675432, "ValueInStandard": 29312741784 } } ] }

另请参阅

有关在特定语言的Amazon软件开发工具包中使用此 API 的更多信息,请参阅以下内容: