本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeFileSystems
返回特定 Amazon EFS 文件系统的描述(FileSystemId
如果提供了文件系统CreationToken
或)。否则,它返回调用的终端节点的Amazon Web Services 账户中Amazon Web Services 区域拥有的所有文件系统的描述。
检索所有文件系统描述时,您可以选择指定MaxItems
参数以限制响应中的描述数量。此数字自动设置为 100。如果还有更多文件系统描述,Amazon EFS 会在响应中返回 aNextMarker
(不透明的标记)。在这种情况下,您应该发送后续请求,并将Marker
请求参数设置为的值NextMarker
。
要检索文件系统描述列表,此操作在迭代过程中使用,首先调用时不使用,Marker
然后操作继续调用前一个响应NextMarker
的Marker
参数值,直到响应没有NextMarker
。DescribeFileSystems
一个DescribeFileSystems
调用的响应中返回的文件系统的顺序以及多调用迭代的响应中返回的文件系统的顺序尚不明确。
此操作需要 elasticfilesystem:DescribeFileSystems
操作的权限。
请求语法
GET /2015-02-01/file-systems?CreationToken=CreationToken
&FileSystemId=FileSystemId
&Marker=Marker
&MaxItems=MaxItems
HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- CreationToken
-
(可选)将列表限制为使用此创建令牌(字符串)的文件系统。在创建 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
-
一系列文件系统描述。
类型:FileSystemDescription 对象数组
- Marker
-
如果调用者在请求中提供,则显示(字符串)。
类型:字符串
长度限制:最小长度为 1。最大长度为 128。
模式:
.+
- NextMarker
-
如果文件系统多于响应中返回的文件系统(字符串),则显示。您可以在后续请求
NextMarker
中使用来提取描述。类型:字符串
长度限制:最小长度为 1。最大长度为 128。
模式:
.+
错误
- BadRequest
-
如果请求格式错误或包含错误(例如参数值无效或缺少必需参数),则返回。
HTTP 状态代码:400
- FileSystemNotFound
-
如果请求者的指定
FileSystemId
值不存在,则返回Amazon Web Services 账户。HTTP 状态代码:404
- InternalServerError
-
如果服务器端发生错误,则返回。
HTTP 状态代码:500
示例
检索包含 10 个文件系统的列表
以下示例向file-systems
终端节点 (elasticfilesystem.us-west-2.amazonaws.com/2015-02-01/file-systems
) 发送 GET 请求。该请求指定了一个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 的更多信息,请参阅以下内容: