

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

# DescribeLocationEfs
<a name="API_DescribeLocationEfs"></a>

提供如何設定 Amazon EFS 檔案系統 AWS DataSync 傳輸位置的詳細資訊。

## 請求語法
<a name="API_DescribeLocationEfs_RequestSyntax"></a>

```
{
   "LocationArn": "string"
}
```

## 請求參數
<a name="API_DescribeLocationEfs_RequestParameters"></a>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

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

 ** [LocationArn](#API_DescribeLocationEfs_RequestSyntax) **   <a name="DataSync-DescribeLocationEfs-request-LocationArn"></a>
您希望取得資訊之 Amazon EFS 檔案系統位置的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`  
必要：是

## 回應語法
<a name="API_DescribeLocationEfs_ResponseSyntax"></a>

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

## 回應元素
<a name="API_DescribeLocationEfs_ResponseElements"></a>

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

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

 ** [AccessPointArn](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-AccessPointArn"></a>
DataSync 用來存取 Amazon EFS 檔案系統的存取點 ARN。  
如需詳細資訊，請參閱[存取受限制的檔案系統](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam)。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$`

 ** [CreationTime](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-CreationTime"></a>
建立位置的時間。  
類型：Timestamp

 ** [Ec2Config](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-Ec2Config"></a>
 AWS DataSync 用來連線至其中一個 Amazon EFS 檔案系統[掛載目標](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)的子網路和安全群組。  
類型：[Ec2Config](API_Ec2Config.md) 物件

 ** [FileSystemAccessRoleArn](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-FileSystemAccessRoleArn"></a>
允許 DataSync 存取 Amazon EFS 檔案系統的 AWS Identity and Access Management (IAM) 角色。  
如需詳細資訊，請參閱[建立用於檔案系統存取的 DataSync IAM 角色](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role)。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`

 ** [InTransitEncryption](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-InTransitEncryption"></a>
指出在 Amazon EFS 檔案系統之間傳輸資料時，DataSync 是否使用 Transport Layer Security (TLS) 加密。  
類型：字串  
有效值:`NONE | TLS1_2` 

 ** [LocationArn](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-LocationArn"></a>
Amazon EFS 檔案系統位置的 ARN。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`

 ** [LocationUri](#API_DescribeLocationEfs_ResponseSyntax) **   <a name="DataSync-DescribeLocationEfs-response-LocationUri"></a>
Amazon EFS 檔案系統位置的 URL。  
類型：字串  
長度限制：長度上限為 4360。  
模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`

## 錯誤
<a name="API_DescribeLocationEfs_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** InternalException **   
當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。  
HTTP 狀態碼：500

 ** InvalidRequestException **   
當用戶端提交格式不正確的請求時，會擲回此例外狀況。  
HTTP 狀態碼：400

## 範例
<a name="API_DescribeLocationEfs_Examples"></a>

### 請求範例
<a name="API_DescribeLocationEfs_Example_1"></a>

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

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

### 回應範例
<a name="API_DescribeLocationEfs_Example_2"></a>

下列範例會傳回 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 檔案系統的位置
<a name="API_DescribeLocationEfs_Example_3"></a>

下列範例會傳回具有限制存取之 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"
    }]
}
```

## 另請參閱
<a name="API_DescribeLocationEfs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationEfs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationEfs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationEfs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationEfs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationEfs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationEfs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationEfs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationEfs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationEfs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationEfs) 