SMB User Management on File Gateways Overview - Cloud Storage Gateway

Queries the list of SMB usernames on a file gateway.

Operation description

When you call this operation, note the following:

If you have added an Active Directory (AD) server to your Cloud Storage Gateway, this operation returns the list of SMB users on the server.

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:DescribeGatewaySMBUsers

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000eg44nmxbsfwbv***
PageNumber	integer	No	The page number to return for a paged query. Start value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. Maximum value: 50. Default value: 10.	10

Response elements

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of SMB usernames.	1
RequestId	string	The request ID.	4C02F482-FC2E-45BF-88C5-8D40134D11**
Message	string	The description of the request result.	successful
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number.	1
Users	object
User	array<object>	The list of SMB usernames.
	object
Username	string	The SMB username.	alex***
Code	string	The status code. A status code of 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful.	true
ActiveDirectory	boolean	Indicates whether the gateway is added to a Windows Active Directory (AD) domain. false (default): The gateway is not added. true: The gateway is added.	false

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "4C02F482-FC2E-45BF-88C5-8D40134D11**",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Users": {
    "User": [
      {
        "Username": "alex***"
      }
    ]
  },
  "Code": "200",
  "Success": true,
  "ActiveDirectory": false
}

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	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.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. You must specify a valid parameter.
400	EmptyGatewayId	You must enter a valid ID for the gateway.	You must enter a valid ID for the gateway.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.