DescribeServer - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribeServer

Beschreibt einen Server mit aktiviertem Dateiübertragungsprotokoll, den Sie angeben, indem Sie den Parameter übergeben. ServerId

Die Antwort enthält eine Beschreibung der Eigenschaften eines Servers. Wenn Sie EndpointType auf einstellenVPC, enthält die Antwort dieEndpointDetails.

Anforderungssyntax

{
   "ServerId": "string"
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anfrage akzeptiert die folgenden Daten im JSON Format.

ServerId

Ein vom System zugewiesener eindeutiger Bezeichner für einen Server.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

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

Erforderlich: Ja

Antwortsyntax

{
   "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"
            }
         ]
      }
   }
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Dienst im JSON Format zurückgegeben.

Server

Ein Array, das die Eigenschaften eines Servers mit den von ServerID Ihnen angegebenen Eigenschaften enthält.

Typ: DescribedServer Objekt

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InternalServiceError

Diese Ausnahme wird ausgelöst, wenn im AWS Transfer Family Dienst ein Fehler auftritt.

HTTPStatuscode: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.

HTTPStatuscode: 400

ResourceNotFoundException

Diese Ausnahme wird ausgelöst, wenn eine Ressource vom AWS Transfer Family Family-Dienst nicht gefunden wird.

HTTPStatuscode: 400

ServiceUnavailableException

Die Anfrage ist fehlgeschlagen, da der AWS Transfer Family Family-Dienst nicht verfügbar ist.

HTTPStatuscode: 500

Beispiele

Beispiel

Im folgenden Beispiel werden die einem Server zugewiesenen Eigenschaften zurückgegeben.

Beispielanforderung


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

Beispiel

Dieses Beispiel veranschaulicht eine Verwendung von DescribeServer.

Beispielantwort


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

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: