Skip to content

Commit a4d6f27

Browse files
dingjsdeekoder
authored andcommitted
fix issue #645. (#647)
Chinese version of API doc needs to be updated to reflect set/getBucketPolicy fix (PR#639).
1 parent eaa44a7 commit a4d6f27

File tree

1 file changed

+28
-20
lines changed

1 file changed

+28
-20
lines changed

docs/zh_CN/API.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -200,15 +200,15 @@ except ResponseError as err:
200200
```
201201

202202
<a name="list_objects"></a>
203-
### list_objects(bucket_name, prefix, recursive=False)
203+
### list_objects(bucket_name, prefix=None, recursive=False)
204204
列出存储桶中所有对象。
205205

206206
参数
207207

208208
| 参数 | 类型 | 描述 |
209209
|:---|:---|:---|
210210
|``bucket_name`` |_string_ | 存储桶名称。 |
211-
|``objectPrefix`` | _string_ |用于过滤的对象名称前缀。 |
211+
|``prefix`` | _string_ |用于过滤的对象名称前缀。可选项,默认为None|
212212
|``recursive`` | _bool_ |`True`代表递归查找,`False`代表类似文件夹查找,以'/'分隔,不查子文件夹。(可选,默认值是`False`)。 |
213213

214214
__返回值__
@@ -219,10 +219,14 @@ __返回值__
219219

220220
| 参数 | 类型 | 描述 |
221221
|:---|:---|:---|
222-
|``object.object_name`` |_string_ | 对象名称。 |
223-
|``object.size`` |_int_ | 对象的大小。 |
224-
|``object.etag`` |_string_ | 对象的etag值。 |
225-
|``object.last_modified`` |_datetime.datetime_ | 最后修改时间。 |
222+
|``object.bucket_name`` | _string_ | 对象所在存储桶的名称。|
223+
|``object.object_name`` | _string_ | 对象的名称。|
224+
|``object.is_dir`` | _bool_ | `True`代表列举的对象是文件夹(对象前缀), `False`与之相反。|
225+
|``object.size`` | _int_ | 对象的大小。|
226+
|``object.etag`` | _string_ | 对象的etag值。|
227+
|``object.last_modified`` |_datetime.datetime_ | 最后修改时间。|
228+
|``object.content_type`` | _string_ | 对象的content-type。|
229+
|``object.metadata`` | _dict_ | 对象的其它元数据。|
226230

227231

228232
__示例__
@@ -237,15 +241,15 @@ for obj in objects:
237241
```
238242

239243
<a name="list_objects_v2"></a>
240-
### list_objects_v2(bucket_name, prefix, recursive=False)
244+
### list_objects_v2(bucket_name, prefix=None, recursive=False)
241245
使用V2版本API列出一个存储桶中的对象。
242246

243247
参数
244248

245249
| 参数 | 类型 | 描述 |
246250
|:---|:---|:---|
247251
|``bucket_name`` |_string_ | 存储桶名称。 |
248-
|``objectPrefix`` | _string_ |用于过滤的对象名称前缀。 |
252+
|``prefix`` | _string_ |用于过滤的对象名称前缀。可选项,默认为None|
249253
|``recursive`` | _bool_ |`True`代表递归查找,`False`代表类似文件夹查找,以'/'分隔,不查子文件夹。(可选,默认值是`False`)。 |
250254

251255
__返回值__
@@ -256,10 +260,14 @@ __返回值__
256260

257261
| 参数 | 类型 | 描述 |
258262
|:---|:---|:---|
259-
|``object.object_name`` |_string_ | 对象名称。 |
260-
|``object.size`` |_int_ | 对象的大小。 |
261-
|``object.etag`` |_string_ | 对象的etag值。 |
262-
|``object.last_modified`` |_datetime.datetime_ | 最后修改时间。 |
263+
|``object.bucket_name`` | _string_ | 对象所在存储桶的名称。|
264+
|``object.object_name`` | _string_ | 对象的名称。|
265+
|``object.is_dir`` | _bool_ | `True`代表列举的对象是文件夹(对象前缀), `False`与之相反。|
266+
|``object.size`` | _int_ | 对象的大小。|
267+
|``object.etag`` | _string_ | 对象的etag值。|
268+
|``object.last_modified`` |_datetime.datetime_ | 最后修改时间。|
269+
|``object.content_type`` | _string_ | 对象的content-type。|
270+
|``object.metadata`` | _dict_ | 对象的其它元数据。|
263271

264272

265273
__示例__
@@ -552,7 +560,7 @@ for event in events:
552560

553561
## 3. 操作对象
554562
<a name="get_object"></a>
555-
### get_object(bucket_name, object_name)
563+
### get_object(bucket_name, object_name, request_headers=None)
556564
下载一个对象。
557565

558566
参数
@@ -584,7 +592,7 @@ except ResponseError as err:
584592
```
585593

586594
<a name="get_partial_object"></a>
587-
### get_partial_object(bucket_name, object_name, offset=0, length=0)
595+
### get_partial_object(bucket_name, object_name, offset=0, length=0, request_headers=None)
588596
下载一个对象的指定区间的字节数组。
589597

590598
参数
@@ -617,7 +625,7 @@ except ResponseError as err:
617625
```
618626

619627
<a name="fget_object"></a>
620-
### fget_object(bucket_name, object_name, file_path)
628+
### fget_object(bucket_name, object_name, file_path, request_headers=None)
621629
下载并将文件保存到本地。
622630

623631
参数
@@ -655,7 +663,7 @@ except ResponseError as err:
655663
```
656664

657665
<a name="copy_object"></a>
658-
### copy_object(bucket_name, object_name, object_source, copy_conditions)
666+
### copy_object(bucket_name, object_name, object_source, copy_conditions=None)
659667
拷贝对象存储服务上的源对象到一个新对象。
660668

661669
注意:本API支持的最大文件大小是5GB。
@@ -704,7 +712,7 @@ except ResponseError as err:
704712
```
705713

706714
<a name="put_object"></a>
707-
### put_object(bucket_name, object_name, data, length, content_type)
715+
### put_object(bucket_name, object_name, data, length, content_type='application/octet-stream', metadata=None)
708716
添加一个新的对象到对象存储服务。
709717

710718
注意:本API支持的最大文件大小是5TB。
@@ -751,7 +759,7 @@ except ResponseError as err:
751759
```
752760

753761
<a name="fput_object"></a>
754-
### fput_object(bucket_name, object_name, file_path, content_type)
762+
### fput_object(bucket_name, object_name, file_path, content_type='application/octet-stream', metadata=None)
755763
通过文件上传到对象中。
756764

757765
参数
@@ -761,8 +769,8 @@ except ResponseError as err:
761769
|``bucket_name`` |_string_ |存储桶名称。 |
762770
|``object_name`` |_string_ |对象名称。 |
763771
|``file_path`` |_string_ |本地文件的路径,会将该文件的内容上传到对象存储服务上。 |
764-
|``content_type`` |_string_ | 对象的Content type(可选,默认是“application/octet-stream”)。 |
765-
|``metadata`` |_dict_ | 其它元数据(可选,默认是None)。 |
772+
|``content_type`` |_string_ | 对象的Content type(可选,默认是“application/octet-stream”)。 |
773+
|``metadata`` |_dict_ | 其它元数据(可选,默认是None)。 |
766774

767775
__返回值__
768776

0 commit comments

Comments
 (0)