Appendix
Updated at：2025-11-12
Type information
Status of Baidu Storage Gateway
| Name | Types | Description |
|---|---|---|
| CREATING | String | Creating |
| CREATE_FAILED | String | Creation failed |
| RUNNING | String | Normal running (creation succeeded) |
| DELETED | String | Deleted |
| EXPIRED | String | Expired (payment required) |
Shared target status
| Name | Types | Description |
|---|---|---|
| CREATING | String | Creating |
| CREATE_FAILED | String | Creation failed |
| CONFIGURING | String | Configuring (launching storage service) |
| RUNNING | String | Normal running (creation succeeded) |
| DELETED | String | Deleted |
Permission status
| Name | Types | Description |
|---|---|---|
| CREATING | String | Creating |
| CREATE_FAILED | String | Creation failed |
| CONFIGURING | String | Configuring |
| RUNNING | String | Normal running (active) |
| DELETED | String | Deleted |
Data type
TargetInfo
Plain Text
1"TargetInfo": {
2 "targetId": targetId,
3 "bucketName": bucketName,
4 "protocolType": protocolType,
5 "groupId": groupId,
6 }| Name | Types | Description |
|---|---|---|
| targetId | String | Shared target ID |
| name | String | Shared target name |
| protocolType | String | Protocol type: NFS SMB |
| bucket | String | BOS bucket associated with the shared target |
authGroupInfo
Plain Text
1"groupInfo": {
2 "authGroupId": authGroupId,
3 "name": name,
4 "protocolType": protocolType,
5
6 "accounts": [
7 accountId,
8 ]
9 }| Name | Types | Description |
|---|---|---|
| authGroupId | String | Permission group ID |
| name | String | Permission group name |
| protocolType | String | Protocol name: NFS SMB |
| authList | Detailed permission information list |
authInfo
Plain Text
1"authInfo": {
2 "authId": authId,
3 "protocolType": protocolType,
4 "nfsFileShareConfig": {
5 "ip": ip,
6 "mode": mode,
7 "squash": squash,
8 "sync": sync,
9 },
10
11 "smbFileShareConfig": {
12 "userName": userName,
13 "password": password,
14 }
15 }| Parameter name | Types | Description |
|---|---|---|
| authId | String | Permission ID |
| protocolType | String | Baidu Storage Gateway Protocol |
| nfsFileShareConfig | nfsFileShareConfig | NFS protocol configuration |
| smbFileShareConfig | smbFileShareConfig | SMB protocol configuration |
nfsFileShareConfig
Plain Text
1"nfsFileShareConfig": {
2 “ip“: ip,
3 "mode": mode,
4 "squash": squash,
5 "sync":sync,
6},| Parameter name | Types | Description |
|---|---|---|
| ip | String | IP information for accessing NFS, supporting single IP and IP segments |
| mode | String | Access permission, ro: read-only & rw: read-write |
| squash | String | Specify root permission. no_root_squash: unrestricted; root_squash: restrict root user; all_squash: restrict all users |
| sync | String | Specify persistent data write method: sync: synchronous & async: asynchronous |
smbFileShareConfig
Plain Text
1 "smbFileShareConfig": {
2 "userName": userName,
3 "password": password,
4 }| Parameter name | Types | Description |
|---|---|---|
| userName | String | Users accessing SMB |
| password | String | Password for users accessing SMB |