search


Request URL
  • {{adminHost:8181}}/workspace/search
Request Method
  • get
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 Query Parameters
Field Name Sample Required Type Note
wsId   No string Workspace Id
name   No string Workplace Name
page   No string Page number, default to 1
pageSize 1 No string How many pieces of data are there on each page, default to 20
Success Response Example
{
  "code": 1000,
  "message": "Success",
  "result": {
    "records": [
      {
        "wsId": "Jx3wQMD1",
        "name": "Default",
        "instanceMax": 0,
        "stLgCstz": 1,
        "vrHdrLgCstz": 1,
        "ctrBrLgCstz": 1,
        "interCtrWm": "false",
        "sdkIdEncryptKey": "1200486733431439",
        "useShareRegion": 1,
        "createDate": "1531118401000",
        "updateUser": "443167382534356992",
        "updateDate": "1706260612094",
        "deleteFlag": 0
      }
    ],
    "total": "5",
    "size": "1",
    "current": "1",
    "orders": [],
    "optimizeCountSql": true,
    "searchCount": true,
    "pages": "5"
  }
}
Parameter Note for Success Response Example
Field Name Type Note
code string None
message string None
result object None
records array None
records.wsId string Workspace Id
records.name string Workplace Name
records.instanceMax string The maximum concurrency of this workspace
records.stLgCstz string Internal variables, please ignore
records.vrHdrLgCstz string Internal variables, please ignore
records.ctrBrLgCstz string Internal variables, please ignore
records.interCtrWm string Internal variables, please ignore
records.sdkIdEncryptKey string SDK encryption key. When encryption is enabled and sdkId is used, the encrypted string needs to be passed. Please refer to the notes for the encryption method
records.useShareRegion string Can shared partitions be used in the current workspace: 1: Yes, 0: No
records.createDate string None
records.updateUser string None
records.updateDate string None
records.deleteFlag string Delete identification, 0 not deleted, 1 deleted
total string None
size string None
current string None
orders array None
optimizeCountSql string None
searchCount string None
pages string None
Note

//SDKID encryption using the following Java code as an example:

 public static void main(String[] args) {
* @param res Encrypted native string * @param key 16 character encryption key */ try { String res = " Encrypted native string"; String key = "16 character encryption key"; String ALGORITHM = "AES"; String CHARSET = "UTF-8"; SecretKeySpec sks = new SecretKeySpec(key.getBytes(CHARSET), ALGORITHM); Cipher cipher = Cipher.getInstance(ALGORITHM); cipher.init(cipher.ENCRYPT_MODE, sks); byte[] result = cipher.doFinal(res.getBytes()); // BASE64Encoder encoder = new BASE64Encoder(); //java8 Base64.Encoder encoder = Base64.getEncoder(); //java9+ System.out.println(encoder.encodeToString(result)); }catch (Exception e){ }
}

admin 2025年4月8日 14:23 收藏文档