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

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

DescribeUser

描述分配给启用文件传输协议的特定服务器的用户,该用户由ServerId属性。

此调用的响应将返回与ServerId指定的值。

请求语法

{ "ServerId": "string", "UserName": "string" }

请求参数

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

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

ServerId

系统为已分配此用户的服务器分配的唯一标识符。

类型: 字符串

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

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

:必需 是

UserName

分配给一台或多个服务器的用户的名称。用户名是登录凭据的一部分,用于使用AmazonTransfer Family 服务并执行文件传输任务。

类型: 字符串

长度约束:最小长度为 3。长度上限为 100。

模式:^[\w][\w@.-]{2,99}$

:必需 是

响应语法

{ "ServerId": "string", "User": { "Arn": "string", "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Role": "string", "SshPublicKeys": [ { "DateImported": number, "SshPublicKeyBody": "string", "SshPublicKeyId": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ], "UserName": "string" } }

响应元素

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

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

ServerId

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

类型: 字符串

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

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

User

包含用户帐户属性的数组ServerID值。

类型:DescribedUser 对象

Errors

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

InternalServiceError

在AmazonTTransfer Family

HTTP 状态代码:500

InvalidRequestException

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

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

ServiceUnavailableException

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

HTTP 状态代码:500

Examples

Example

以下示例返回分配给服务器的属性。

示例请求

{ "ServerId": "s-01234567890abcdef", "UserName": "my_user" }

Example

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

示例响应

{ "User": { "Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef", "HomeDirectory": "/home/mydirectory", "HomeDirectoryType:" "PATH", "Role": "arn:aws:iam::176354371281:role/my_role", "SshPublicKeys": "AAAAB3NzaC1yc2EAAAADAQABAAABAQCOtfCAis3aHfM6yc8KWAlMQxVDBHyccCde9MdLf4DQNXn8HjAHf+Bc1vGGCAREFUL1NO2PEEKING3ALLOWEDfIf+JBecywfO35Cm6IKIV0JF2YOPXvOuQRs80hQaBUvQL9xw6VEb4xzbit2QB6", "Tags": [ { "Key": "Name", "Value": "MyServer" } "UserName": "my_user", ] } }

另请参阅

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