本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeFileSystems
返回特定 Amazon EFS 文件系统的描述(如果提供了文件系统CreationToken
或文件系统)。FileSystemId
否则,它将返回您正在调用的端点 Amazon Web Services 账户 中调用方拥有的所有文件系统的描述。 Amazon Web Services 区域
检索所有文件系统描述时,可以选择指定 MaxItems
参数来限制响应中的描述数量。此数字自动设置为 100。如果还有更多文件系统描述,Amazon 会在响应中EFS返回一个NextMarker
不透明的标记。在这种情况下,应发送一个后续请求,并将 Marker
请求参数的值设置为 NextMarker
。
要检索文件系统描述列表,可以在迭代过程中使用此操作,在此过程中,首先在没有 Marker
的情况下调用 DescribeFileSystems
,然后操作继续调用此内容,并将 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
-
(可选)使用此创建令牌(字符串)将列表限制为文件系统。您在创建 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",
"FileSystemProtection": {
"ReplicationOverwriteProtection": "string"
},
"KmsKeyId": "string",
"LifeCycleState": "string",
"Name": "string",
"NumberOfMountTargets": number,
"OwnerId": "string",
"PerformanceMode": "string",
"ProvisionedThroughputInMibps": number,
"SizeInBytes": {
"Timestamp": number,
"Value": number,
"ValueInArchive": 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": 29313618372,
"ValueInArchive": 201156,
"ValueInIA": 675432,
"ValueInStandard": 29312741784
}
}
]
}
另请参阅
有关API在一种特定语言中使用此功能的更多信息 Amazon SDKs,请参阅以下内容: