

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# DescribeAccessPoints
<a name="API_DescribeAccessPoints"></a>

`AccessPointId` が提供されている場合、特定の Amazon EFS アクセスポイントの説明を返します。EFS `FileSystemId` を指定すると、そのファイルシステムのすべてのアクセスポイントの説明が返されます。リクエストには、`AccessPointId` または `FileSystemId` のどちらかを指定できますが、両方を指定することはできません。

このオペレーションには、`elasticfilesystem:DescribeAccessPoints` アクションに対する許可が必要です。

## リクエストの構文
<a name="API_DescribeAccessPoints_RequestSyntax"></a>

```
GET /2015-02-01/access-points?AccessPointId=AccessPointId&FileSystemId=FileSystemId&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_DescribeAccessPoints_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [AccessPointId](#API_DescribeAccessPoints_RequestSyntax) **   <a name="efs-DescribeAccessPoints-request-uri-AccessPointId"></a>
（オプション）応答で記述する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](#API_DescribeAccessPoints_RequestSyntax) **   <a name="efs-DescribeAccessPoints-request-uri-FileSystemId"></a>
(オプション)`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](#API_DescribeAccessPoints_RequestSyntax) **   <a name="efs-DescribeAccessPoints-request-uri-MaxResults"></a>
(オプション）ファイルシステムのすべてのアクセスポイントを取得する際に、オプションで `MaxItems` パラメータを指定して、応答で返されるオブジェクトの数を制限することができます。デフォルト値は 100 です。  
有効な範囲: 最小値 は 1 です。

 ** [NextToken](#API_DescribeAccessPoints_RequestSyntax) **   <a name="efs-DescribeAccessPoints-request-uri-NextToken"></a>
 `NextToken` は応答がページ割りされている場合に存在します。後続のリクエストで `NextMarker` を使うと、次のページのアクセスポイントの説明を取得することができます。  
長さの制限：最小長 1、最大長は 128 です。  
Pattern: `.+` 

## リクエストボディ
<a name="API_DescribeAccessPoints_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DescribeAccessPoints_ResponseSyntax"></a>

```
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"
}
```

## レスポンス要素
<a name="API_DescribeAccessPoints_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [AccessPoints](#API_DescribeAccessPoints_ResponseSyntax) **   <a name="efs-DescribeAccessPoints-response-AccessPoints"></a>
アクセスポイントの説明の配列。  
型: [AccessPointDescription](API_AccessPointDescription.md) オブジェクトの配列

 ** [NextToken](#API_DescribeAccessPoints_ResponseSyntax) **   <a name="efs-DescribeAccessPoints-response-NextToken"></a>
応答で返されるよりも多くのアクセスポイントがある場合に表示されます。後続のリクエストで NextMarker を使用して、追加の説明をフェッチできます。  
タイプ: 文字列  
長さの制限: 最小長は 1 です。最大長は 128 です。  
パターン: `.+` 

## エラー
<a name="API_DescribeAccessPoints_Errors"></a>

 ** AccessPointNotFound **   
指定された`AccessPointId`値がリクエスタの に存在しない場合に返されます AWS アカウント。    
 ** ErrorCode **   
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。  
 ** Message **   
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404

 ** BadRequest **   
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。    
 ** ErrorCode **   
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。  
 ** Message **   
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400

 ** FileSystemNotFound **   
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。    
 ** ErrorCode **   
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。  
 ** Message **   
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404

 ** InternalServerError **   
サーバー側でエラーが発生した場合に返されます。    
 ** ErrorCode **   
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。  
 ** Message **   
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DescribeAccessPoints_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeAccessPoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeAccessPoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeAccessPoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeAccessPoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeAccessPoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeAccessPoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeAccessPoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeAccessPoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeAccessPoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeAccessPoints) 