CreateGatewaySMBUser - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Operation description

Note the following before you call this operation:

This operation fails if your Cloud Storage Gateway is connected to an Active Directory (AD) server. In this case, create the SMB user on the AD 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 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:CreateGatewaySMBUser

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000eg44nmxbsfwbvq2**
Username	string	Yes	The username of the SMB user. The username must be 1 to 32 characters in length and can contain letters, digits, hyphens (-), and underscores (_).	alex
Password	string	Yes	The password of the SMB user. The password cannot be empty. The password can contain letters, digits, and the following special characters: !, @, #, $, %, ^, &, and *.	123***

Response parameters

Parameter	Type	Description	Example
	object
TaskId	string	The ID of the task.	t-000c6hshwukkbtxrb***
Message	string	The description of the request result.	successful
RequestId	string	The ID of the request.	9083F167-95B1-4B40-B2CD-70DE068EC3**
Code	string	The status code. A status code of 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the request is successful.	true

Examples

Success response

JSON format

{
  "TaskId": "t-000c6hshwukkbtxrb***",
  "Message": "successful",
  "RequestId": "9083F167-95B1-4B40-B2CD-70DE068EC3**",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidSMBUserName	You must enter a valid SMB username.	You must enter a valid SMB username.
400	EmptySMBPassword	You must enter a valid SMB password.	You must enter a valid SMB password.
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	GatewayInOperation	The gateway is processing requests . Try again later.	The gateway is busy. Try again later.
400	EmptySMBUserName	You must enter a valid SMB username.	You must enter a valid SMB username.
400	InvalidSMBPassword	The specified SMB password is invalid. You must enter a valid password.	The specified SMB password is invalid. You must enter a valid password.
400	CouldNotCreateSMBUser	The gateway has linked an AD or LDAP service. You cannot create an SMB user on the gateway. We recommend that you create an SMB user in the AD or LDAP service.	The gateway has been configured with an AD service and does not support creating an SMB user from the gateway. Please perform user operations on the AD server.
500	InternalError	Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.	Unexpected error. Try again later. If the error persists after several tries, we recommend that you submit a ticket.
404	StorageBundleNotExist	The name you specified for the gateway cluster does not exist. You must specify a valid parameter.	The name you specified for the gateway cluster does not exist. You must specify a valid parameter.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.