Query NFS Clients for a File Gateway via DescribeGatewayNFSClients - Cloud Storage Gateway

Queries the NFS clients for a file gateway.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hcs-sgw:DescribeGatewayNFSClients

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000gchoknplv4f27****
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries to return on each page.	10

Response parameters

Parameter	Type	Description	Example
	object
Version40Enabled	boolean	Indicates whether the gateway supports NFS v4.0 mounts. Valid values: true: The gateway supports NFS v4.0 mounts. false: The gateway does not support NFS v4.0 mounts.	true
Version41Enabled	boolean	Indicates whether the gateway supports NFS v4.1 mounts. Valid values: true: The gateway supports NFS v4.1 mounts. false: The gateway does not support NFS v4.1 mounts.	false
TotalCount	integer	The total number of clients.	1
RequestId	string	The ID of the request.	F694EBF3-59AB-1DDD-B5B4-87CB7D6A****
Message	string	The returned message.	successful
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	1
Version3Enabled	boolean	Indicates whether the gateway supports NFS v3 mounts. Valid values: true: The gateway supports NFS v3 mounts. false: The gateway does not support NFS v3 mounts.	true
ClientInfoList	object
ClientInfo	array<object>	The client information.
	object
HasNFSv40	boolean	Indicates whether the client uses an NFS v4.0 mount. Valid values: true: The client uses an NFS v4.0 mount. false: The client does not use an NFS v4.0 mount.	true
HasNFSv41	boolean	Indicates whether the client uses an NFS v4.1 mount. Valid values: true: The client uses an NFS v4.1 mount. false: The client does not use an NFS v4.1 mount.	false
HasNFSv3	boolean	Indicates whether the client uses an NFS v3 mount. Valid values: true: The client uses an NFS v3 mount. false: The client does not use an NFS v3 mount.	true
ClientIpAddr	string	The IP address of the NFS client.	172.16.XX.XX
Code	string	The status code. The status code 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	BadPageSize	The specified number of pages is invalid. The number ranges from 1 to 50.	The specified number of pages is invalid. The number ranges from 1 to 50.
400	BadRequest	Invalid request. You must specify valid parameters in the request.	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.	The specified page number is invalid. The page number must be greater than 0.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.