DescribeLocationEfs - AWS DataSync

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribeLocationEfs

為 Amazon EFS 檔案系統傳回中繼資料。AWS DataSync

請求語法

{ "LocationArn": "string" }

請求參數

如需所有動作共用參數的相關資訊,請參閱一般參數

請求接受採用 JSON 格式的下列資料。

LocationArn

您想要瞭解的 Amazon EFS 檔案系統位置的 Amazon Resource Name (ARN)。

類型:字串

長度限制:長度上限為 128。

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

必要:是

回應語法

{ "AccessPointArn": "string", "CreationTime": number, "Ec2Config": { "SecurityGroupArns": [ "string" ], "SubnetArn": "string" }, "FileSystemAccessRoleArn": "string", "InTransitEncryption": "string", "LocationArn": "string", "LocationUri": "string" }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

AccessPointArn

存取 Amazon EFS 檔案系DataSync統的存取點 ARN。

類型:字串

長度限制:長度上限為 128。

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$

CreationTime

建立位置的時間。

類型:Timestamp

Ec2Config

AWS DataSync 用於存取 Amazon EFS 檔案系統的子網路和安全群組。

類型:Ec2Config 物件

FileSystemAccessRoleArn

掛載 Amazon EFS 檔案系統時DataSync擔任的 AWS Identity and Access Management (IAM) 角色。

類型:字串

長度限制:長度上限為 2048。

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$

InTransitEncryption

描述當資DataSync料複製到 Amazon EFS 檔案系統或從 Amazon EFS 檔案系統複製資料時,Transport Layer Security (TLS) 加密。

類型:字串

有效值: NONE | TLS1_2

LocationArn

Amazon EFS 檔案系統位置的 ARN。

類型:字串

長度限制:長度上限為 128。

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

LocationUri

Amazon EFS 檔案系統位置的 URL。

類型:字串

長度限制:長度上限為 4360。

模式:^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$

錯誤

如需所有動作常見的錯誤相關資訊,請參閱常見錯誤

InternalException

當在AWS DataSync服務中發生錯誤時,拋出此異常。

HTTP 狀態碼:500

InvalidRequestException

當客戶端提交格式錯誤的請求時,拋出此異常。

HTTP 狀態碼:400

範例

請求範例

以下範例示範如何取得有關特定 Amazon EFS 檔案系統位置的資訊。

{ "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678" }

回應範例

以下範例會傳回有關 Amazon EFS 檔案系統的位置詳細資料。

{ "CreationTime": 1653319021.353, "Ec2Config": { "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2" ] }, "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890", "LocationUri": "efs://us-east-2.fs-021345abcdef6789/" }

回應範例:描述受限制 Amazon EFS 檔案系統的位置

下列範例會傳回有限存取權限之 Amazon EFS 檔案系統的位置詳細資訊AccessPointArn,包括FileSystemAccessRoleArn、和InTransitEncryption元素。

{ "CreationTime": 1653319021.353, "AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0", "Ec2Config": { "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2" ] }, "FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew", "InTransitEncryption": "TLS1_2", "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890", "LocationUri": "efs://us-east-2.fs-021345abcdef6789/", "Subdirectory": "/mount/path", "Tags": [{ "Key": "Name", "Value": "ElasticFileSystem-1" }] }

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: