Skip to content
OtterScale

CreateSMBShare

POST
/otterscale.storage.v1.StorageService/CreateSMBShare

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Connect-Protocol-Version
required
Connect-Protocol-Version

Define the version of the Connect protocol

number
Allowed values: 1
Connect-Timeout-Ms
Connect-Timeout-Ms

Define the timeout, in ms

number

Request Body required

Section titled “Request Body required ”
CreateSMBShareRequest
object
scope
scope
string
name
name
string
sizeBytes
size_bytes
integer | string format: int64
port
port
integer format: int32
browsable
browsable
boolean
readOnly
read_only
boolean
guestOk
guest_ok
boolean
validUsers
valid_users
Array<string>
commonConfig
common_config
object
mapToGuest
map_to_guest
string
Allowed values: MAP_TO_GUEST_NEVER MAP_TO_GUEST_BAD_USER MAP_TO_GUEST_BAD_PASSWORD
securityConfig
security_config
object
mode
mode
string
Allowed values: MODE_USER MODE_ACTIVE_DIRECTORY
localUsers
local_users
Array<object>
User
object
username
username
string
password
password
string
realm
realm
string
joinSource
User
object
username
username
string
password
password
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

SMBShare
object
name
name
string
uri
uri
string
replicas
replicas
integer format: int32
healthies
healthies
integer format: int32
sizeBytes
size_bytes
integer | string format: int64
browsable
browsable
boolean
readOnly
read_only
boolean
guestOk
guest_ok
boolean
validUsers
valid_users
Array<string>
commonConfig
common_config
object
mapToGuest
map_to_guest
string
Allowed values: MAP_TO_GUEST_NEVER MAP_TO_GUEST_BAD_USER MAP_TO_GUEST_BAD_PASSWORD
securityConfig
security_config
object
mode
mode
string
Allowed values: MODE_USER MODE_ACTIVE_DIRECTORY
localUsers
local_users
Array<object>
User
object
username
username
string
password
password
string
realm
realm
string
joinSource
User
object
username
username
string
password
password
string

default

Section titled “default ”

Error

Connect Error
object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string
Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

object
type

A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.

string
value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary
debug
One of: discriminator: type
Any

Detailed error information.

object
key
additional properties
any
key
additional properties
any
key
additional properties
any