JCS-pub/docs/JCS_pub_API_en.md

# JCS-pub API

**Back to [README.md](../README_en.md)**

## 1 Bucket Operations

### 1.1 Create Bucket

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/bucket/create</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
            <pre>{
    "userID": 1,
    "name": "bkt1"  // Bucket name
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "bucket": {
            "bucketID": 1,   // Bucket ID
            "name": "bkt1"   // Bucket name
        }
    }
}</pre>
        </td>
    </tr>
</table>

### 1.2 Get Bucket by Name

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/bucket/getByName</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">
        <p>&#45; name：string  // Bucket name</p>
        </td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
      "bucket": {
        "bucketID": 1,  // Bucket ID
        "name": "bkt1"  // Bucket name
      }
    }
}</pre>
        </td>
    </tr>
</table>

### 1.3 List Buckets

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/bucket/listAll</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
      "buckets": [{
        "bucketID": 1,  // Bucket ID
        "name": "bkt1"  // Bucket name
      }]
    }
}</pre>
        </td>
    </tr>
</table>

### 1.4 Delete Bucket

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/bucket/delete</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
            <pre>{
    "bucketID":1
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": null
}</pre>
        </td>
    </tr>
</table>

## 2 Package Operations

### 2.1 Create Package

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/package/create</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
            <pre>{
    "bucketID":1,
    "name": ""  // Package name
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "package": {
            "packageID": 32,
            "name": "t1",
            "bucketID": 1,
            "createTime": "2025-06-24T16:31:28.5148754+08:00"
        }
    }
}</pre>
        </td>
    </tr>
</table>

### 2.2 Get Package by Bucket Name and Package Name

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/package/getByFullName</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">
        <p>&#45; bucketName：string  // Bucket name
&#45; packageName：string  // Package name </p>
        </td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "package": {
            "packageID": 32,
            "name": "t1",
            "bucketID": 1,
            "createTime": "2025-06-24T16:31:28.5148754+08:00"
        }
    }
}</pre>
        </td>
    </tr>
</table>

### 2.3 List Packages in Bucket

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/package/listBucketPackages</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">
        <p>&#45; bucketID：int64  // Bucket ID </p>
        </td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
      "packages":[{
            "packageID": 32,
            "name": "t1",
            "bucketID": 1,
            "createTime": "2025-06-24T16:31:28.5148754+08:00"
        }]
    }
}</pre>
        </td>
    </tr>
</table>

### 2.4 Delete Package

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/package/delete</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
            <pre>{
    "packageID":1
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": null
}</pre>
        </td>
    </tr>
</table>

## 3 Object Operations

### 3.1 Batch Upload Objects

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>multipart/form-data; boundary=xxxxxxx</td>
        <td>/v1/object/upload</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <p>Afterwards, the request body is split into multiple parts using the boundary. The first part must have the name info and follow this JSON format:</p>
        <pre>{
  "packageID": 1,  // Package ID, obtained from the response of the Create Package API
  "affinity": 1  // Preferred storage space for uploading the file (optional)
}</pre>
        <p>Each subsequent part is a file. The name should be files, and the filename should be the file path (must be URL-encoded).
Example:</p>
        <pre>POST /object/upload HTTP/1.1
User-Agent: PostmanRuntime/7.29.0
Accept: */*
Postman-Token: c12fa8b5-d902-46f3-b104-028effa0d531
Host: localhost:7890
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Type: multipart/form-data; boundary=&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;818270992847011232305151
Content-Length: 1649
<span></span>
&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;818270992847011232305151
Content-Disposition: form-data; name="info"
<span></span>
{
	"userID": 1,
	"packageID": 1
}
&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;818270992847011232305151
Content-Disposition: form-data; name="files"; filename="test.txt"
Content-Type: text/plain
<span></span>
testdata
&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;818270992847011232305151
Content-Disposition: form-data; name="files"; filename="a%2Fb%2Ftest2.txt"
<span></span>
testdata2
&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;&#45;818270992847011232305151&#45;&#45;</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "uploadeds": [
            {
                "objectID": 7,
                "packageID": 1,
                "path": "test.txt",
                "size": "123456",
                "fileHash": "xxxxxxxxxx",
                "redundancy": {
                    "type": "none"
                },
                "createTime": "2024-11-05T11:06:28+08:00",
                "updateTime": "2025-01-10T09:15:39.4452196+08:00"
            },
            {
                "objectID": 8,
                "packageID": 1,
                "path": "a/b/test2.txt",
                "size": "123456",
                "fileHash": "xxxxxxxxxx",
                "redundancy": {
                    "type": "none"
                },
                "createTime": "2024-11-05T11:06:28+08:00",
                "updateTime": "2025-01-10T09:15:39.4452196+08:00"
            }
        ]
    }
}</pre>
        </td>
    </tr>
</table>

### 3.2 Download Object

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/object/download</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">
        <p>&#45; objectID：int64
&#45; offset：int64  
&#45; length：int64  // Length to read. If not provided, the entire object will be read. </p>
        </td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <p>If the request is successful, the <code>Content-Type</code> will be <code>application/octet-stream</code> and the response body will contain the file data.<br/>
If the request fails, the <code>Content-Type</code> will be <code>application/json</code> and the response body will be in the following format:</p>
        <pre>{
    "code": "OperationFailed",
    "message": "xxxxxxxx",
    "data": null
}</pre>
        </td>
    </tr>
</table>

### 3.3 Download Object by Path

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/object/downloadByPath</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">
        <p>&#45; path：string
&#45; offset：int64 
&#45; length：int64  // Length to read. If not provided, the entire object will be read. </p>
        </td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <p>If the request is successful, the <code>Content-Type</code> will be <code>application/octet-stream</code> and the response body will contain the file data.<br/>
If the request fails, the <code>Content-Type</code> will be <code>application/json</code> and the response body will be in the following format:</p>
        <pre>{
    "code": "OperationFailed",
    "message": "xxxxxxxx",
    "data": null
}</pre>
        </td>
    </tr>
</table>

### 3.4 Get Object by Path

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/object/listByPath</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">
        <p>&#45; packageID：int64
&#45; path：string
&#45; isPrefix：bool  // If true, perform a prefix search using the path parameter
&#45; noRecursive：bool  // If true, when performing a prefix search, the results will separate objects and "directories" like a directory listing
&#45; maxKeys：int  // Maximum number of results returned in this query (the total number of items in commonPrefixes + objects)
&#45; continuationToken：string  // Start this query from the position specified by the token; leave empty to start from the beginning. This value should be the same as the corresponding field from the previous response.  </p>
        </td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "nextContinuationToken": "123456", // Used for the next paginated query
        "isTruncated": false, // If true, it indicates more results are available for the next query
        "commonPrefixes": [
            "a/b/",
            "a/c/"
        ],
        "objects": [
            {
                "objectID": 617,
                "packageID": 12,
                "path": "a/1.txt",
                "size": "1293",
                "fileHash": "Full4E69A8B8CD9F42EDE371DA94458BADFB2308AFCA736AA393784A3D81F4746377",
                "redundancy": {
                    "type": "none"
                },
                "createTime": "2024-11-19T16:02:25+08:00",
                "updateTime": "2024-11-19T16:02:25+08:00"
            },
            {
                "objectID": 618,
                "packageID": 12,
                "path": "a/2.txt",
                "size": "1293",
                "fileHash": "Full4E69A8B8CD9F42EDE371DA94458BADFB2308AFCA736AA393784A3D81F4746377",
                "redundancy": {
                    "type": "none"
                },
                "createTime": "2024-11-19T16:02:25+08:00",
                "updateTime": "2024-11-19T16:02:25+08:00"
            }
        ]
    }
}</pre>
        </td>
    </tr>
</table>

### 3.5 List Objects in Package

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/object/getPackageObjects</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">
        <p>&#45; packageID：int64 </p>
        </td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "objects": [
            {
                "objectID": 617,
                "packageID": 12,
                "path": "a/1.txt",
                "size": "1293",
                "fileHash": "Full4E69A8B8CD9F42EDE371DA94458BADFB2308AFCA736AA393784A3D81F4746377",
                "redundancy": {
                    "type": "none"
                },
                "createTime": "2024-11-19T16:02:25+08:00",
                "updateTime": "2024-11-19T16:02:25+08:00"
            },
            {
                "objectID": 618,
                "packageID": 12,
                "path": "a/2.txt",
                "size": "1293",
                "fileHash": "Full4E69A8B8CD9F42EDE371DA94458BADFB2308AFCA736AA393784A3D81F4746377",
                "redundancy": {
                    "type": "none"
                },
                "createTime": "2024-11-19T16:02:25+08:00",
                "updateTime": "2024-11-19T16:02:25+08:00"
            }
        ]
    }
}</pre>
        </td>
    </tr>
</table>

### 3.6 Batch Move Objects

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/object/move</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
            <pre>{
    "movings":[
        {
            "objectID":4, // Original object ID
            "packageID":3, // Target package ID after moving
            "path":"trace2.txt" // Target path after moving
        }
    ]
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
      "successes": [ // IDs of successfully moved objects
        4
      ]
    }
}</pre>
        </td>
    </tr>
</table>

### 3.7 Batch Delete Objects

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/object/delete</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
            <pre>{
    "objectIDs":[
      4
    ]
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": null
}</pre>
        <p>The response code will be OK even if the file does not exist.</p>
        </td>
    </tr>
</table>

### 3.8 Batch Copy Objects

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/object/clone</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
            <pre>{
    "clonings": [
        {
            "objectID": 4,  // Original object ID
            "newPath": "trace3.txt",  // The new object's path
            "newPackageID": 3  // The new object's package ID
        }
    ]
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
      "objects":[{
                "objectID": 5,
                "packageID": 3,
                "path": "trace3.txt",
                "size": "1293",
                "fileHash": "Full4E69A8B8CD9F42EDE371DA94458BADFB2308AFCA736AA393784A3D81F4746377",
                "redundancy": {
                    "type": "none"
                },
                "createTime": "2024-11-19T16:02:25+08:00",
                "updateTime": "2024-11-19T16:02:25+08:00"
       }]
    }
}</pre>
        </td>
    </tr>
</table>

### 3.9 Create Multipart Upload

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/object/newMultipartUpload</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
            <pre>{
    "packageID": 3,
    "path": "multi"  // The object's path
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "object": {
            "objectID": 1039,
            "packageID": 3,
            "path": "obj.txt",
            "size": "0",
            "fileHash": "Full0000000000000000000000000000000000000000000000000000000000000000",
            "redundancy": {
                "type": "multipartUpload"
            },
            "createTime": "2025-03-04T16:03:18+08:00",
            "updateTime": "2025-03-11T15:20:44.5182982+08:00"
        }
    }
}</pre>
        <p>The created object can be found using the query interface.</p>
        </td>
    </tr>
</table>

### 3.10 Upload Part

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>multipart/form-data; boundary=xxxxxxx</td>
        <td>/v1/object/uploadPart</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <p>Similar to the object upload interface, the request must contain two parts: <code>info</code> and <code>file</code>. The <code>info</code> part should have the following format:</p>
        <pre>{
  "objectID": 1, // The Object ID obtained from the Create Multipart Upload API
  "index": 1 // The part number used for merging later. Parts with the same index will overwrite the old data.
}</pre>
        <p>The <code>file</code> part contains the file data.</p>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": ""
}</pre>
        </td>
    </tr>
</table>

### 3.11 Complete Multipart Upload

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/object/completeMultipartUpload</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <pre>{
    "objectID": 1039,  // The Object ID to be merged
    "indexes": [2,3,1]  // The list of part numbers. Duplicate part numbers are allowed; parts will be merged in the specified order. Unused parts will be discarded.
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "object": {
            "objectID": 1039,
            "packageID": 3,
            "path": "obj.txt",
            "size": "30",
            "fileHash": "FullB7660EB37969EDC68202258A1838B89493B4C77EA006B1640768D20CEF7A7CD2",
            "redundancy": {
                "type": "none"
            },
            "createTime": "2025-03-04T16:03:18+08:00",
            "updateTime": "2025-03-11T15:42:03+08:00"
        }
    }
}</pre>
        </td>
    </tr>
</table>

## 4 User Storage Configuration

### 4.1 Create User Storage Configuration

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/userSpace/create</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <pre>{
    "name": "test1",
    "storage": { // Storage system type
        "type": "OBS",
        "region": "",
        "endpoint": "",
        "bucket": "",
        "projectID": ""
    },
    "credential": { // Permission information required to access the storage system
        "type": "OBS",
        "accessKeyId": "",
        "secretAccessKey": ""
    },
    "shardStore": { // Configuration for shard storage; if null, shard storage is disabled
        "maxSize":1024
    },
    "features": [], // Configuration of feature functions for the storage system
    "workingDir": "" // Root directory for storing data of various components, including shard storage
}</pre>
        <p>&#45; The content of <code>storage</code> and <code>credential</code> is determined by the value of the <code>type</code> field. You can find more type definitions in the package at <code>gitlink.org.cn/cloudream/jcs-pub/coordinator/types</code>.
&#45; <code>Features</code> configures the feature functions of the storage system; the specific available features can also be referenced from the package above. Note: Not all storage systems support all features.</p>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "userSpace": {
            "userSpaceID": 1,
            "name": "test1",
            "storage": {
                "type": "OBS",
                "region": "",
                "endpoint": "",
                "bucket": "",
                "projectID": ""
            },
            "credential": {
                "type": "OBS",
                "accessKeyId": "",
                "secretAccessKey": ""
            },
            "shardStore": {
                "maxSize": 1024
            },
            "features": [],
            "workingDir": "",
            "revision": 1
        }
    }
}</pre>
        </td>
    </tr>
</table>

### 4.2 Update User Storage Configuration

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/userSpace/update</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <pre>{
    "userSpaceID": 1,
    "name": "test1",  // New name
    "credential": {   // New credential information
        "type": "OBS",
        "accessKeyId": "",
        "secretAccessKey": ""
    }
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "userSpace": {
            "userSpaceID": 1,
            "name": "test1",
            "storage": {
                "type": "OBS",
                "region": "",
                "endpoint": "",
                "bucket": "",
                "projectID": ""
            },
            "credential": {
                "type": "OBS",
                "accessKeyId": "",
                "secretAccessKey": ""
            },
            "shardStore": {
                "maxSize": 1024
            },
            "features": [],
            "workingDir": "",
            "revision": 1
        }
    }
}</pre>
        </td>
    </tr>
</table>

### 4.3 Delete User Storage Configuration

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/userSpace/delete</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <pre>{
    "userSpaceID": 1
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": null
}</pre>
        <p>The response code will be OK even if the file does not exist.</p>
        </td>
    </tr>
</table>

### 4.4 Get User Storage Configuration

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/userSpace/get</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">
        <p>&#45; userSpaceID: int64</p>
        </td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "userSpace": {
            "userSpaceID": 1,
            "name": "test1",
            "storage": {
                "type": "OBS",
                "region": "",
                "endpoint": "",
                "bucket": "",
                "projectID": ""
            },
            "credential": {
                "type": "OBS",
                "accessKeyId": "",
                "secretAccessKey": ""
            },
            "shardStore": {
                "maxSize": 1024
            },
            "features": [],
            "workingDir": "",
            "revision": 1
        }
    }
}</pre>
        </td>
    </tr>
</table>

### 4.5 Test User Storage Configuration

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/userSpace/test</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <pre>{
    "storage": {
        "type": "OBS",
        "region": "",
        "endpoint": "",
        "bucket": "",
        "projectID": ""
    },
    "credential": {
        "type": "OBS",
        "accessKeyId": "",
        "secretAccessKey": ""
    },
    "workingDir": ""
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": null
}</pre>
        <p>The OK response indicates the configuration is valid and connected to the storage system.</p>
        </td>
    </tr>
</table>

### 4.6 Upload to New Package from User Storage

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/userSpace/createPackage</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <pre>{
    "userSpaceID": 1,
    "path": "",  // Path within the user's storage space. Can be a folder or a file. Note: WorkingDir is not prepended.
    "bucketID": 1,  // bucketID of the newly created package
    "name": "",  // Name of the newly created package
    "spaceAffinity": 0  // Preferred storage space for uploading files. 0 means no preference.
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "package": {
            "packageID": 32,
            "name": "t1",
            "bucketID": 1,
            "createTime": "2025-06-24T16:31:28.5148754+08:00"
        }
    }
}</pre>
        </td>
    </tr>
</table>

### 4.7 Download Package to User Storage

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/userSpace/downloadPackage</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <pre>{
    "userSpaceID": 1,
    "packageID": 1,
    "rootPath": "", // Root path for storing downloaded files
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": null
}</pre>
        </td>
    </tr>
</table>

## 5 User Storage Sync

### 5.1 Create Sync Task

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/spaceSyncer/createTask</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <pre>{
    "trigger": { // Sync task trigger condition
        "type": "Interval",
        "interval": 30
    },
    "mode": { // Sync mode
        "type": "Diff",
        "includeSize": false,
        "includeModTime": true
    },
    "filters": [ // Filter rules
        {
            "type": "Size",
            "minSize": 10,
            "maxSize": 20000
        }
    ],
    "options": { // Options
        "noEmptyDirectories": false
    }, 
    "srcUserSpaceID": 1, // Source storage space ID
    "srcPath": "space1/cli", // Path within source storage space
    "destUserSpaceIDs": [ // Destination storage space IDs
        2
    ],
    "destPathes": [ // Paths within destination storage spaces
        "space2/svr"
    ]
}</pre>
        <p>The contents of <code>trigger</code>, <code>mode</code>, and <code>filters</code> vary according to their <code>type</code> fields. For more details, please refer to the package at <code>gitlink.org.cn/cloudream/jcs-pub/client/types</code>.</p>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "task": {
            "taskID": 1,
            "trigger": {
                "type": "Interval",
                "interval": 30
            },
            "mode": {
                "type": "Diff",
                "includeSize": false,
                "includeModTime": true
            },
            "filters": [
                {
                    "type": "Size",
                    "minSize": 10,
                    "maxSize": 20000
                }
            ],
            "options": {
                "noEmptyDirectories": false
            },
            "srcUserSpaceID": 1,
            "srcPath": "space1/cli",
            "destUserSpaceIDs": [
                2
            ],
            "destPathes": [
                "space2/svr"
            ]
        }
    }
}</pre>
        </td>
    </tr>
</table>

### 5.2 Get Sync Task

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>GET</td>
        <td>application/json</td>
        <td>/v1/spaceSyncer/getTask</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">
        <p>&#45; taskID: int64</p>
        </td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": {
        "task": {
            "taskID": 1,
            "trigger": {
                "type": "Interval",
                "interval": 30
            },
            "mode": {
                "type": "Diff",
                "includeSize": false,
                "includeModTime": true
            },
            "filters": [
                {
                    "type": "Size",
                    "minSize": 10,
                    "maxSize": 20000
                }
            ],
            "options": {
                "noEmptyDirectories": false
            },
            "srcUserSpaceID": 1,
            "srcPath": "space1/cli",
            "destUserSpaceIDs": [
                2
            ],
            "destPathes": [
                "space2/svr"
            ]
        }
    }
}</pre>
        </td>
    </tr>
</table>

### 5.3 Cancel Sync Task

<table class="api-doc-table" > 
    <tr>
        <th colspan="3">Request</th>
    </tr>
    <tr>
        <td>POST</td>
        <td>application/json</td>
        <td>/v1/spaceSyncer/cancelTask</td>
    </tr>
    <tr>
        <td>Query</td>
        <td colspan="2">None</td>
    </tr>
    <tr>
        <td>Body</td>
        <td colspan="2">
        <pre>{
    "taskID": 1
}</pre>
        </td>
    </tr>
    <tr>
        <th colspan="3">Response Example</th>
    </tr>
    <tr>
        <td colspan="3">
        <pre>{
    "code": "OK",
    "message": "",
    "data": null
}</pre>
        </td>
    </tr>
</table>

<style>
.api-doc-table {
  border-collapse: collapse;
  width: 100%;
  font-family: monospace;
  border: 1px solid #e1e4e8;
}

.api-doc-table th {
  background-color: #f6f8fa;
  text-align: center;
  font-weight: 600;
  padding: 8px 12px;
}

.api-doc-table td {
  background-color: #ffffff;
}

.api-doc-table tr:not(:last-child) td:first-child {
  font-weight: bold;
}

.api-doc-table p {
  margin: 6px 0px 0px;
  line-height: 1.2;
  font-size: 0.95em;  
}

.api-doc-table pre {
   margin: 0px 2px 3px;
   padding: 0px 0px; 
}
</style>