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

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

DescribeUser

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

此调用的响应返回与指定ServerId值关联的用户的属性。

请求语法

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

请求参数

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

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

ServerId

服务器的系统分配的唯一标识符,由服务器分配给此用户。

类型:字符串

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

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

必需:是

UserName

分配给一台或多台服务器的用户名。用户名是使用Amazon Transfer 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 对象

错误

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

InternalServiceError

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

HTTP 状态代码:500

InvalidRequestException

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

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

ServiceUnavailableException

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

HTTP 状态代码:500

示例

示例

以下示例显示现有用户的详细信息。

示例请求

aws transfer describe-user --server-id s-1111aaaa2222bbbb3 --user-name bob-test

示例响应

{ "ServerId": "s-1111aaaa2222bbbb3", "User": { "Arn": "arn:aws:transfer:us-east-1:111122223333:user/s-1111aaaa2222bbbb3/bob-test", "HomeDirectory": "/DOC-EXAMPLE-BUCKET", "HomeDirectoryType": "PATH", "Role": "arn:aws:iam::111122223333:role/bob-role", "SshPublicKeys": [ { "DateImported": "2022-03-31T12:27:52.614000-04:00", "SshPublicKeyBody": "ssh-rsa AAAAB3NzaC1yc..... bobusa@mycomputer.us-east-1.amaazon.com", "SshPublicKeyId": "key-abcde12345fghik67" } ], "Tags": [], "UserName": "bob-test" } }

另请参阅

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