本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribeAccessPoints
傳回特定 Amazon EFS 存取點的說明 (如果 AccessPointId 已提供)。如果您提供 EFS FileSystemId,則會傳回該檔案系統所有存取點的說明。您可以在請求中提供 AccessPointId 或 FileSystemId,但不能同時提供兩者。
這項操作需要 elasticfilesystem:DescribeAccessPoints 動作的許可。
請求語法
GET /2015-02-01/access-points?AccessPointId=AccessPointId&FileSystemId=FileSystemId&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
URI 請求參數
請求會使用下列 URI 參數。
- AccessPointId
-
(選用) 指定要在回應中描述的 EFS 存取點;與
FileSystemId互斥。長度限制:長度上限為 128。
模式:
^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$ - FileSystemId
-
(選用) 如果您提供
FileSystemId,EFS 會傳回該檔案系統的所有存取點;與AccessPointId互斥。長度限制:長度上限為 128。
模式:
^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$ - MaxResults
-
(選用) 擷取檔案系統的所有存取點時,您可以選擇性地指定
MaxItems參數,以限制回應中傳回的物件數目。預設值為 100.有效範圍:最小值為 1。
- NextToken
-
如果是分頁回應,那麽將會出現
NextToken。您可以在後續請求中使用NextMarker來擷取下一頁的存取點描述。長度限制:長度下限為 1。長度上限為 128。
模式:
.+
請求主體
請求沒有請求主體。
回應語法
HTTP/1.1 200
Content-type: application/json
{
"AccessPoints": [
{
"AccessPointArn": "string",
"AccessPointId": "string",
"ClientToken": "string",
"FileSystemId": "string",
"LifeCycleState": "string",
"Name": "string",
"OwnerId": "string",
"PosixUser": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"RootDirectory": {
"CreationInfo": {
"OwnerGid": number,
"OwnerUid": number,
"Permissions": "string"
},
"Path": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"NextToken": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- AccessPoints
-
存取點描述的陣列。
類型:AccessPointDescription 物件陣列
- NextToken
-
如果存取點超過回應中傳回的存取點,則顯示此陣列。您可以在後續請求中使用 NextMarker 來擷取下一頁的存取點描述。
類型:字串
長度限制:長度下限為 1。長度上限為 128。
模式:
.+
錯誤
- AccessPointNotFound
-
如果指定的
AccessPointId值不存在於請求者的 中,則傳回 AWS 帳戶。- ErrorCode
-
錯誤代碼是一個字串,專門用於識別錯誤狀況。偵測及依類型處理錯誤的程式必須讀取及了解此代碼。
- Message
-
錯誤訊息包含錯誤狀況的一般英文描述,目標對象是人。一般簡單的程式在發生其無法處理的錯誤狀況時,會直接對最終使用者顯示訊息。複雜一些的程式因為錯誤處理更加周密,而且經過適當的國際化,所以很可能會忽略錯誤訊息。
HTTP 狀態碼:404
- BadRequest
-
如果請求格式錯誤或包含錯誤,例如無效的參數值或缺少必要參數,則傳回。
- ErrorCode
-
錯誤代碼是一個字串,專門用於識別錯誤狀況。偵測及依類型處理錯誤的程式必須讀取及了解此代碼。
- Message
-
錯誤訊息包含錯誤狀況的一般英文描述,目標對象是人。一般簡單的程式在發生其無法處理的錯誤狀況時,會直接對最終使用者顯示訊息。複雜一些的程式因為錯誤處理更加周密,而且經過適當的國際化,所以很可能會忽略錯誤訊息。
HTTP 狀態碼:400
- FileSystemNotFound
-
如果指定的
FileSystemId值不存在於請求者的 中,則傳回 AWS 帳戶。- ErrorCode
-
錯誤代碼是一個字串,專門用於識別錯誤狀況。偵測及依類型處理錯誤的程式必須讀取及了解此代碼。
- Message
-
錯誤訊息包含錯誤狀況的一般英文描述,目標對象是人。一般簡單的程式在發生其無法處理的錯誤狀況時,會直接對最終使用者顯示訊息。複雜一些的程式因為錯誤處理更加周密,而且經過適當的國際化,所以很可能會忽略錯誤訊息。
HTTP 狀態碼:404
- InternalServerError
-
如果伺服器端發生錯誤,則傳回。
- ErrorCode
-
錯誤代碼是一個字串,專門用於識別錯誤狀況。偵測及依類型處理錯誤的程式必須讀取及了解此代碼。
- Message
-
錯誤訊息包含錯誤狀況的一般英文描述,目標對象是人。一般簡單的程式在發生其無法處理的錯誤狀況時,會直接對最終使用者顯示訊息。複雜一些的程式因為錯誤處理更加周密,而且經過適當的國際化,所以很可能會忽略錯誤訊息。
HTTP 狀態碼:500
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: