DescribeServer - AWS Transfer Family
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラー例以下の資料も参照してください。

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

DescribeServer

ServerId パラメータを渡すことで指定したファイル転送プロトコル対応サーバーについて説明します。

レスポンスには、サーバーのプロパティの説明が含まれます。EndpointType を に設定するとVPC、レスポンスには が含まれますEndpointDetails。

リクエストの構文

{
   "ServerId": "string"
}

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは、次のJSON形式のデータを受け入れます。

ServerId

システムでサーバーに割り当てられた一意の識別子。

型: 文字列

長さの制限: 固定長は 19 です。

Pattern: s-([0-9a-f]{17})

必須：はい

レスポンスの構文

{
   "Server": { 
      "Arn": "string",
      "As2ServiceManagedEgressIpAddresses": [ "string" ],
      "Certificate": "string",
      "Domain": "string",
      "EndpointDetails": { 
         "AddressAllocationIds": [ "string" ],
         "SecurityGroupIds": [ "string" ],
         "SubnetIds": [ "string" ],
         "VpcEndpointId": "string",
         "VpcId": "string"
      },
      "EndpointType": "string",
      "HostKeyFingerprint": "string",
      "IdentityProviderDetails": { 
         "DirectoryId": "string",
         "Function": "string",
         "InvocationRole": "string",
         "SftpAuthenticationMethods": "string",
         "Url": "string"
      },
      "IdentityProviderType": "string",
      "LoggingRole": "string",
      "PostAuthenticationLoginBanner": "string",
      "PreAuthenticationLoginBanner": "string",
      "ProtocolDetails": { 
         "As2Transports": [ "string" ],
         "PassiveIp": "string",
         "SetStatOption": "string",
         "TlsSessionResumptionMode": "string"
      },
      "Protocols": [ "string" ],
      "S3StorageOptions": { 
         "DirectoryListingOptimization": "string"
      },
      "SecurityPolicyName": "string",
      "ServerId": "string",
      "State": "string",
      "StructuredLogDestinations": [ "string" ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "UserCount": number,
      "WorkflowDetails": { 
         "OnPartialUpload": [ 
            { 
               "ExecutionRole": "string",
               "WorkflowId": "string"
            }
         ],
         "OnUpload": [ 
            { 
               "ExecutionRole": "string",
               "WorkflowId": "string"
            }
         ]
      }
   }
}

レスポンス要素

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

次のデータは、 サービスによって JSON 形式で返されます。

Server

指定した ServerID を含むサーバーのプロパティを含む配列。

型: DescribedServer オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InternalServiceError

この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード: 500

InvalidRequestException

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード: 400

ResourceNotFoundException

この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。

HTTP ステータスコード: 400

ServiceUnavailableException

AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。

HTTP ステータスコード: 500

例

例

次の例では、サーバーに割り当てられたプロパティを返します。

リクエスト例


{
   "ServerId": "s-01234567890abcdef"
}

例

この例では、 の 1 つの使用状況を示しています DescribeServer。

レスポンス例


{
    "Server": {
        "Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef",
        "EndpointDetails": {
            "AddressAllocationIds": [
                "eipalloc-01a2eabe3c04d5678",
                "eipalloc-102345be"
            ],
            "SubnetIds": [
                "subnet-047eaa7f0187a7cde",
                "subnet-0a2d0f474daffde18"
            ],
            "VpcEndpointId": "vpce-03fe0080e7cb008b8",
            "VpcId": "vpc-09047a51f1c8e1634"
        },
        "EndpointType": "VPC",
        "HostKeyFingerprint": "your host key,
        "IdentityProviderType": "SERVICE_MANAGED",
        "ServerId": "s-01234567890abcdef",
        "State": "ONLINE",
        "Tags": [],
        "UserCount": 0
    }
}

以下の資料も参照してください。

言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。