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

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

ListUsers

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

请求语法

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

请求参数

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

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

MaxResults

指定作为ListUsers请求响应而返回的用户数量。

类型:整数

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

必需:否

NextToken

当您可以从ListUsers调用中获得更多结果时,输出中会返回一个NextToken参数。然后,您可以将后续命令传递给该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调用中获得更多结果时,输出中会返回一个NextToken参数。然后,您可以将后续命令传递给该NextToken参数,以继续列出其他用户。

类型:字符串

长度限制:最小长度为 1。长度上限为 6144。

ServerId

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

类型:字符串

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

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

Users

返回您指定ServerId值的用户帐户及其属性。

类型:ListedUser 对象数组

错误

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

InternalServiceError

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

HTTP 状态代码:500

InvalidNextTokenException

传递的NextToken参数无效。

HTTP 状态代码:400

InvalidRequestException

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

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

ServiceUnavailableException

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

HTTP 状态代码:500

示例

示例

ListUsersAPI 调用返回与您指定的服务器关联的用户列表。

示例请求

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

示例

这是此 API 调用的示例响应。

示例响应

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

另请参阅

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