DescribeFileSystems
파일 시스템 CreationToken
또는 FileSystemId
가 제공된 경우 특정 Amazon EFS 파일 시스템에 대한 설명을 반환합니다. 그렇지 않을 경우 사용자가 직접 호출하는 엔드포인트의 AWS 리전에서 호출자의 AWS 계정이 소유하는 모든 파일 시스템에 대한 설명을 반환합니다.
모든 파일 시스템 설명을 검색할 때 선택적으로 MaxItems
파라미터를 지정하여 응답의 설명 수를 제한할 수 있습니다. 이 숫자는 자동으로 100으로 설정됩니다. 파일 시스템 설명이 더 남아 있는 경우 Amazon EFS는 응답으로 불투명 토큰인 NextMarker
를 반환합니다. 이 경우 Marker
요청 파라미터를 NextMarker
값으로 설정하여 후속 요청을 보내야 합니다.
파일 시스템 설명 목록을 검색하기 위해 이 작업을 반복 프로세스에서 사용합니다. 반복 프로세스에서는 Marker
를 사용하지 않고 DescribeFileSystems
를 먼저 직접 호출한 다음 Marker
파라미터를 이전 응답의 NextMarker
값으로 설정한 다음 응답에 NextMarker
가 없을 때까지 계속 직접 호출합니다.
한 번의 DescribeFileSystems
직접 호출에 대한 응답으로 반환되는 파일 시스템의 순서와 다중 직접 호출 반복의 응답에서 반환되는 파일 시스템의 순서는 지정되지 않았습니다.
이 작업에는 elasticfilesystem:DescribeFileSystems
액션에 대한 권한이 필요합니다.
Request Syntax
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입니다.
Pattern:
^(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.
Request Body
해당 요청에는 본문이 없습니다.
Response Syntax
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.
패턴:
.+
Errors
- BadRequest
-
요청이 잘못되었거나 잘못된 파라미터 값 또는 필수 파라미터 누락 등의 오류가 있는 경우 반환됩니다.
HTTP 상태 코드: 400
- FileSystemNotFound
-
지정된
FileSystemId
값이 요청자의 AWS 계정에 존재하지 않는 경우 반환됩니다.HTTP 상태 코드: 404
- InternalServerError
-
서버 측에서 오류가 발생한 경우 반환됩니다.
HTTP 상태 코드: 500
예시
10개 파일 시스템 목록을 검색합니다.
다음 예제에서는 file-systems
엔드포인트(elasticfilesystem.us-west-2.amazonaws.com/2015-02-01/file-systems
)에 GET 요청을 보냅니다. 요청은 파일 시스템 설명 수를 10개로 제한하는 MaxItems
쿼리 파라미터를 지정합니다.
샘플 요청
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
}
}
]
}
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.