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

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

ListUsers

列出启用文件传输协议的服务器的用户,该服务器通过传递ServerId参数。

请求语法

{ "MaxResults": number, "NextToken": "string", "ServerId": "string" }

请求参数

有关所有操作通用的参数的信息,请参阅常见参数.

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

MaxResults

指定要返回的用户数,以响应ListUsers请求.

类型: 整数

有效范围:最小值为 1。最大值为 1 000。

:必需 否

NextToken

当您可以从ListUsers调用,aNextToken参数在输出中返回。然后,您可以将后续命令传递给NextToken参数继续列出其他用户。

类型: 字符串

长度约束:最小长度为 1。长度上限为 6144。

:必需 否

ServerId

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

类型: 字符串

长度约束:固定长度为 19。

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

:必需 是

响应语法

{ "NextToken": "string", "ServerId": "string", "Users": [ { "Arn": "string", "HomeDirectory": "string", "HomeDirectoryType": "string", "Role": "string", "SshPublicKeyCount": number, "UserName": "string" } ] }

响应元素

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

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

NextToken

当您可以从ListUsers调用,aNextToken参数在输出中返回。然后,您可以将后续命令传递给NextToken参数继续列出其他用户。

类型: 字符串

长度约束:最小长度为 1。长度上限为 6144。

ServerId

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

类型: 字符串

长度约束:固定长度为 19。

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

用户

返回用户帐户及其属性ServerId值。

类型: 数组ListedUserobjects

Errors

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

InternalServiceError

在出现错误时,会引发此异常。AmazonTTransfer Family

HTTP 状态代码:500

InvalidNextTokenException

这些区域有:NextToken参数是无效的。

HTTP 状态代码:400

InvalidRequestException

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

HTTP 状态代码:400

ResourceNotFoundException

在资源找不到时,会引发此异常。AmazonTTransfer Family

HTTP 状态代码:400

ServiceUnavailableException

请求失败,因为Amazon酒店不提供 Transfer Family 服务。

HTTP 状态代码:500

Examples

Example

这些区域有:ListUsersAPI 调用返回与您指定的服务器相关联的用户列表。

示例请求

{ "MaxResults": 100, "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==", "ServerId": "s-01234567890abcdef" }

Example

此示例说明了 ListUsers 的一种用法。

示例响应

{ "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==", "ServerId": "s-01234567890abcdef", "Users": [ { "Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/charlie", "HomeDirectory": "/tests/home/charlie", "SshPublicKeyCount": 1, "Role": "arn:aws:iam::176354371281:role/transfer-role1", "Tags": [ { "Key": "Name", "Value": "user1" } ], "UserName": "my_user" } ] }

另请参阅

有关在特定语言的特定语言的服务器中使用此 API 的更多信息。Amazon开发工具包,请参阅以下: