调用DescribeGatewaySMBUsers接口获取文件网关的SMB用户名列表-云存储网关-阿里云

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

接口说明

调用该接口时，您需要注意：

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGatewaySMBUsers

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-000eg44nmxbsfwbv***
PageNumber	integer	否	分页查询时设置的页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：50。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	返回 SMB 用户名的总个数。	1
RequestId	string	请求 ID。	4C02F482-FC2E-45BF-88C5-8D40134D11**
Message	string	请求结果描述。	successful
PageSize	integer	分页显示时每页行数。	10
PageNumber	integer	页码。	1
Users	object
User	array<object>	SMB 用户名列表。
	object
Username	string	SMB 用户名。	alex***
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	请求是否成功。	true
ActiveDirectory	boolean	网关是否加入 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	错误码	错误信息	描述
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不能为空。

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

变更历史

更多信息，参考变更详情。