DescribeGatewaySMBUsers - 获取SMB用户名列表

获取文件网关上SMB用户名列表。

接口说明

调用该接口时,您需要注意:

如果云存储网关上已经添加了 AD 服务器,该接口会返回对应服务器上的 SMB 用户列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hcs-sgw:DescribeGatewaySMBUsersget
*全部资源
*

请求参数

名称类型必填描述示例值
GatewayIdstring

网关 ID。

gw-000eg44nmxbsfwbv***
PageNumberinteger

分页查询时设置的页码。

  • 起始值:1。

  • 默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数。

  • 最大值:50。

  • 默认值:10。

10

返回参数

名称类型描述示例值
object
TotalCountinteger

返回 SMB 用户名的总个数。

1
RequestIdstring

请求 ID。

4C02F482-FC2E-45BF-88C5-8D40134D11**
Messagestring

请求结果描述。

successful
PageSizeinteger

分页显示时每页行数。

10
PageNumberinteger

页码。

1
Usersarray<object>

SMB 用户名列表。

Userobject
Usernamestring

SMB 用户名。

alex***
Codestring

状态码。状态码为 200 表示请求成功。

200
Successboolean

请求是否成功。

true
ActiveDirectoryboolean

网关是否加入 Windows 活动目录(AD)。

  • false(默认):未加入。

  • true:加入。

false

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "4C02F482-FC2E-45BF-88C5-8D40134D11**",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Users": {
    "User": [
      {
        "Username": "alex***"
      }
    ]
  },
  "Code": "200",
  "Success": true,
  "ActiveDirectory": false
}

错误码

HTTP status code错误码错误信息描述
400BadPageSizeThe specified number of pages is invalid. The number ranges from 1 to 50.无效的页数,取值范围:1~50。
400BadPageNumberThe specified page number is invalid. The page number must be greater than 0.无效的页码,不能小于0。
400GatewayNotExistThe specified gateway does not exist. You must specify a valid parameter.网关不存在,请确认输入参数是否正确。
400EmptyGatewayIdYou must enter a valid ID for the gateway.网关ID不能为空。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史