调用DescribeGatewaySMBUsers可以获取网关上SMB用户名列表。
调用该接口时,您需要注意:如果云存储网关上已经添加了AD服务器或者LDAP服务器,该接口会返回对应服务器上的SMB用户列表。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeGatewaySMBUsers | 系统规定参数。取值:DescribeGatewaySMBUsers。 |
GatewayId | String | 是 | gw-000eg44nmxbsfwbv*** | 网关ID。 |
PageNumber | Integer | 否 | 1 | 分页查询时设置的页码。
|
PageSize | Integer | 否 | 10 | 分页查询时设置的每页行数。
|
返回数据
名称 |
类型 |
示例值 |
描述 |
TotalCount | Integer | 1 | 返回SMB用户名的总个数。 |
RequestId | String | 4C02F482-FC2E-45BF-88C5-8D40134D11** | 请求ID。 |
Message | String | successful | 请求结果描述。 |
PageSize | Integer | 10 | 分页显示时每页行数。 |
PageNumber | Integer | 1 | 页码。 |
Users | Array of User | SMB用户名列表。 |
|
User | |||
Username | String | alex*** | SMB用户名。 |
Code | String | 200 | 状态码。状态码为200表示请求成功。 |
Success | Boolean | true | 请求是否成功。 |
ActiveDirectory | Boolean | false | 网关是否加入Windows活动目录(AD)。
|
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeGatewaySMBUsers
&GatewayId=gw-000eg44nmxbsfwbv***
&PageNumber=1
&PageSize=10
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeGatewaySMBUsersResponse>
<TotalCount>1</TotalCount>
<RequestId>4C02F482-FC2E-45BF-88C5-8D40134D11**</RequestId>
<Message>successful</Message>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Users>
<Username>alex***</Username>
</Users>
<Code>200</Code>
<Success>true</Success>
<ActiveDirectory>false</ActiveDirectory>
</DescribeGatewaySMBUsersResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1,
"RequestId" : "4C02F482-FC2E-45BF-88C5-8D40134D11**",
"Message" : "successful",
"PageSize" : 10,
"PageNumber" : 1,
"Users" : [ {
"Username" : "alex***"
} ],
"Code" : "200",
"Success" : true,
"ActiveDirectory" : false
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | BadPageSize | The specified number of pages is invalid. The number ranges from 1 to 50. | 无效的页数,取值范围:1~50。 |
400 | BadPageNumber | The specified page number is invalid. The page number must be greater than 0. | 无效的页码,不能小于0。 |
400 | GatewayNotExist | The specified gateway does not exist. You must specify a valid parameter. | 网关不存在,请确认输入参数是否正确。 |
400 | EmptyGatewayId | You must enter a valid ID for the gateway. | 网关ID不能为空。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?