Skip to content

feat(update_api):update api docs #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
peng-li-alex wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(update_api):update api docs #905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ufile-api/class_switch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 简介

用于转换文件的存储类型，可以任意转换文件为标准、低频、冷存三种存储类型，注意：冷存文件如果想转换为其他两种类型必须在解冻期内。
用于转换文件的存储类型，可以由热转冷。如标准->低频/归档, 低频->归档

## 定义

Expand All @@ -25,7 +25,7 @@ Authorization: <token>

|Name |Type |Description |Required|
|---|---|---|---|
|storageClass |String|目标存储类型，三种：STANDARD（标准）、IA（低频）、ARCHIVE（冷存）|Yes |
|storageClass |String|目标存储类型，三种：IA（低频）、ARCHIVE（冷存）|Yes |

### 响应（Responses）

Expand All @@ -50,7 +50,7 @@ Authorization: <token>
### 请求示例（Example Request）:

```
PUT /archive_file.txt?storageClass=IA HTTP/1.1
PUT /standard_file.txt?storageClass=IA HTTP/1.1
Host: <bucket_name>.cn-bj.ufileos.com
Authorization: UCloud demouser@ucloud.cn13424346821929713944:S5FVD2w613MKb/hisjaqHdjvn9U=
```
Expand All @@ -69,7 +69,7 @@ Content-Type: applicaton/json
Content-Length: 62
X-SessionId: e2f4fc84-3936-4a2d-85b5-ef8f2e79933c
{
"RetCode": -148671,
"ErrMsg": "file has not been restored"
"RetCode": -148660,
"ErrMsg": "switch class not allowed"
}
```
2 changes: 1 addition & 1 deletion ufile-api/list_objects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Authorization: <token>
|---|---|---|---|
|Prefix|string|返回以Prefix作为前缀的目录文件<br>当delimiter为("")时，返回的列表包含prefix内的所有子文件及子文件夹<br>当delimiter为("/")时，返回prefix下的所有文件和子文件夹,但不显示子文件夹下递归的目录和文件。<br>ps：当delimiter为("/")时，且prefix以("/")结尾时，列表返回不会包含与prefix相同的文件/目录名的对象|No|
|Marker|string|返回以字母排序后，大于Marker的目录文件列表<br>默认值:无|No|
|Limit|int|指定返回目录文件列表的最大数量<br>范围:[0,1000]<br>默认值:100|No|
|MaxKeys|int|指定返回目录文件列表的最大数量<br>范围:[0,1000]<br>默认值:100|No|
|Delimiter|string|目录分隔符，当前只支持"/"和"".<br>当Delimiter设置为"/"时，返回目录形式的文件列表.<br>当Delimiter设置为""时，返回非目录层级文件列表|No|

### 响应（Responses）
Expand Down