DescribeGatewaySMBClients API Reference - Cloud Storage Gateway - Alibaba Cloud - Cloud Storage Gateway

Queries the Server Message Block (SMB) clients of 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 supports 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:DescribeGatewaySMBClients

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000eg44nmxbsfwbvq***
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	89398CFB-4EB6-4C7E-BB3C-EF213A***
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	string	The status code. A status code of 200 indicates that the request was successful.	200
Message	string	The message that is returned.	successful
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of SMB clients.	2
ClientInfoList	object
ClientInfo	array<object>	A list of SMB clients.
	object	The information about an SMB client.
Signing	string	The SMB signing status.	required
ProtocolVersion	string	The protocol version.	2.1
Group	string	The user group.	guest
Username	string	The username.	guest
ClientIpAddr	string	The IP address of the SMB client.	192.168.xx.xx

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.