Browse Source

更新readme

feature_gxh
songjc 4 months ago
parent
commit
087e38728b
1 changed files with 127 additions and 15 deletions
  1. +127
    -15
      docs/JCS_pub_API.md

+ 127
- 15
docs/JCS_pub_API.md View File

@@ -2,37 +2,37 @@

**跳转回README.md [中文](../README.md) [英文](../README_en.md)**

## 1桶相关
## 1 桶相关

### 1.1 创建桶

<table border="1" style="border-collapse: collapse; width: 100%; font-family: monospace;">
<tr >
<th colspan="3" style="text-align: center; background-color: #f6f8fa;">请求</th>
<table class="api-doc-table" >
<tr>
<th colspan="3">请求</th>
</tr>
<tr>
<td style="padding: 6px; font-weight: bold; background-color: #ffffff;">POST</td>
<td style="padding: 6px; background-color: #ffffff;">application/json</td>
<td style="padding: 6px; background-color: #ffffff;">/v1/bucket/create</td>
<td>POST</td>
<td>application/json</td>
<td>/v1/bucket/create</td>
</tr>
<tr>
<td style="padding: 6px; font-weight: bold; background-color: #ffffff;">Query</td>
<td colspan="2" style="padding: 6px; background-color: #ffffff;">无</td>
<td>Query</td>
<td colspan="2">无</td>
</tr>
<tr>
<td style="padding: 6px; font-weight: bold; background-color: #ffffff;">Body</td>
<td colspan="2" style="padding: 6px 10px; vertical-align: top; background-color: #ffffff;">
<pre style="margin: 0; font-family: inherit;">{
<td>Body</td>
<td colspan="2">
<pre>{
"userID": 1,
"name": "bkt1" //桶名
}</pre>
</td>
</tr>
<tr>
<th colspan="3" style="text-align: center; font-weight: bold; background-color: #f6f8fa;">响应示例</th>
<th colspan="3">响应示例</th>
</tr>
<tr>
<td colspan="3" style="padding: 6px 10px; vertical-align: top; background-color: #ffffff;">
<td colspan="3">
<pre>{
"code": "OK",
"message": "",
@@ -45,4 +45,116 @@
}</pre>
</td>
</tr>
</table>
</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 {
padding: 8px 12px;
border-top: 1px solid #eaecef;
background-color: #ffffff;
}

.api-doc-table td:first-child {
font-weight: bold;
}

.api-doc-table pre {
/* margin: 0; */
font-family: monospace;
font-size: 14px;
line-height: 1.5;
}
</style>


### 1.2 根据名字查询桶


### 1.3 查询所有桶



### 1.4 删除桶


## 2 包相关

### 2.1 创建包


### 2.2 根据桶名和包名查询包


### 2.3 获取桶里所有的包


### 2.4 删除包


## 3 对象相关

### 3.1 批量上传对象

### 3.2 下载对象

### 3.3 根据路径下载对象


### 3.4 根据路径查询对象

### 3.5 获取包中所有的对象

### 3.6 批量移动对象

### 3.7 批量删除对象

### 3.8 批量复制对象

### 3.9 创建分片上传对象

### 3.10 上传分片

### 3.11 合并分片

## 4 用户存储空间相关

### 4.1 创建用户存储空间配置

### 4.2 更新用户存储空间配置

### 4.3 删除用户存储空间配置

### 4.4 获取用户存储空间配置

### 4.5 测试用户存储空间配置

### 4.6 从用户存储空间上传到一个新的包

### 4.7 下载一个包到用户存储空间


## 5 用户存储空间同步相关

### 5.1 创建同步任务

### 5.2 获取同步任务

### 5.3 取消同步任务





Loading…
Cancel
Save