This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1: ArchivingHistory
2: ArchivingHistoryListResponse
3: ArchivingHistoryShowResponse
4: ArchivingInfo
5: ArchivingPolicies
6: ArchivingPolicyCreateRequest
7: ArchivingPolicyCreateResponse
8: ArchivingPolicyListResponse
9: ArchivingPolicyShowResponse
10: ArchivingPolicyStateUpdateRequest
11: ArchivingPolicyStateUpdateResponse
12: ArchivingPolicyUpdateRequest
13: ArchivingPolicyUpdateResponse
14: ArchivingSource
15: BucketCreateRequest
16: BucketCreateResponse
17: BucketEncryptionRequest
18: BucketEncryptionResponse
19: BucketListResponse
20: BucketShowResponse
21: BucketVersioningResponse
22: BucketVersionRequest
23: BucketWithName
24: Object
25: ObjectDeleteRequest
26: ObjectListResponse
27: ObjectRecoverRequest
28: ObjectRecoverResponse
29: ObjectRecoveryInfo
30: ObjectVersionListResponse
31: ObjectVersionRecoverRequest
32: ObjectVersionRecoverResponse
33: ObjectVersions
34: ObjectVersionsDeleteRequest
35: RecoveryHistory
36: RecoveryHistoryListResponse
37: RecoveryHistoryShowResponse
38: RecoveryInfo
39: Tag

1 - ArchivingHistory

Name	Description	Schema
archiving_id required	Archiving ID Example : `SCH-02d48456-0f35-47e2-8056-b00e09366cac`	any of [string, null]
id required	Archiving History ID Example : `EXE-8f35b491-a060-453b-b825-e78440ca46de`	any of [string, null]
state required	State Example : `SUCCESS`	any of [string, null]
archiving_policy_id required	Archiving Policy ID Example : `SCH-02d48456-0f35-47e2-8056-b00e09366cac`	any of [string, null]
start_at required	Start at Example : `2025-04-01T00:00:00+09:00`	any of [string (date-time), null]
end_at required	End at Example : `2025-04-30T23:59:59+09:00`	any of [string (date-time), null]

2 - ArchivingHistoryListResponse

Name	Description	Schema
total_count required	Total Count Example : `10`	any of [integer, null]
bucket_id required	Bucket ID Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	any of [string, null]
contents required	History List	array[ArchivingHistory]

3 - ArchivingHistoryShowResponse

Name	Description	Schema
archiving_id required	Archiving ID Example : `SCH-02d48456-0f35-47e2-8056-b00e09366cac`	any of [string, null]
id required	Archiving History ID Example : `EXE-8f35b491-a060-453b-b825-e78440ca46de`	any of [string, null]
state required	State Example : `SUCCESS`	any of [string, null]
archiving_policy_id required	Archiving Policy ID Example : `SCH-02d48456-0f35-47e2-8056-b00e09366cac`	any of [string, null]
start_at required	Start at Example : `2025-04-01T00:00:00+09:00`	any of [string (date-time), null]
end_at required	End at Example : `2025-04-30T23:59:59+09:00`	any of [string (date-time), null]
bucket_id required	Bucket ID Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	any of [string, null]
archiving_infos required	Archiving Info List	array[ArchivingInfo]

4 - ArchivingInfo

Name	Description	Schema
source_object_path required	Source Object Path Example : `example_source_object_path/`	any of [string, null]
usage required	Usage Example : `1024`	any of [string, null]
total_object_count required	Total Object Count Example : `100`	any of [integer, null]
archiving_object_count required	Archiving Object Count Example : `50`	any of [integer, null]
archiving_rate required	Archiving Rate Example : `100`	any of [integer, null]

5 - ArchivingPolicies

Name	Description	Schema
id required	Archiving Policy ID Example : `SCH-XXXXXXX`	string
object_lifecycle required	Object LifeCycle Example : `1`	any of [string, null]
object_path required	Object Path Example : `/`	any of [string, null]
state required	Archiving Policy State Example : `ACTIVE`	string

6 - ArchivingPolicyCreateRequest

Name	Description	Schema
archiving_source_bucket_name required	Archiving Source Bucket Name Example : `obs-bucket-name`	string
object_lifecycle required	Object LifeCycle Example : `1`	string
object_path required	Object Path Example : `/` Pattern : `^/$`	string

7 - ArchivingPolicyCreateResponse

Name	Description	Schema
id required	Archiving Policy ID Example : `SCH-XXXXXXX`	string
bucket_id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
archiving_source required	Archiving Source	ArchivingSource
object_lifecycle required	Object LifeCycle Example : `1`	string
state required	Archiving Policy State Example : `ACTIVE`	string

8 - ArchivingPolicyListResponse

Name	Description	Schema
count required	count Example : `1`	integer
bucket_id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
archiving_source_bucket_name required	Archiving Source Bucket Name Example : `obs-bucket-name`	any of [string, null]
archiving_policies required	Archiving Policy List	any of [array[ArchivingPolicies], null]

9 - ArchivingPolicyShowResponse

Name	Description	Schema
id required	Archiving Policy ID Example : `SCH-XXXXXXX`	string
bucket_id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
archiving_source required	Archiving Source	ArchivingSource
object_lifecycle required	Object LifeCycle Example : `1`	any of [string, null]
state required	Archiving Policy State Example : `ACTIVE`	any of [string, null]

10 - ArchivingPolicyStateUpdateRequest

Name	Description	Schema	Default
state required	Archiving Policy State Example : `ACTIVE` Pattern : `^(ACTIVE\|INACTIVE)$`	string

11 - ArchivingPolicyStateUpdateResponse

Name	Description	Schema
id required	Archiving Policy ID Example : `SCH-XXXXXXX`	string
bucket_id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
state required	Archiving Policy State Example : `ACTIVE`	string

12 - ArchivingPolicyUpdateRequest

Name	Description	Schema	Default
object_lifecycle required	Object LifeCycle Example : `1`	string

13 - ArchivingPolicyUpdateResponse

Name	Description	Schema
id required	Archiving Policy ID Example : `SCH-XXXXXXX`	string
bucket_id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
archiving_source required	Archiving Source	ArchivingSource
object_lifecycle required	Object LifeCycle Example : `1`	string
state required	Archiving Policy State Example : `ACTIVE`	string

14 - ArchivingSource

Name	Description	Schema	Default
bucket_name required	Archiving Source Bucket Name Example : `obs-bucket-name`	any of [string, null]
object_path required	Object Path Example : `/`	any of [string, null]

15 - BucketCreateRequest

Name	Description	Schema	Default
name required	Bucket name Example : `astest`	string
tags optional	Tag List	any of [array[Tag], null]

16 - BucketCreateResponse

Name	Description	Schema	Default
id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string

17 - BucketEncryptionRequest

Name	Description	Schema	Default
enabled required	Encryption Enabled Example : `True`	boolean

18 - BucketEncryptionResponse

Name	Description	Schema	Default
id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
enabled required	Encryption Enabled Example : `True`	boolean

19 - BucketListResponse

Name	Description	Schema	Default
buckets required	Bucket List	array[BucketWithName]

20 - BucketShowResponse

Name	Description	Schema
id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
name required	Bucket name Example : `astest`	string
state required	Bucket state Example : `ACTIVE`	string
usage optional	Bucket usage Example : `10`	any of [string, null]
archiving_source_bucket_name optional	Archiving source bucket name Example : `obstest`	any of [string, null]

21 - BucketVersioningResponse

Name	Description	Schema	Default
id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
enabled required	Version Enabled Example : `True`	boolean

22 - BucketVersionRequest

Name	Description	Schema	Default
enabled required	Versioning Enabled Example : `True`	boolean

23 - BucketWithName

Name	Description	Schema	Default
id required	Bucket ID Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
name required	Bucket name Example : `astest`	string

24 - Object

Name	Description	Schema
object_name required	Object Name Example : `hello/TODO.txt`	string
object_type required	Object Type Example : `FILE`	string
object_size optional	Object Size Example : `3581`	any of [string, null]
modified_at optional	Modified AT Example : `2025-04-09T05:54:46.244000+00:00`	any of [string, null]

25 - ObjectDeleteRequest

Name	Description	Schema	Default
paths required	Object Path List Example : `['test/']`	array[string]

26 - ObjectListResponse

Name	Description	Schema
count required	count Example : `1`	integer
marker optional	Marker Example : `TODO.txt`	any of [string, null]
is_truncated required	is_truncated indicates whether the current result contains all data or only part of it. Example : `True`	boolean
contents required	Object List	array[Object]

27 - ObjectRecoverRequest

Name	Description	Schema
recovery_target_bucket_name required	Recovery Target Bucket Name Example : `obs-bucket-name`	string
recovery_infos required	Object Recovery Info List	array[ObjectRecoveryInfo]
overwrite required	Overwrite Example : `True`	boolean

28 - ObjectRecoverResponse

Name	Description	Schema	Default
id required	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
recovery_target_bucket_name required	Recovery Target Bucket Name Example : `obs-bucket-name`	string

29 - ObjectRecoveryInfo

Name	Description	Schema	Default
source_object_path required	Recovery Source Object Path Example : `/`	string
object_type required	Object Type Example : `FILE` Pattern : `^(FILE\|FOLDER)$`	string

30 - ObjectVersionListResponse

Name	Description	Schema	Default
count required	count Example : `1`	integer
contents required		array[ObjectVersions]

31 - ObjectVersionRecoverRequest

Name	Description	Schema
recovery_target_bucket_name required	Recovery Target Bucket Name Example : `obs-bucket-name`	string
source_object_path required	Recovery Source Object Path Example : `/`	string
source_object_version required	Recovery Source Object Version Example : `Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl`	string
overwrite required	Overwrite Example : `True`	boolean

32 - ObjectVersionRecoverResponse

Name	Description	Schema	Default
id required	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
recovery_target_bucket_name required	Recovery Target Bucket Name Example : `obs-bucket-name`	string

33 - ObjectVersions

Name	Description	Schema
object_path required	Object Path Example : `hello/my_file.txt`	string
object_version_id required	Object Version Id Example : `Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl`	string
latest required	Is Latest version of Object Example : `True`	boolean
modified_at required	Modified AT Example : `2025-04-09T05:54:46.244000+00:00`	string (date-time)
etag required	ETag Example : `4f6094f1e0619a6504efcb5e69e63bec`	string
size required	Size Example : `20`	string

34 - ObjectVersionsDeleteRequest

Name	Description	Schema	Default
path required	Object Path Example : `hello/my_file.txt`	string
versions required	Object Version List Example : `['Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl', 'asSrZ.-K.cf67F0NhXR353JS7Kx6kmm']`	array[object]

35 - RecoveryHistory

Name	Description	Schema
recovery_id required	Recovery ID Example : `ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5`	any of [string, null]
id required	Recovery History ID Example : `EXE-9df439a5-9e6d-46a4-806e-1e9991520763`	any of [string, null]
state required	State Example : `SUCCESS`	any of [string, null]
recovery_target_bucket_name required	Recovery Target Bucket NAME Example : `test-obs-bucket`	any of [string, null]
start_at required	Start at Example : `2025-04-01T00:00:00+09:00`	any of [string (date-time), null]
end_at required	End at Example : `2025-04-30T23:59:59+09:00`	any of [string (date-time), null]

36 - RecoveryHistoryListResponse

Name	Description	Schema
total_count required	Total Count Example : `10`	any of [integer, null]
bucket_id required	Bucket ID Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	any of [string, null]
contents required	History List	array[RecoveryHistory]

37 - RecoveryHistoryShowResponse

Name	Description	Schema
recovery_id required	Recovery ID Example : `ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5`	any of [string, null]
id required	Recovery History ID Example : `EXE-9df439a5-9e6d-46a4-806e-1e9991520763`	any of [string, null]
state required	State Example : `SUCCESS`	any of [string, null]
recovery_target_bucket_name required	Recovery Target Bucket NAME Example : `test-obs-bucket`	any of [string, null]
start_at required	Start at Example : `2025-04-01T00:00:00+09:00`	any of [string (date-time), null]
end_at required	End at Example : `2025-04-30T23:59:59+09:00`	any of [string (date-time), null]
bucket_id required	Bucket ID Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	any of [string, null]
recovery_infos required	Recovery Info List	array[RecoveryInfo]

38 - RecoveryInfo

Name	Description	Schema
source_object_path required	Source Object Path Example : `example_source_object_path/`	any of [string, null]
usage required	Usage Example : `1024`	any of [string, null]
total_object_count required	Total Object Count Example : `100`	any of [integer, null]
recovery_object_count required	Recovery Object Count Example : `50`	any of [integer, null]
recovery_rate required	Recovery Rate Example : `50`	any of [integer, null]

39 - Tag

Name	Description	Schema	Default
key required	Key Example : `key` Maximum length : `128`	string
value optional	Value Example : `value`	any of [string, null]