DescribeServer - Amazon Transfer Family
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DescribeServer

描述您通过传递ServerId参数指定的启用文件传输协议的服务器。

响应包含对服务器属性的描述。当您设置EndpointType为 VPC 时,响应将包含EndpointDetails

请求语法

{ "ServerId": "string" }

请求参数

有关由所有操作共享的参数的信息,请参阅Common Parameters (常用参数)。

请求接受采用 JSON 格式的以下数据。

ServerId

服务器的系统分配的唯一标识符。

类型:字符串

长度限制:固定长度为 19。

模式:^s-([0-9a-f]{17})$

必需:是

响应语法

{ "Server": { "Arn": "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", "Url": "string" }, "IdentityProviderType": "string", "LoggingRole": "string", "PostAuthenticationLoginBanner": "string", "PreAuthenticationLoginBanner": "string", "ProtocolDetails": { "As2Transports": [ "string" ], "PassiveIp": "string", "SetStatOption": "string", "TlsSessionResumptionMode": "string" }, "Protocols": [ "string" ], "SecurityPolicyName": "string", "ServerId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UserCount": number, "WorkflowDetails": { "OnPartialUpload": [ { "ExecutionRole": "string", "WorkflowId": "string" } ], "OnUpload": [ { "ExecutionRole": "string", "WorkflowId": "string" } ] } } }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

Server

包含ServerID您指定的服务器属性的数组。

类型:DescribedServer 对象

错误

有关所有操作常见错误的信息,请参阅常见错误

InternalServiceError

当 Transfer Family 服务中发生错误时,会Amazon引发此异常。

HTTP 状态代码:500

InvalidRequestException

当客户端提交格式错误的请求时,会引发此异常。

HTTP 状态代码:400

ResourceNotFoundException

当 Transfer Family 服务找不到资源时,会Amazon引发此异常。

HTTP 状态代码:400

ServiceUnavailableException

由于 Transfer FamAmazon ily 服务不可用,请求失败。

HTTP 状态代码:500

示例

示例

以下示例返回的属性.

示例请求

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

示例

此示例说明了的一种用法 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 } }

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: