DescribeGatewaySMBClients - 查询SMB挂载客户端列表-云存储网关(CSG)-阿里云帮助中心

查询文件网关中SMB挂载客户端列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGatewaySMBClients

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-000eg44nmxbsfwbvq***
PageNumber	integer	否	查询页码。	1
PageSize	integer	否	分页显示时每页行数。	10

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	89398CFB-4EB6-4C7E-BB3C-EF213A***
Success	boolean	请求是否成功。可能值如下： true：成功。 false：失败。	true
Code	string	状态码。状态码为 200 表示请求成功。	200
Message	string	请求结果描述。	successful
PageSize	integer	分页显示时每页行数。	10
PageNumber	integer	查询页码。	1
TotalCount	integer	SMB 客户端总数。	2
ClientInfoList	object
ClientInfo	array<object>	SMB 客户端信息。
	object	SMB 客户端信息。
Signing	string	签名。	required
ProtocolVersion	string	协议版本。	2.1
Group	string	用户组。	guest
Username	string	用户名。	guest
ClientIpAddr	string	SMB 客户端 IP 地址。	192.168.xx.xx

示例

正常返回示例

JSON格式

{
  "RequestId": "89398CFB-4EB6-4C7E-BB3C-EF213A***",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 2,
  "ClientInfoList": {
    "ClientInfo": [
      {
        "Signing": "required",
        "ProtocolVersion": "2.1",
        "Group": "guest",
        "Username": "guest",
        "ClientIpAddr": "192.168.xx.xx"
      }
    ]
  }
}

错误码

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

变更历史

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