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

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

ListedServer

返回已指定的启用文件传输协议的服务器的属性。

目录

Arn

为要列出的服务器指定唯一 Amazon 资源名称(ARN)。

类型:字符串

长度限制:最小长度为 20。长度上限为 1600。

模式:arn:.*

必需:是

Domain

指定用于文件传输的存储系统的域。

类型:字符串

有效值: S3 | EFS

必需:否

EndpointType

指定服务器连接到的 VPC 终端节点的类型。如果服务器连接到VPC 端点,则无法通过公有互联网访问服务器。

类型:字符串

有效值: PUBLIC | VPC | VPC_ENDPOINT

必需:否

IdentityProviderType

服务器的身份验证模式。默认值为 SERVICE_MANAGED,这允许您在 Amazon Transfer Family 服务中存储和访问用户凭证。

使用 AWS_DIRECTORY_SERVICE 可以访问 Active Directory 组,这些组位于本地环境中或使用 AD Connector 的 Amazon 的 Amazon Directory Service for Microsoft Active Directory 或 Microsoft Active Directory 中。此选项还要求您使用 IdentityProviderDetails 参数提供 Directory ID。

使用 API_GATEWAY 值以与您选择的身份提供者集成。API_GATEWAY 设置要求您提供 Amazon API Gateway 端点 URL 以使用 IdentityProviderDetails 参数调用身份验证。

使用 AWS_LAMBDA 值直接将 Amazon Lambda 函数用作身份提供者。如果选择该值,则必须在 Function 参数或 IdentityProviderDetails 数据类型中指定 Lambda 函数的 ARN。

类型:字符串

有效值: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

必需:否

LoggingRole

允许服务器为 Amazon S3 或 Amazon EFS 事件开启 Amazon CloudWatch 日志记录功能的Amazon Identity and Access Management(IAM)角色的 Amazon 资源名称(ARN)。设置后,您可以在 CloudWatch 日志中查看用户活动。

类型:字符串

长度限制:最小长度为 20。最大长度为 2048。

模式:arn:.*role/.*

必需:否

ServerId

为列出的服务器指定系统分配的唯一标识符。

类型:字符串

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

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

必需:否

State

所描述的服务器状况。值为ONLINE表示服务器可以接受任务和传输文件。State值为OFFLINE表示服务器无法执行文件传输操作。

STARTING和的状态STOPPING表示服务器处于中间状态,要么无法完全响应,要么未完全脱机。START_FAILED或的值STOP_FAILED可能表示错误情况。

类型:字符串

有效值: OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

必需:否

UserCount

指定分配给您使用指定的服务器的用户数量ServerId

类型:整数

必需:否

另请参阅

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