通过DescribeGatewayNFSClients API查询文件网关的NFS挂载客户端列表-云存储网关-阿里云

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGatewayNFSClients

none

*全部资源

*

无

请求参数

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

返回参数

名称	类型	描述	示例值
	object
Version40Enabled	boolean	判断网关是否支持 NFS v4.0 挂载，返回值如下： true：支持 NFS v4.0 挂载。 false：不支持 NFS v4.0 挂载。	true
Version41Enabled	boolean	判断网关是否支持 NFS v4.1 挂载，返回值如下： true：支持 NFS v4.1 挂载。 false：不支持 NFS v4.1 挂载。	false
TotalCount	integer	客户端总数。	1
RequestId	string	请求 ID。	F694EBF3-59AB-1DDD-B5B4-87CB7D6A****
Message	string	请求结果描述。	successful
PageSize	integer	网关列表每页的行数。	10
PageNumber	integer	网关列表信息的页码。	1
Version3Enabled	boolean	判断网关是否支持 NFS v3 挂载，返回值如下： true：支持 NFS v3 挂载。 false：不支持 NFS v3 挂载。	true
ClientInfoList	object
ClientInfo	array<object>	客户端信息。
	object
HasNFSv40	boolean	判断客户端是否使用 NFS v4.0 挂载，返回值如下： true：客户端使用的是 NFS v4.0 挂载。 false：客户端使用的不是 NFS v4.0 挂载。	true
HasNFSv41	boolean	判断客户端是否使用 NFS v4.1 挂载，返回值如下： true：客户端使用的是 NFS v4.1 挂载。 false：客户端使用的不是 NFS v4.1 挂载。	false
HasNFSv3	boolean	判断客户端是否使用 NFS v3 挂载，返回值如下： true：客户端使用的是 NFS v3 挂载。 false：客户端使用的不是 NFS v3 挂载。	true
ClientIpAddr	string	NFS 客户端 IP 地址。	172.16.XX.XX
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	请求结果，返回值如下： true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "Version40Enabled": true,
  "Version41Enabled": false,
  "TotalCount": 1,
  "RequestId": "F694EBF3-59AB-1DDD-B5B4-87CB7D6A****",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Version3Enabled": true,
  "ClientInfoList": {
    "ClientInfo": [
      {
        "HasNFSv40": true,
        "HasNFSv41": false,
        "HasNFSv3": true,
        "ClientIpAddr": "172.16.XX.XX"
      }
    ]
  },
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	BadPageSize	The specified number of pages is invalid. The number ranges from 1 to 50.	无效的页数，取值范围：1~50。
400	BadRequest	Invalid request. You must specify valid parameters in the request.	非法请求，请检查请求参数。
400	BadPageNumber	The specified page number is invalid. The page number must be greater than 0.	无效的页码，不能小于0。

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

变更历史

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