add

Request URL

{{adminHost:8181}}/workspace/add

Request Method

post

Header

Field Name
Sample
Required
Type
Note


adminKey
603284317954637824
Yes
string
This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management

timestamp
8641706679604867
Yes
string
The timestamp when sending a request, in milliseconds

signature
9A02B47AE67664D80A2ED13FC2B1691512613790
Yes
string
This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature]

Request Body Parameters

Field Name
Sample
Required
Type
Note


name
测试2
Yes
string
Workplace Name

instanceMax
 
No
string
Maximum concurrency, default to 0, indicating no limit on concurrency

createSecret
1
No
string
Do you want to create a secret key? The default is 0. 0: Do not create it automatically, 1: Create it automatically

useShareRegion
 
No
string
Can shared partitions be used in the current workspace: 1: Yes, 0: No

Success Response Example

{
  "code": 1000,
  "message": "success",
  "result": {
    "wsId": "******",
    "secretKey": "****************************************",
    "name": "测试2",
    "instanceMax": 0,
    "interCtrWm": "false",
    "useShareRegion": 1,
    "createDate": "1707098588409",
    "updateDate": "1707098588409",
    "deleteFlag": 0
  }
}

Parameter Note for Success Response Example

Field Name
Type
Note


code
string
None

message
string
None

result
object
None

wsId
string
Workspace Id

secretKey
string
Secret key

name
string
Workplace Name

instanceMax
string
Maximum concurrency, default to 0, indicating no limit on concurrency

interCtrWm
string
Internal variables, please ignore

useShareRegion
string
Can shared partitions be used in the current workspace: 1: Yes, 0: No

createDate
string
None

updateDate
string
None

deleteFlag
string
Delete identification, 0 not deleted, 1 deleted

Field Name	Sample	Required	Type	Note
adminKey	603284317954637824	Yes	string	This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management
timestamp	8641706679604867	Yes	string	The timestamp when sending a request, in milliseconds
signature	9A02B47AE67664D80A2ED13FC2B1691512613790	Yes	string	This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature]

Field Name	Sample	Required	Type	Note
name	测试2	Yes	string	Workplace Name
instanceMax		No	string	Maximum concurrency, default to 0, indicating no limit on concurrency
createSecret	1	No	string	Do you want to create a secret key? The default is 0. 0: Do not create it automatically, 1: Create it automatically
useShareRegion		No	string	Can shared partitions be used in the current workspace: 1: Yes, 0: No

Field Name	Type	Note
code	string	None
message	string	None
result	object	None
wsId	string	Workspace Id
secretKey	string	Secret key
name	string	Workplace Name
instanceMax	string	Maximum concurrency, default to 0, indicating no limit on concurrency
interCtrWm	string	Internal variables, please ignore
useShareRegion	string	Can shared partitions be used in the current workspace: 1: Yes, 0: No
createDate	string	None
updateDate	string	None
deleteFlag	string	Delete identification, 0 not deleted, 1 deleted