本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
DescribeServer
描述通过传递 ServerId 参数指定的启用文件传输协议的服务器。
响应包含服务器属性的描述。设置EndpointType为时VPC，响应将包含EndpointDetails。
请求语法
{
"ServerId": "string"
}请求参数
有关所有操作的通用参数的信息，请参阅通用参数。
该请求接受以下JSON格式的数据。
- ServerId
-
系统为服务器分配的唯一标识符。
类型：字符串
长度限制：固定长度为 19。
模式：
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"
}
]
}
}
}响应元素
如果操作成功，服务将发回 HTTP 200 响应。
以下数据由服务以JSON格式返回。
- Server
-
一个数组，包含您指定的
ServerID服务器的属性。类型：DescribedServer 对象
错误
有关所有操作的常见错误的信息，请参阅常见错误。
- InternalServiceError
-
当 AWS Transfer Family 服务中发生错误时，会引发此异常。
HTTP状态码：500
- InvalidRequestException
-
当客户端提交格式错误的请求时，会引发此异常。
HTTP状态码：400
- ResourceNotFoundException
-
当 Transfer Family 服务找不到资源时，就会 AWS引发此异常。
HTTP状态码：400
- ServiceUnavailableException
-
请求失败，因为 Trans AWS fer Family 服务不可用。
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
}
}另请参阅
有关API在一种特定语言中使用此功能的更多信息 AWS SDKs，请参阅以下内容：
