本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeUser
描述分配给启用了文件传输协议的特定服务器的用户,由其 ServerId
属性标识。
此调用的响应返回与指定 ServerId
值关联的用户的属性。
请求语法
{
"ServerId": "string
",
"UserName": "string
"
}
请求参数
有关所有操作的通用参数的信息,请参阅通用参数。
该请求接受以下JSON格式的数据。
响应语法
{
"ServerId": "string",
"User": {
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryMappings": [
{
"Entry": "string",
"Target": "string",
"Type": "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
值的 Transfer Family 用户属性的数组。类型:DescribedUser 对象
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- InternalServiceError
-
当 AWS Transfer Family 服务中发生错误时,会引发此异常。
HTTP状态码:500
- InvalidRequestException
-
当客户端提交格式错误的请求时,会引发此异常。
HTTP状态码:400
- ResourceNotFoundException
-
当 Transfer Family 服务找不到资源时,就会 AWS引发此异常。
HTTP状态码:400
- ServiceUnavailableException
-
请求失败,因为 Trans AWS fer Family 服务不可用。
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"
}
}
另请参阅
有关在特定语言API中使用它的更多信息 AWS SDKs,请参阅以下内容: