diff --git a/docs/cbr/api-ref/ALL_META.TXT.json b/docs/cbr/api-ref/ALL_META.TXT.json index c96ae1c64..5616e3167 100644 --- a/docs/cbr/api-ref/ALL_META.TXT.json +++ b/docs/cbr/api-ref/ALL_META.TXT.json @@ -50,7 +50,7 @@ "githuburl":"" }, { - "uri":"topic_300000002.html", + "uri":"topic_300000001.html", "product_code":"cbr", "code":"6", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -80,7 +80,7 @@ "githuburl":"" }, { - "uri":"topic_300000004.html", + "uri":"topic_300000002.html", "product_code":"cbr", "code":"9", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -140,7 +140,7 @@ "githuburl":"" }, { - "uri":"topic_300000005.html", + "uri":"topic_300000003.html", "product_code":"cbr", "code":"15", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -170,7 +170,7 @@ "githuburl":"" }, { - "uri":"topic_300000006.html", + "uri":"topic_300000004.html", "product_code":"cbr", "code":"18", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -270,7 +270,7 @@ "githuburl":"" }, { - "uri":"topic_300000007.html", + "uri":"topic_300000005.html", "product_code":"cbr", "code":"28", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -320,7 +320,7 @@ "githuburl":"" }, { - "uri":"topic_300000008.html", + "uri":"topic_300000006.html", "product_code":"cbr", "code":"33", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -380,7 +380,7 @@ "githuburl":"" }, { - "uri":"topic_300000011.html", + "uri":"topic_300000007.html", "product_code":"cbr", "code":"39", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", diff --git a/docs/cbr/api-ref/AddMember.html b/docs/cbr/api-ref/AddMember.html index 155e331e3..cb9b76061 100644 --- a/docs/cbr/api-ref/AddMember.html +++ b/docs/cbr/api-ref/AddMember.html @@ -3,7 +3,7 @@

Adding a Share Member

Function

This API is used to add a member with whom the backup can be shared. Only cloud server backups can be shared among tenants in the same region.

-

URI

POST /v3/{project_id}/backups/{backup_id}/members

+

URI

POST /v3/{project_id}/backups/{backup_id}/members

@@ -236,7 +236,7 @@
-
Parent topic: Backup Sharing
+
Parent topic: Backup Sharing
diff --git a/docs/cbr/api-ref/AddVaultResource.html b/docs/cbr/api-ref/AddVaultResource.html index 0b7203dd2..002d05d5e 100644 --- a/docs/cbr/api-ref/AddVaultResource.html +++ b/docs/cbr/api-ref/AddVaultResource.html @@ -3,7 +3,7 @@

Associating Resources

Function

This API is used to associate resources with a vault.

-

URI

POST /v3/{project_id}/vaults/{vault_id}/addresources

+

URI

POST /v3/{project_id}/vaults/{vault_id}/addresources

Table 1 Path Parameters

Parameter
@@ -219,7 +219,7 @@
-
Parent topic: Vaults
+
Parent topic: Vaults
diff --git a/docs/cbr/api-ref/AssociateVaultPolicy.html b/docs/cbr/api-ref/AssociateVaultPolicy.html index f2e42bd8a..3b12ca6f7 100644 --- a/docs/cbr/api-ref/AssociateVaultPolicy.html +++ b/docs/cbr/api-ref/AssociateVaultPolicy.html @@ -3,7 +3,7 @@

Applying a Policy to a Vault

Function

This API is used to apply a policy to a vault.

-

URI

POST /v3/{project_id}/vaults/{vault_id}/associatepolicy

+

URI

POST /v3/{project_id}/vaults/{vault_id}/associatepolicy

Table 1 Path Parameters

Parameter
@@ -167,7 +167,7 @@
-
Parent topic: Vaults
+
Parent topic: Vaults
diff --git a/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html b/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html index af211040e..bd8269cee 100644 --- a/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html +++ b/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html @@ -3,7 +3,7 @@

Batch Adding or Deleting Tags of a Vault

Function

This API is used to batch add or delete tags for a specified instance. TMS uses this API to manage service resource tags. A resource can have a maximum of 10 tags. This API is idempotent. If there are duplicate keys in the request body when you add tags, an error is reported. If a to-be-added tag has the same key as an existing tag, the tag will be added and overwrite the existing tag. When deleting tags, you can upload duplicate keys. When deleting tags, if some tags do not exist, the deletion is considered to be successful by default. The character set of the tags will not be verified. A key and a value can individually consist of up to 127 and 255 characters. When you delete tags, the tags structure cannot be missing, and the key cannot be left blank or be an empty string.

-

URI

POST /v3/{project_id}/vault/{vault_id}/tags/action

+

URI

POST /v3/{project_id}/vault/{vault_id}/tags/action

Table 1 Path Parameters

Parameter
@@ -190,7 +190,7 @@
-
Parent topic: Tags
+
Parent topic: Tags
diff --git a/docs/cbr/api-ref/CLASS.TXT.json b/docs/cbr/api-ref/CLASS.TXT.json index b06d572f9..215719136 100644 --- a/docs/cbr/api-ref/CLASS.TXT.json +++ b/docs/cbr/api-ref/CLASS.TXT.json @@ -48,7 +48,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cbr", "title":"Tasks", - "uri":"topic_300000002.html", + "uri":"topic_300000001.html", "doc_type":"api", "p_code":"2", "code":"6" @@ -75,7 +75,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cbr", "title":"Backup Sharing", - "uri":"topic_300000004.html", + "uri":"topic_300000002.html", "doc_type":"api", "p_code":"2", "code":"9" @@ -129,7 +129,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cbr", "title":"Restore Points", - "uri":"topic_300000005.html", + "uri":"topic_300000003.html", "doc_type":"api", "p_code":"2", "code":"15" @@ -156,7 +156,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cbr", "title":"Vaults", - "uri":"topic_300000006.html", + "uri":"topic_300000004.html", "doc_type":"api", "p_code":"2", "code":"18" @@ -246,7 +246,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cbr", "title":"Backups", - "uri":"topic_300000007.html", + "uri":"topic_300000005.html", "doc_type":"api", "p_code":"2", "code":"28" @@ -291,7 +291,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cbr", "title":"Policies", - "uri":"topic_300000008.html", + "uri":"topic_300000006.html", "doc_type":"api", "p_code":"2", "code":"33" @@ -345,7 +345,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cbr", "title":"Tags", - "uri":"topic_300000011.html", + "uri":"topic_300000007.html", "doc_type":"api", "p_code":"2", "code":"39" diff --git a/docs/cbr/api-ref/CreateCheckpoint.html b/docs/cbr/api-ref/CreateCheckpoint.html index 6d126b76b..4c38a3dd0 100644 --- a/docs/cbr/api-ref/CreateCheckpoint.html +++ b/docs/cbr/api-ref/CreateCheckpoint.html @@ -3,7 +3,7 @@

Creating a Restore Point

Function

This API is used to back up a vault and generate a restore point.

-

URI

POST /v3/{project_id}/checkpoints

+

URI

POST /v3/{project_id}/checkpoints

Table 1 Path Parameters

Parameter
@@ -600,7 +600,7 @@
-
Parent topic: Restore Points
+
Parent topic: Restore Points
diff --git a/docs/cbr/api-ref/CreatePolicy.html b/docs/cbr/api-ref/CreatePolicy.html index e84905171..a3c394353 100644 --- a/docs/cbr/api-ref/CreatePolicy.html +++ b/docs/cbr/api-ref/CreatePolicy.html @@ -3,7 +3,7 @@

Creating a Policy

Function

This API is used to create a backup policy.

-

URI

POST /v3/{project_id}/policies

+

URI

POST /v3/{project_id}/policies

Table 1 Path Parameters

Parameter
@@ -598,7 +598,7 @@
-
Parent topic: Policies
+
Parent topic: Policies
diff --git a/docs/cbr/api-ref/CreateVault.html b/docs/cbr/api-ref/CreateVault.html index b2cd6e401..e0085ba1d 100644 --- a/docs/cbr/api-ref/CreateVault.html +++ b/docs/cbr/api-ref/CreateVault.html @@ -3,7 +3,7 @@

Creating a Vault

Function

This API is used to create a vault.

-

URI

POST /v3/{project_id}/vaults

+

URI

POST /v3/{project_id}/vaults

Table 1 Path Parameters

Parameter
@@ -218,7 +218,7 @@ @@ -342,7 +342,7 @@
Table 1 Path Parameters

Parameter

Integer

Capacity, in GB

-

Minimum: 1

+

Minimum: 10

Maximum: 10485760
-
Table 8 VaultBindRules

Parameter

+
@@ -352,36 +352,13 @@ - - - - - - -
Table 8 Tag

Parameter

Mandatory

tags

+

key

No

+

Yes

Array of Tag objects

+

String

Filters automatically associated resources by tag.

-
-
- -
- - - - - - - - - - - - -
Table 9 Tag

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Key

+

Key

It can contain a maximum of 36 characters.

It cannot be an empty string.

Spaces before and after a key will be discarded.

@@ -389,13 +366,13 @@

It can contain only letters, digits, hyphens (-), and underscores (_).

value

+

value

No

+

No

String

+

String

Value

+

Value

It is mandatory when a tag is added and optional when a tag is deleted.

It can contain a maximum of 43 characters.

It can be an empty string.

@@ -407,10 +384,67 @@
+ +
+ + + + + + + + + + + +
Table 9 VaultBindRules

Parameter

+

Mandatory

+

Type

+

Description

+

tags

+

No

+

Array of BindRulesTags objects

+

Filters automatically associated resources by tag.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 10 BindRulesTags

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>\,|/

+

The key can contain only letters, digits, underscores (_), and hyphens (-).

+

value

+

No

+

String

+

The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

+

The value can contain only letters, digits, underscores (_), and hyphens (-).

+
+

Response Parameters

Status code: 200

-
Table 10 Response body parameters

Parameter

+
@@ -429,7 +463,7 @@
Table 11 Response body parameters

Parameter

Type

-
Table 11 VaultCreateResource

Parameter

+
@@ -536,7 +570,7 @@
Table 12 VaultCreateResource

Parameter

Type

-
Table 12 Billing

Parameter

+
@@ -655,7 +689,7 @@
Table 13 Billing

Parameter

Type

-
Table 13 ResourceResp

Parameter

+
@@ -732,7 +766,7 @@
Table 14 ResourceResp

Parameter

Type

-
Table 14 ResourceExtraInfo

Parameter

+
@@ -751,7 +785,7 @@
Table 15 ResourceExtraInfo

Parameter

Type

-
Table 15 VaultBindRules

Parameter

+
@@ -759,30 +793,11 @@ - - - - - -
Table 16 Tag

Parameter

Type

tags

+

key

Array of Tag objects

+

String

Filters automatically associated resources by tag.

-
-
- -
- - - - - - - - - -
Table 16 Tag

Parameter

-

Type

-

Description

-

key

-

String

-

Key

+

Key

It can contain a maximum of 36 characters.

It cannot be an empty string.

Spaces before and after a key will be discarded.

@@ -790,11 +805,11 @@

It can contain only letters, digits, hyphens (-), and underscores (_).

value

+

value

String

+

String

Value

+

Value

It is mandatory when a tag is added and optional when a tag is deleted.

It can contain a maximum of 43 characters.

It can be an empty string.

@@ -806,28 +821,75 @@
-

Status code: 400

-
Table 17 Response body parameters

Parameter

+
- - - - - - +
Table 17 VaultBindRules

Parameter

Type

+

Type

Description

+

Description

error_code

+

tags

String

+

Array of BindRulesTags objects

For details, see Error Codes.

+

Filters automatically associated resources by tag.

error_msg

+
+
+ +
+ + + + + - - + + + + + + +
Table 18 BindRulesTags

Parameter

+

Type

+

Description

+

key

String

+

String

Error message

+

The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>\,|/

+

The key can contain only letters, digits, underscores (_), and hyphens (-).

+

value

+

String

+

The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

+

The value can contain only letters, digits, underscores (_), and hyphens (-).

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + @@ -925,10 +987,7 @@ "protect_status" : "available", "backup_count" : 0, "extra_info" : { - "include_volumes" : [ { - "os_version" : "CentOS 7.6 64bit", - "id" : "73ee8446-bce7-4371-9650-b440b5f4c1d0" - } ] + "exclude_volumes" : [ "1855eb9a-2b5e-4938-a9f0-aea08b6f9243", "5a51e8b3-2f65-4045-896f-f8ffae14b064" ] }, "type" : "OS::Nova::Server", "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c", @@ -963,7 +1022,7 @@
-
Parent topic: Vaults
+
Parent topic: Vaults
diff --git a/docs/cbr/api-ref/CreateVaultTags.html b/docs/cbr/api-ref/CreateVaultTags.html index a7e138168..996534da4 100644 --- a/docs/cbr/api-ref/CreateVaultTags.html +++ b/docs/cbr/api-ref/CreateVaultTags.html @@ -3,7 +3,7 @@

Adding a Tag to an Associated Resource

Function

This API is used to add a tag to an associated resource. A resource can have a maximum of 10 tags. This API is idempotent. If a to-be-added tag has the same key as an existing tag, the tag will be added and overwrite the existing tag.

-

URI

POST /v3/{project_id}/vault/{vault_id}/tags

+

URI

POST /v3/{project_id}/vault/{vault_id}/tags

Table 19 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

For details, see Error Codes.

+

error_msg

+

String

+

Error message
@@ -170,7 +170,7 @@
-
Parent topic: Tags
+
Parent topic: Tags
diff --git a/docs/cbr/api-ref/DeleteBackup.html b/docs/cbr/api-ref/DeleteBackup.html index 9586589cd..4b6d19101 100644 --- a/docs/cbr/api-ref/DeleteBackup.html +++ b/docs/cbr/api-ref/DeleteBackup.html @@ -3,7 +3,7 @@

Deleting a Backup

Function

This API is used to delete a single backup.

-

URI

DELETE /v3/{project_id}/backups/{backup_id}

+

URI

DELETE /v3/{project_id}/backups/{backup_id}

Table 1 Path Parameters

Parameter
@@ -88,7 +88,7 @@
-
Parent topic: Backups
+
Parent topic: Backups
diff --git a/docs/cbr/api-ref/DeleteMember.html b/docs/cbr/api-ref/DeleteMember.html index c527f40b6..d03481a09 100644 --- a/docs/cbr/api-ref/DeleteMember.html +++ b/docs/cbr/api-ref/DeleteMember.html @@ -3,7 +3,7 @@

Deleting a Specified Share Member

Function

This API is used to delete a specified backup share member.

-

URI

DELETE /v3/{project_id}/backups/{backup_id}/members/{member_id}

+

URI

DELETE /v3/{project_id}/backups/{backup_id}/members/{member_id}

Table 1 Path Parameters

Parameter
@@ -97,7 +97,7 @@
-
Parent topic: Backup Sharing
+
Parent topic: Backup Sharing
diff --git a/docs/cbr/api-ref/DeletePolicy.html b/docs/cbr/api-ref/DeletePolicy.html index 7a87b0cf8..1ddec14d2 100644 --- a/docs/cbr/api-ref/DeletePolicy.html +++ b/docs/cbr/api-ref/DeletePolicy.html @@ -3,7 +3,7 @@

Deleting a Policy

Function

This API is used to delete a policy.

-

URI

DELETE /v3/{project_id}/policies/{policy_id}

+

URI

DELETE /v3/{project_id}/policies/{policy_id}

Table 1 Path Parameters

Parameter
@@ -88,7 +88,7 @@
-
Parent topic: Policies
+
Parent topic: Policies
diff --git a/docs/cbr/api-ref/DeleteVault.html b/docs/cbr/api-ref/DeleteVault.html index de1ec7f17..060182231 100644 --- a/docs/cbr/api-ref/DeleteVault.html +++ b/docs/cbr/api-ref/DeleteVault.html @@ -3,7 +3,7 @@

Deleting a Vault

Function

This API is used to delete vaults. Once a vault is deleted, all backups in the vault are cleared.

-

URI

DELETE /v3/{project_id}/vaults/{vault_id}

+

URI

DELETE /v3/{project_id}/vaults/{vault_id}

Table 1 Path Parameters

Parameter
@@ -88,7 +88,7 @@
-
Parent topic: Vaults
+
Parent topic: Vaults
diff --git a/docs/cbr/api-ref/DeleteVaultTag.html b/docs/cbr/api-ref/DeleteVaultTag.html index 39a3a1c2d..9a16ca755 100644 --- a/docs/cbr/api-ref/DeleteVaultTag.html +++ b/docs/cbr/api-ref/DeleteVaultTag.html @@ -3,7 +3,7 @@

Deleting a Tag from an Associated Resource

Function

This API is used to delete a tag from an associated resource. The API is idempotent. When you delete a nonexistent tag, error code 404 will be returned. Tag keys cannot be empty or be empty character strings.

-

URI

DELETE /v3/{project_id}/vault/{vault_id}/tags/{key}

+

URI

DELETE /v3/{project_id}/vault/{vault_id}/tags/{key}

Table 1 Path Parameters

Parameter
@@ -106,7 +106,7 @@
-
Parent topic: Tags
+
Parent topic: Tags
diff --git a/docs/cbr/api-ref/DisassociateVaultPolicy.html b/docs/cbr/api-ref/DisassociateVaultPolicy.html index e52b77475..22b68e3ed 100644 --- a/docs/cbr/api-ref/DisassociateVaultPolicy.html +++ b/docs/cbr/api-ref/DisassociateVaultPolicy.html @@ -3,7 +3,7 @@

Removing a Policy from a Vault

Function

This API is used to remove a policy from a vault.

-

URI

POST /v3/{project_id}/vaults/{vault_id}/dissociatepolicy

+

URI

POST /v3/{project_id}/vaults/{vault_id}/dissociatepolicy

Table 1 Path Parameters

Parameter
@@ -167,7 +167,7 @@
-
Parent topic: Vaults
+
Parent topic: Vaults
diff --git a/docs/cbr/api-ref/ListBackups.html b/docs/cbr/api-ref/ListBackups.html index 2ca8f75a6..ce4a1ecb9 100644 --- a/docs/cbr/api-ref/ListBackups.html +++ b/docs/cbr/api-ref/ListBackups.html @@ -1,601 +1,576 @@

Querying All Backups

-

Function

This API is used to query all backups.

+

Function

This API is used to query all backups.

-

URI

GET /v3/{project_id}/backups

+

URI

GET /v3/{project_id}/backups

-
Table 1 Path Parameters

Parameter
Table 1 Path Parameters

Parameter

+
- - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID
-
Table 2 Query Parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

checkpoint_id

+

checkpoint_id

No

+

No

String

+

String

Restore point ID

+

Restore point ID

dec

+

dec

No

+

No

Boolean

+

Boolean

Dedicated cloud

+

Dedicated cloud

end_time

+

end_time

No

+

No

String

+

String

Time when the backup ends, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, 2018-02-01T12:00:00Z.

+

Time when the backup ends, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, 2018-02-01T12:00:00Z.

image_type

+

image_type

No

+

No

String

+

String

Backup type, which is backup.

+

Backup type, which is backup.

limit

+

limit

No

+

No

Integer

+

Integer

Number of records displayed per page. The value must be a positive integer.

+

Number of records displayed per page. The value must be a positive integer.

marker

+

marker

No

+

No

String

+

String

ID of the last record displayed on the previous page

+

ID of the last record displayed on the previous page

member_status

+

member_status

No

+

No

String

+

String

Backup sharing status

-

Enumeration values:

-

  • pending

    -

  • accepted

    -

  • rejected

    -
+

Backup sharing status

+

Enumeration values:

+
  • pending
  • accepted
  • rejected

name

+

name

No

+

No

String

+

String

Backup name

+

Backup name

offset

+

offset

No

+

No

Integer

+

Integer

Offset value. The value must be a positive integer.

+

Offset value. The value must be a positive integer.

own_type

+

own_type

No

+

No

String

+

String

Owning type of a backup. private backups are queried by default.

-

Default: private

-

Enumeration values:

-

  • all_granted

    -

  • private

    -

  • shared

    -
+

Owning type of a backup. private backups are queried by default.

+

Default: private

+

Enumeration values:

+
  • all_granted
  • private
  • shared

parent_id

+

parent_id

No

+

No

String

+

String

Parent backup ID

+

Parent backup ID

resource_az

+

resource_az

No

+

No

String

+

String

AZ-based filtering is supported.

+

AZ-based filtering is supported.

resource_id

+

resource_id

No

+

No

String

+

String

Resource ID

+

Resource ID

resource_name

+

resource_name

No

+

No

String

+

String

Resource name

+

Resource name

resource_type

+

resource_type

No

+

No

String

+

String

Resource type, which can be OS::Nova::Server, OS::Cinder::Volume, or OS::Sfs::Turbo

+

Resource type, which can be OS::Nova::Server, OS::Cinder::Volume, or OS::Sfs::Turbo

sort

+

sort

No

+

No

String

+

String

A group of properties separated by commas (,) and sorting directions. The value format is [:],[:], where the value of direction is asc (in ascending order) or desc (in descending order). If the parameter direction is not specified, the default sorting direction is desc. The value of sort contains a maximum of 255 characters. The value range of key is as follows: [created_at, updated_at, name, status, protected_at, id]

+

A group of properties separated by commas (,) and sorting directions. The value format is <key1>[:<direction>],<key2>[:<direction>], where the value of direction is asc (in ascending order) or desc (in descending order). If the parameter direction is not specified, the default sorting direction is desc. The value of sort contains a maximum of 255 characters.The value range of key is as follows: [created_at, updated_at, name, status, protected_at, id]

start_time

+

start_time

No

+

No

String

+

String

Time when the backup starts, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, 2018-02-01T12:00:00Z.

+

Time when the backup starts, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, 2018-02-01T12:00:00Z.

status

+

status

No

+

No

String

+

String

Status When the API is called, multiple statuses can be transferred for filtering, for example, status=available&status=error.

-

Enumeration values:

-

  • available

    -

  • protecting

    -

  • deleting

    -

  • restoring

    -

  • error

    -

  • waiting_protect

    -

  • waiting_delete

    -

  • waiting_restore

    -
+

Status When the API is called, multiple statuses can be transferred for filtering, for example, status=available&status=error.

+

Enumeration values:

+
  • available
  • protecting
  • deleting
  • restoring
  • error
  • waiting_protect
  • waiting_delete
  • waiting_restore

used_percent

+

used_percent

No

+

No

String

+

String

Backups are filtered based on the occupied vault capacity. The value ranges from 1 to 100. For example, if used_percent is set to 80, all backups who occupied 80% or more of the vault capacity are displayed.

+

Backups are filtered based on the occupied vault capacity. The value ranges from 1 to 100. For example, if used_percent is set to 80, all backups who occupied 80% or more of the vault capacity are displayed.

vault_id

+

vault_id

No

+

No

String

+

String

Vault ID

+

Vault ID
-

Request Parameters

-
Table 3 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 3 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+

User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 4 Response body parameters

Parameter

+
- - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

backups

+

backups

Array of BackupResp objects

+

Array of BackupResp objects

Backup list

+

Backup list

count

+

count

Integer

+

Integer

Number of backups

+

Number of backups

offset

+

offset

Integer

+

Integer

Offset where the query starts

-

Minimum: 0

-

Default: 0

+

Offset where the query starts

+

Minimum: 0

+

Default: 0

limit

+

limit

Integer

+

Integer

Number of records displayed on each page

-

Minimum: 1

-

Maximum: 1000

-

Default: 1000

+

Number of records displayed on each page

+

Minimum: 1

+

Maximum: 1000

+

Default: 1000
-
Table 5 BackupResp

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 BackupResp

Parameter

Type

+

Type

Description

+

Description

checkpoint_id

+

checkpoint_id

String

+

String

Restore point ID

+

Restore point ID

created_at

+

created_at

String

+

String

Creation time, for example, 2020-02-05T10:38:34.209782

+

Creation time, for example, 2020-02-05T10:38:34.209782

description

+

description

String

+

String

Backup description

+

Backup description

expired_at

+

expired_at

String

+

String

Expiration time, for example, 2020-02-05T10:38:34.209782

+

Expiration time, for example, 2020-02-05T10:38:34.209782

extend_info

+

extend_info

BackupExtendInfo object

+

BackupExtendInfo object

Extended information

+

Extended information

id

+

id

String

+

String

Backup ID

+

Backup ID

image_type

+

image_type

String

+

String

Backup type, which is backup.

+

Backup type, which is backup.

name

+

name

String

+

String

Backup name

+

Backup name

parent_id

+

parent_id

String

+

String

Parent backup ID

+

Parent backup ID

project_id

+

project_id

String

+

String

Project ID

+

Project ID

protected_at

+

protected_at

String

+

String

Backup time

+

Backup time

resource_az

+

resource_az

String

+

String

Resource availability zone

+

Resource availability zone

resource_id

+

resource_id

String

+

String

Resource ID

+

Resource ID

resource_name

+

resource_name

String

+

String

Resource name

+

Resource name

resource_size

+

resource_size

Integer

+

Integer

Resource size, in GB

+

Resource size, in GB

resource_type

+

resource_type

String

+

String

Resource type, which can be OS::Nova::Server, OS::Cinder::Volume, or OS::Sfs::Turbo

+

Resource type, which can be OS::Nova::Server, OS::Cinder::Volume, or OS::Sfs::Turbo

status

+

status

String

+

String

Backup status

-

Enumeration values:

-

  • available

    -

  • protecting

    -

  • deleting

    -

  • restoring

    -

  • error

    -

  • waiting_protect

    -

  • waiting_delete

    -

  • waiting_restore

    -
+

Backup status

+

Enumeration values:

+
  • available
  • protecting
  • deleting
  • restoring
  • error
  • waiting_protect
  • waiting_delete
  • waiting_restore

updated_at

+

updated_at

String

+

String

Update time, for example, 2020-02-05T10:38:34.209782

+

Update time, for example, 2020-02-05T10:38:34.209782

vault_id

+

vault_id

String

+

String

Vault ID

+

Vault ID

provider_id

+

provider_id

String

+

String

Backup provider ID, which is used to distinguish backup objects. The value can be as follows:

-

0daac4c5-6707-4851-97ba-169e36266b66 indicates that backup objects are cloud servers; d1603440-187d-4516-af25-121250c7cc97 indicates that backup objects are cloud disks; 3f3c3220-245c-4805-b811-758870015881 indicates that backup objects are SFS Turbo file systems.

+

Backup provider ID, which is used to distinguish backup objects. The value can be as follows:

+

0daac4c5-6707-4851-97ba-169e36266b66 indicates that backup objects are cloud servers; d1603440-187d-4516-af25-121250c7cc97 indicates that backup objects are cloud disks; 3f3c3220-245c-4805-b811-758870015881 indicates that backup objects are SFS Turbo file systems.

children

+

children

Array of BackupResp objects

+

Array of BackupResp objects

Backup list

+

Backup list
-
Table 6 BackupExtendInfo

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 BackupExtendInfo

Parameter

Type

+

Type

Description

+

Description

auto_trigger

+

auto_trigger

Boolean

+

Boolean

Whether the backup is automatically generated

+

Whether the backup is automatically generated

bootable

+

bootable

Boolean

+

Boolean

Whether the backup is a system disk backup

+

Whether the backup is a system disk backup

incremental

+

incremental

Boolean

+

Boolean

Whether the backup is an incremental backup

+

Whether the backup is an incremental backup

snapshot_id

+

snapshot_id

String

+

String

Snapshot ID of the disk backup

+

Snapshot ID of the disk backup

support_lld

+

support_lld

Boolean

+

Boolean

Whether to allow lazyloading for fast restoration

+

Whether to allow lazyloading for fast restoration

supported_restore_mode

+

supported_restore_mode

String

+

String

Restoration mode. Possible values are na, snapshot, and backup. snapshot indicates the backup can be used to create a full-server image. backup indicates the data is restored from backups of the EVS disks of the server. na indicates the backup can only be used to create new resources but cannot be used for restoration.

-

Default: na

-

Enumeration values:

-

  • na

    -

  • backup

    -

  • snapshot

    -
+

Restoration mode. Possible values are na, snapshot, and backup. snapshot indicates the backup can be used to create a full-server image. backup indicates the data is restored from backups of the EVS disks of the server. na indicates the backup can only be used to create new resources but cannot be used for restoration.

+

Default: na

+

Enumeration values:

+
  • na
  • backup
  • snapshot

os_images_data

+

os_images_data

Array of ImageData objects

+

Array of ImageData objects

ID list of images created using backups

+

ID list of images created using backups

contain_system_disk

+

contain_system_disk

Boolean

+

Boolean

Whether the VM backup data contains system disk data

+

Whether the VM backup data contains system disk data

encrypted

+

encrypted

Boolean

+

Boolean

Whether the backup is encrypted

+

Whether the backup is encrypted

system_disk

+

system_disk

Boolean

+

Boolean

Whether the disk is a system disk

+

Whether the disk is a system disk
-
Table 7 ImageData

Parameter

+
- - - - -
Table 7 ImageData

Parameter

Type

+

Type

Description

+

Description

image_id

+

image_id

String

+

String

Image ID

+

Image ID
-

Example Requests

GET  https://{endpoint}/v3/{project_id}/backups
+

Example Requests

GET  https://{endpoint}/v3/{project_id}/backups
-

Example Responses

Status code: 200

-

OK

-
{
+
Example Responses
Status code: 200

+
OK

+
{
   "count" : 2,
   "backups" : [ {
     "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
@@ -653,28 +628,28 @@
   } ]
 }

 

-
Status Codes

-
Status Code

+
Status Codes

+

-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
OK

+
OK

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

 

-
Parent topic: Backups

+
Parent topic: Backups

 

 

 
diff --git a/docs/cbr/api-ref/ListOpLogs.html b/docs/cbr/api-ref/ListOpLogs.html
index e7fcc256f..a725424b3 100644
--- a/docs/cbr/api-ref/ListOpLogs.html
+++ b/docs/cbr/api-ref/ListOpLogs.html
@@ -3,7 +3,7 @@
 
Querying the Task List

 
Function
This API is used to query the task list.

 

-
URI
GET /v3/{project_id}/operation-logs

+
URI
GET /v3/{project_id}/operation-logs

 
 

@@ -1378,7 +1378,7 @@
 

 

-
Parent topic: Tasks

+
Parent topic: Tasks

 

 

 
diff --git a/docs/cbr/api-ref/ListPolicies.html b/docs/cbr/api-ref/ListPolicies.html
index cb3917bdf..b52e7fca3 100644
--- a/docs/cbr/api-ref/ListPolicies.html
+++ b/docs/cbr/api-ref/ListPolicies.html
@@ -3,7 +3,7 @@
 
Querying the Policy List
Function
This API is used to query the policy list.

 

-
URI
GET /v3/{project_id}/policies

+
URI
GET /v3/{project_id}/policies

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -401,7 +401,7 @@
 

 

-
Parent topic: Policies

+
Parent topic: Policies

 

 

 
diff --git a/docs/cbr/api-ref/ListVault.html b/docs/cbr/api-ref/ListVault.html
index 8e733d0c2..8d891359c 100644
--- a/docs/cbr/api-ref/ListVault.html
+++ b/docs/cbr/api-ref/ListVault.html
@@ -3,7 +3,7 @@
 
Querying the Vault List
Function
This API is used to query the vault list.

 

-
URI
GET /v3/{project_id}/vaults

+
URI
GET /v3/{project_id}/vaults

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -527,7 +527,7 @@
 
Table 1 Path Parameters
Parameter

 

 

 
-
Table 9 VaultBindRules
Parameter

+

@@ -535,30 +535,11 @@
 
-
-
-
-
-
-
Table 9 Tag
Parameter

 		
 
Type

 		
 

 
tags

+
key

 
Array of Tag objects

+
String

 
Filters automatically associated resources by tag.

-

-

-
-

-
-
-
-
-
-
-
-
-
-
Table 10 Tag
Parameter

-
Type

-
Description

-
key

-
String

-
Key

+
Key

 
It can contain a maximum of 36 characters.

 
It cannot be an empty string.

 
Spaces before and after a key will be discarded.

@@ -566,11 +547,11 @@
 
It can contain only letters, digits, hyphens (-), and underscores (_).

 		
 
value

+
value

 
String

+
String

 
Value

+
Value

 
It is mandatory when a tag is added and optional when a tag is deleted.

 
It can contain a maximum of 43 characters.

 
It can be an empty string.

@@ -582,6 +563,53 @@
 

 

 

+
+

+
+
+
+
+
+
+
+
+
+
Table 10 VaultBindRules
Parameter

+
Type

+
Description

+
tags

+
Array of BindRulesTags objects

+
Filters automatically associated resources by tag.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 11 BindRulesTags
Parameter

+
Type

+
Description

+
key

+
String

+
The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>\,|/

+
The key can contain only letters, digits, underscores (_), and hyphens (-).

+
value

+
String

+
The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

+
The value can contain only letters, digits, underscores (_), and hyphens (-).

+

+

 
 
Example Requests
GET  https://{endpoint}/v3/{project_id}/vaults

 

@@ -643,7 +671,7 @@
 
 

 

-
Parent topic: Vaults

+
Parent topic: Vaults

 

 

 
diff --git a/docs/cbr/api-ref/ListVersions.html b/docs/cbr/api-ref/ListVersions.html
index 5f196f3c1..0deb316e2 100644
--- a/docs/cbr/api-ref/ListVersions.html
+++ b/docs/cbr/api-ref/ListVersions.html
@@ -3,7 +3,7 @@
 
Querying API Versions

 
Function
This API is used to query the information of API versions.

 

-
URI
GET /

+
URI
GET /

 

 
Request Parameters
None

 

diff --git a/docs/cbr/api-ref/RemoveVaultResource.html b/docs/cbr/api-ref/RemoveVaultResource.html
index 9b4aea07f..33aa0ce10 100644
--- a/docs/cbr/api-ref/RemoveVaultResource.html
+++ b/docs/cbr/api-ref/RemoveVaultResource.html
@@ -3,7 +3,7 @@
 
Dissociating Resources

 
Function
This API is used to dissociate resources from a vault.

 

-
URI
POST /v3/{project_id}/vaults/{vault_id}/removeresources

+
URI
POST /v3/{project_id}/vaults/{vault_id}/removeresources

 
 

@@ -138,7 +138,7 @@
 

 

-
Parent topic: Vaults

+
Parent topic: Vaults

 

 

 
diff --git a/docs/cbr/api-ref/RestoreBackup.html b/docs/cbr/api-ref/RestoreBackup.html
index 189891252..baacf7067 100644
--- a/docs/cbr/api-ref/RestoreBackup.html
+++ b/docs/cbr/api-ref/RestoreBackup.html
@@ -3,7 +3,7 @@
 
Restoring a Backup
Function
This API is used to restore backup data.

 

-
URI
POST /v3/{project_id}/backups/{backup_id}/restore

+
URI
POST /v3/{project_id}/backups/{backup_id}/restore

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -205,7 +205,7 @@
 

 

-
Parent topic: Backups

+
Parent topic: Backups

 

 

 
diff --git a/docs/cbr/api-ref/ShowBackup.html b/docs/cbr/api-ref/ShowBackup.html
index 366709988..a8c5b9d99 100644
--- a/docs/cbr/api-ref/ShowBackup.html
+++ b/docs/cbr/api-ref/ShowBackup.html
@@ -3,7 +3,7 @@
 
Querying a Specified Backup
Function
This API is used to query the backup of a specific ID.

 

-
URI
GET /v3/{project_id}/backups/{backup_id}

+
URI
GET /v3/{project_id}/backups/{backup_id}

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -449,7 +449,7 @@
 

 

-
Parent topic: Backups

+
Parent topic: Backups

 

 

 
diff --git a/docs/cbr/api-ref/ShowCheckpoint.html b/docs/cbr/api-ref/ShowCheckpoint.html
index 23fac88a7..1a7489e3b 100644
--- a/docs/cbr/api-ref/ShowCheckpoint.html
+++ b/docs/cbr/api-ref/ShowCheckpoint.html
@@ -3,7 +3,7 @@
 
Querying a Restore Point
Function
This API is used to query a specified restore point based on its ID.

 

-
URI
GET /v3/{project_id}/checkpoints/{checkpoint_id}

+
URI
GET /v3/{project_id}/checkpoints/{checkpoint_id}

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -388,7 +388,7 @@
 

 

-
Parent topic: Restore Points

+
Parent topic: Restore Points

 

 

 
diff --git a/docs/cbr/api-ref/ShowMemberDetail.html b/docs/cbr/api-ref/ShowMemberDetail.html
index 0d99ec691..d89837592 100644
--- a/docs/cbr/api-ref/ShowMemberDetail.html
+++ b/docs/cbr/api-ref/ShowMemberDetail.html
@@ -3,7 +3,7 @@
 
Querying Share Member Details
Function
This API is used to obtain the details of a backup share member.

 

-
URI
GET /v3/{project_id}/backups/{backup_id}/members/{member_id}

+
URI
GET /v3/{project_id}/backups/{backup_id}/members/{member_id}

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -202,7 +202,7 @@
 

 

-
Parent topic: Backup Sharing

+
Parent topic: Backup Sharing

 

 

 
diff --git a/docs/cbr/api-ref/ShowMembersDetail.html b/docs/cbr/api-ref/ShowMembersDetail.html
index f82fd2ab9..be6a9f721 100644
--- a/docs/cbr/api-ref/ShowMembersDetail.html
+++ b/docs/cbr/api-ref/ShowMembersDetail.html
@@ -1,258 +1,255 @@
 
Obtaining the Share Member List

-
Function
This API is used to obtain the list of backup share members.

+
Function
This API is used to obtain the list of backup share members.

 

-
URI
GET /v3/{project_id}/backups/{backup_id}/members

+
URI
GET /v3/{project_id}/backups/{backup_id}/members

 
-
Table 1 Path Parameters
Parameter

 		
 
 
 
Table 1 Path Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
backup_id

+
backup_id

 
Yes

+
Yes

 
String

+
String

 
Backup ID

+
Backup ID

 		
 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID

+
Project ID

 		
 

 
 

 

 
-
Table 2 Query Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Query Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
dest_project_id

+
dest_project_id

 
No

+
No

 
String

+
String

 
ID of the project with which the backup is shared

+
ID of the project with which the backup is shared

 		
 
image_id

+
image_id

 
No

+
No

 
String

+
String

 
ID of the image created from the accepted backup

+
ID of the image created from the accepted backup

 		
 
limit

+
limit

 
No

+
No

 
Integer

+
Integer

 
Number of records displayed per page. The value must be a positive integer.

+
Number of records displayed per page. The value must be a positive integer.

 		
 
marker

+
marker

 
No

+
No

 
String

+
String

 
ID of the last record displayed on the previous page. Only UUID is supported.

+
ID of the last record displayed on the previous page. Only UUID is supported.

 		
 
offset

+
offset

 
No

+
No

 
Integer

+
Integer

 
Offset value, which is a positive integer.

+
Offset value, which is a positive integer.

 		
 
sort

+
sort

 
No

+
No

 
String

+
String

 
A group of properties separated by commas (,) and sorting directions. The value format is [:],[:], where the value of direction is asc (in ascending order) or desc (in descending order). If the parameter direction is not specified, the default sorting direction is desc. The value of sort contains a maximum of 255 characters.

+
A group of properties separated by commas (,) and sorting directions. The value format is <key1>[:<direction>],<key2>[:<direction>], where the value of direction is asc (in ascending order) or desc (in descending order). If the parameter direction is not specified, the default sorting direction is desc. The value of sort contains a maximum of 255 characters.

 		
 
status

+
status

 
No

+
No

 
String

+
String

 
Status of a shared backup

+
Status of a shared backup

 		
 
vault_id

+
vault_id

 
No

+
No

 
String

+
String

 
ID of the vault where the shared backup is stored. Only UUID is supported.

+
ID of the vault where the shared backup is stored. Only UUID is supported.

 		
 

 
 

 

 
-
Request Parameters

-
Table 3 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 3 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

+
User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

 		
 

 
 

 

 

-
Response Parameters
Status code: 200

+
Response Parameters
Status code: 200

 
-
Table 4 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 4 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
members

+
members

 
Array of Member objects

+
Array of Member objects

 
Response parameters of adding a backup share member

+
Response parameters of adding a backup share member

 		
 
count

+
count

 
Integer

+
Integer

 
Number of share members that the backup is shared to

+
Number of share members that the backup is shared to

 		
 

 
 

 

 
-
Table 5 Member
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 Member
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
status

+
status

 
String

+
String

 
Backup sharing status

-
Enumeration values:

-
  • pending
    
-
  • accepted
    
-
  • rejected
    
-

+
Backup sharing status

+
Enumeration values:

+
  • pending
  • accepted
  • rejected

 		
 
created_at

+
created_at

 
String

+
String

 
Backup sharing time, for example, 2020-02-05T10:38:34.209782

+
Backup sharing time, for example, 2020-02-05T10:38:34.209782

 		
 
updated_at

+
updated_at

 
String

+
String

 
Update time, for example, 2020-02-05T10:38:34.209782

+
Update time, for example, 2020-02-05T10:38:34.209782

 		
 
backup_id

+
backup_id

 
String

+
String

 
Backup ID

+
Backup ID

 		
 
image_id

+
image_id

 
String

+
String

 
ID of the image created by using the accepted shared backup

+
ID of the image created by using the accepted shared backup

 		
 
dest_project_id

+
dest_project_id

 
String

+
String

 
ID of the project with which the backup is shared

+
ID of the project with which the backup is shared

 		
 
vault_id

+
vault_id

 
String

+
String

 
ID of the vault where the shared backup is stored

+
ID of the vault where the shared backup is stored

 		
 
id

+
id

 
String

+
String

 
ID of the shared record

+
ID of the shared record

 		
 

 
 

 

 
-
Example Requests
GET  https://{endpoint}/v3/{project_id}/backups/{backup_id}/members

+
Example Requests
GET  https://{endpoint}/v3/{project_id}/backups/{backup_id}/members

 

-
Example Responses
Status code: 200

-
OK

-
{
+
Example Responses
Status code: 200

+
OK

+
{
   "members" : [ {
     "status" : "pending",
     "image_id" : null,
@@ -266,28 +263,28 @@
   "count" : 50
 }

 

-
Status Codes

-
Status Code

+
Status Codes

+

-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
OK

+
OK

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

 

-
Parent topic: Backup Sharing

+
Parent topic: Backup Sharing

 

 

 
diff --git a/docs/cbr/api-ref/ShowOpLog.html b/docs/cbr/api-ref/ShowOpLog.html
index f07408c40..26fc508e6 100644
--- a/docs/cbr/api-ref/ShowOpLog.html
+++ b/docs/cbr/api-ref/ShowOpLog.html
@@ -3,7 +3,7 @@
 
Querying a Single Task

 
Function
This API is used to query a task by task ID.

 

-
URI
GET /v3/{project_id}/operation-logs/{operation_log_id}

+
URI
GET /v3/{project_id}/operation-logs/{operation_log_id}

 
 

@@ -699,7 +699,7 @@
 

 

-
Parent topic: Tasks

+
Parent topic: Tasks

 

 

 
diff --git a/docs/cbr/api-ref/ShowPolicy.html b/docs/cbr/api-ref/ShowPolicy.html
index f2898a657..67ba0ebad 100644
--- a/docs/cbr/api-ref/ShowPolicy.html
+++ b/docs/cbr/api-ref/ShowPolicy.html
@@ -3,7 +3,7 @@
 
Querying a Single Policy
Function
This API is used to query a single policy.

 

-
URI
GET /v3/{project_id}/policies/{policy_id}

+
URI
GET /v3/{project_id}/policies/{policy_id}

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -367,7 +367,7 @@
 

 

-
Parent topic: Policies

+
Parent topic: Policies

 

 

 
diff --git a/docs/cbr/api-ref/ShowVault.html b/docs/cbr/api-ref/ShowVault.html
index 1052a4864..14857d8ec 100644
--- a/docs/cbr/api-ref/ShowVault.html
+++ b/docs/cbr/api-ref/ShowVault.html
@@ -3,7 +3,7 @@
 
Querying a Specified Vault
Function
This API is used to query a specified vault based on its ID.

 

-
URI
GET /v3/{project_id}/vaults/{vault_id}

+
URI
GET /v3/{project_id}/vaults/{vault_id}

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -404,7 +404,7 @@
 
Table 1 Path Parameters
Parameter

 

 

 
-
Table 8 VaultBindRules
Parameter

+

@@ -412,30 +412,11 @@
 
-
-
-
-
-
-
Table 8 Tag
Parameter

 		
 
Type

 		
 

 
tags

+
key

 
Array of Tag objects

+
String

 
Filters automatically associated resources by tag.

-

-

-
-

-
-
-
-
-
-
-
-
-
-
Table 9 Tag
Parameter

-
Type

-
Description

-
key

-
String

-
Key

+
Key

 
It can contain a maximum of 36 characters.

 
It cannot be an empty string.

 
Spaces before and after a key will be discarded.

@@ -443,11 +424,11 @@
 
It can contain only letters, digits, hyphens (-), and underscores (_).

 		
 
value

+
value

 
String

+
String

 
Value

+
Value

 
It is mandatory when a tag is added and optional when a tag is deleted.

 
It can contain a maximum of 43 characters.

 
It can be an empty string.

@@ -459,28 +440,56 @@
 

 

 

-
Status code: 404

 
-
Table 10 Response body parameters
Parameter

+

-
-
-
-
-
Table 9 VaultBindRules
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
vault

+
tags

 
Vault object

+
Array of BindRulesTags objects

 
Objects returned after the query by a vault

+
Filters automatically associated resources by tag.

 		
 

 
 

 

 
-
Table 11 Vault
Parameter

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 10 BindRulesTags
Parameter

+
Type

+
Description

+
key

+
String

+
The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>\,|/

+
The key can contain only letters, digits, underscores (_), and hyphens (-).

+
value

+
String

+
The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

+
The value can contain only letters, digits, underscores (_), and hyphens (-).

+

+

+
Status code: 404

+
+

@@ -488,106 +497,18 @@
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 11 Response body parameters
Parameter

 		
 
Type

 		
 

 
billing

+
vault

 
Billing object

+
Vault object

 
Operation info

-
description

-
String

-
User-defined vault description

-
Minimum: 0

-
Maximum: 255

-
id

-
String

-
Vault ID

-
name

-
String

-
Vault name

-
Minimum: 1

-
Maximum: 64

-
project_id

-
String

-
Project ID

-
provider_id

-
String

-
ID of the vault resource type

-
resources

-
Array of ResourceResp objects

-
Vault resources

-
tags

-
Array of Tag objects

-
Vault tags

-
auto_bind

-
Boolean

-
Indicates whether automatic association is enabled. Its default value is false (not enabled).

-
bind_rules

-
VaultBindRules object

-
Association rule

-
user_id

-
String

-
User ID

-
created_at

-
String

-
Creation time, for example, 2020-02-05T10:38:34.209782

-
auto_expand

-
Boolean

-
Whether to enable auto capacity expansion for the vault.

+
Objects returned after the query by a vault

 		
 

 
 

 

 
-
Table 12 Billing
Parameter

+

@@ -595,83 +516,190 @@
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
Table 12 Vault
Parameter

 		
 
Type

 		
 

 
allocated

+
billing

 
Integer

+
Billing object

 
Allocated capacity, in GB.

+
Operation info

 		
 
charging_mode

+
description

 		
 
String

 
Billing mode, which is post_paid

+
User-defined vault description

+
Minimum: 0

+
Maximum: 255

 		
 
cloud_type

+
id

 		
 
String

 
Cloud type, which is public

+
Vault ID

 		
 
consistent_level

+
name

 		
 
String

 
Vault specification, which is crash_consistent by default (crash consistent backup)

+
Vault name

+
Minimum: 1

+
Maximum: 64

 		
 
object_type

+
project_id

 		
 
String

 
Object type, which can be server, disk, or turbo

+
Project ID

 		
 
order_id

+
provider_id

 		
 
String

 
Order ID

+
ID of the vault resource type

 		
 
product_id

+
resources

+
Array of ResourceResp objects

+
Vault resources

+
tags

+
Array of Tag objects

+
Vault tags

+
auto_bind

+
Boolean

+
Indicates whether automatic association is enabled. Its default value is false (not enabled).

+
bind_rules

+
VaultBindRules object

+
Association rule

+
user_id

 		
 
String

 
Product ID

+
User ID

 		
 
protect_type

+
created_at

 		
 
String

 
Protection type, which is backup

+
Creation time, for example, 2020-02-05T10:38:34.209782

 		
 
size

+
auto_expand

 
Integer

+
Boolean

 
Capacity, in GB

+
Whether to enable auto capacity expansion for the vault.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 13 Billing
Parameter

+
Type

+
Description

+
allocated

+
Integer

+
Allocated capacity, in GB.

+
charging_mode

+
String

+
Billing mode, which is post_paid

+
cloud_type

+
String

+
Cloud type, which is public

+
consistent_level

+
String

+
Vault specification, which is crash_consistent by default (crash consistent backup)

+
object_type

+
String

+
Object type, which can be server, disk, or turbo

+
order_id

+
String

+
Order ID

+
product_id

+
String

+
Product ID

+
protect_type

+
String

+
Protection type, which is backup

+
size

+
Integer

+
Capacity, in GB

 
Minimum: 1

 
Maximum: 10485760

 		
 
spec_code

+
spec_code

 
String

+
String

 
Specification code Server backup vault: vault.backup.server.normal; Disk backup vault: vault.backup.volume.normal; File system backup vault: vault.backup.turbo.normal

+
Specification code Server backup vault: vault.backup.server.normal; Disk backup vault: vault.backup.volume.normal; File system backup vault: vault.backup.turbo.normal

 		
 
status

+
status

 
String

+
String

 
Vault status

+
Vault status

 
Enumeration values:

 
  • available
    
 
  • lock
    
@@ -681,67 +709,67 @@
 

 		
 
storage_unit

+
storage_unit

 
String

+
String

 
Name of the bucket for the vault

+
Name of the bucket for the vault

 		
 
used

+
used

 
Integer

+
Integer

 
Used capacity, in MB.

+
Used capacity, in MB.

 		
 
frozen_scene

+
frozen_scene

 
String

+
String

 
Scenario when an account is frozen

+
Scenario when an account is frozen

 		
 

 
 

 

 
-
Table 13 ResourceResp
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 14 ResourceResp
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
extra_info

+
extra_info

 
ResourceExtraInfo object

+
ResourceExtraInfo object

 
Additional information of the resource

+
Additional information of the resource

 		
 
id

+
id

 
String

+
String

 
ID of the resource to be backed up

+
ID of the resource to be backed up

 		
 
name

+
name

 
String

+
String

 
Name of the resource to be backed up

+
Name of the resource to be backed up

 
Minimum: 0

 
Maximum: 255

 		
 
protect_status

+
protect_status

 
String

+
String

 
Protection status

+
Protection status

 
Enumeration values:

 
  • available
    
 
  • error
    
@@ -751,58 +779,39 @@
 

 		
 
size

+
size

 
Integer

+
Integer

 
Allocated capacity for the associated resources, in GB

+
Allocated capacity for the associated resources, in GB

 		
 
type

+
type

 
String

+
String

 
Type of the resource to be backed up, which can be OS::Nova::Server, OS::Cinder::Volume, or OS::Sfs::Turbo

+
Type of the resource to be backed up, which can be OS::Nova::Server, OS::Cinder::Volume, or OS::Sfs::Turbo

 		
 
backup_size

+
backup_size

 
Integer

+
Integer

 
Backup size

+
Backup size

 		
 
backup_count

+
backup_count

 
Integer

+
Integer

 
Number of backups

+
Number of backups

 		
 

 
 

 

 
-

-
-
-
-
-
-
-
-
-
-
Table 14 ResourceExtraInfo
Parameter

-
Type

-
Description

-
exclude_volumes

-
Array of strings

-
IDs of the disks that will not be backed up. This parameter is used when servers are added to a vault, which include all server disks. But some disks do not need to be backed up. Or in case that a server was previously added and some disks on this server do not need to be backed up.

-

-

-
-
Table 15 VaultBindRules
Parameter

+

@@ -810,11 +819,11 @@
 
-
-
-
@@ -857,6 +866,53 @@
 
Table 15 ResourceExtraInfo
Parameter

 		
 
Type

 		
 

 
tags

+
exclude_volumes

 
Array of Tag objects

+
Array of strings

 
Filters automatically associated resources by tag.

+
IDs of the disks that will not be backed up. This parameter is used when servers are added to a vault, which include all server disks. But some disks do not need to be backed up. Or in case that a server was previously added and some disks on this server do not need to be backed up.

 		
 

 
 

 

+
+

+
+
+
+
+
+
+
+
+
+
Table 17 VaultBindRules
Parameter

+
Type

+
Description

+
tags

+
Array of BindRulesTags objects

+
Filters automatically associated resources by tag.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 18 BindRulesTags
Parameter

+
Type

+
Description

+
key

+
String

+
The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>\,|/

+
The key can contain only letters, digits, underscores (_), and hyphens (-).

+
value

+
String

+
The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

+
The value can contain only letters, digits, underscores (_), and hyphens (-).

+

+

 
 
Example Requests
GET  https://{endpoint}/v3/{project_id}/vaults/{vault_id}

 

@@ -925,7 +981,7 @@
 
 

 

-
Parent topic: Vaults

+
Parent topic: Vaults

 

 

 
diff --git a/docs/cbr/api-ref/ShowVaultProjectTag.html b/docs/cbr/api-ref/ShowVaultProjectTag.html
index 7ba0f09c8..0c19d6ef4 100644
--- a/docs/cbr/api-ref/ShowVaultProjectTag.html
+++ b/docs/cbr/api-ref/ShowVaultProjectTag.html
@@ -3,7 +3,7 @@
 
Querying Tags of a Vault Project

 
Function
This API is used to query a tenant's tag set in a specific region and of a specific instance type. TMS uses this API to list tags created by a tenant to facilitate tag creation and resource filtering on the console.

 

-
URI
GET /v3/{project_id}/vault/tags

+
URI
GET /v3/{project_id}/vault/tags

 
 

@@ -150,7 +150,7 @@
 

 

-
Parent topic: Tags

+
Parent topic: Tags

 

 

 
diff --git a/docs/cbr/api-ref/ShowVaultResourceInstances.html b/docs/cbr/api-ref/ShowVaultResourceInstances.html
index 81ceafb63..a97a47e17 100644
--- a/docs/cbr/api-ref/ShowVaultResourceInstances.html
+++ b/docs/cbr/api-ref/ShowVaultResourceInstances.html
@@ -3,7 +3,7 @@
 
Querying Vault Resources
Function
This API is used to filter resources by tag. Tag Management Service (TMS) uses this API to filter and list resources of each service by tag. These services must have the query capabilities.

 

-
URI
POST /v3/{project_id}/vault/resource_instances/action

+
URI
POST /v3/{project_id}/vault/resource_instances/action

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -137,9 +137,9 @@
 
-
-
@@ -655,7 +655,7 @@
 
Table 1 Path Parameters
Parameter

 		
 
Array of Match objects

 
List of query criteria supported by resources

-
This list cannot be an empty list.

+
Search criteria supported by resources

 
Keys in this list must be unique.

+
Only one key is supported currently. Multiple-key support will be available later.

 		
 

 
cloud_type

@@ -646,7 +646,7 @@
 

 
tags

 
Array of Tag objects

+
Array of BindRulesTags objects

 		
 
Filters automatically associated resources by tag.

 

 

 
-
Table 12 Tag
Parameter

+

@@ -667,7 +667,35 @@
 
-
+
+
+
+
+
+
+
Table 12 BindRulesTags
Parameter

 		
 
Type

 		
 
String

 
Key

+
The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>\,|/

+
The key can contain only letters, digits, underscores (_), and hyphens (-).

+
value

+
String

+
The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

+
The value can contain only letters, digits, underscores (_), and hyphens (-).

+

+

+
+

+
+
+
+
+
+
+
-
-
-
Table 13 Tag
Parameter

+
Type

+
Description

+
key

+
String

+
Key

 
It can contain a maximum of 36 characters.

 
It cannot be an empty string.

 
Spaces before and after a key will be discarded.

@@ -675,11 +703,11 @@
 
It can contain only letters, digits, hyphens (-), and underscores (_).

 		
 
value

+
value

 
String

+
String

 
Value

+
Value

 
It is mandatory when a tag is added and optional when a tag is deleted.

 
It can contain a maximum of 43 characters.

 
It can be an empty string.

@@ -693,26 +721,26 @@
 
 
Status code: 400

 
-
Table 13 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
@@ -764,7 +792,7 @@
 

 

-
Parent topic: Tags

+
Parent topic: Tags

 

 

 
diff --git a/docs/cbr/api-ref/ShowVaultTag.html b/docs/cbr/api-ref/ShowVaultTag.html
index f46a81674..08d684600 100644
--- a/docs/cbr/api-ref/ShowVaultTag.html
+++ b/docs/cbr/api-ref/ShowVaultTag.html
@@ -3,7 +3,7 @@
 
Querying Tags of an Associated Resource
Function
This API is used to query tags of a specified resource. TMS uses this API to query all tags of a specified resource.

 

-
URI
GET /v3/{project_id}/vault/{vault_id}/tags

+
URI
GET /v3/{project_id}/vault/{vault_id}/tags

 
 
Table 14 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
For details, see Error Codes.

+
For details, see Error Codes.

 		
 
error_msg

+
error_msg

 
String

+
String

 
Error message

+
Error message

 		
 

 
 
 

@@ -167,7 +167,7 @@
 

 

-
Parent topic: Tags

+
Parent topic: Tags

 

 

 
diff --git a/docs/cbr/api-ref/ShowVersion.html b/docs/cbr/api-ref/ShowVersion.html
index 4d39a044d..9e5e2c3be 100644
--- a/docs/cbr/api-ref/ShowVersion.html
+++ b/docs/cbr/api-ref/ShowVersion.html
@@ -3,7 +3,7 @@
 
Querying a Specified API Version
Function
This API is used to query the information of a specified API version.

 

-
URI
GET /{api_version}

+
URI
GET /{api_version}

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -21,10 +21,9 @@
 
-
diff --git a/docs/cbr/api-ref/UpdateMemberStatus.html b/docs/cbr/api-ref/UpdateMemberStatus.html
index c08f065d1..fa8461e10 100644
--- a/docs/cbr/api-ref/UpdateMemberStatus.html
+++ b/docs/cbr/api-ref/UpdateMemberStatus.html
@@ -3,7 +3,7 @@
 
Updating the Share Member Status
Function
This API is used to update the status of a backup share member.

 

-
URI
PUT /v3/{project_id}/backups/{backup_id}/members/{member_id}

+
URI
PUT /v3/{project_id}/backups/{backup_id}/members/{member_id}

 
 
Table 1 Path Parameters
Parameter

 		
 
String

 
API version to be queried The value is v3.

-
Enumeration values:

-
  • v3
    
-

+
API version (cloud service) to be queried. The value can be vbs, csbs, or cbr.

+
Minimum: 3

+
Maximum: 4

 		
 

 
 

@@ -244,7 +244,7 @@
 

 

-
Parent topic: Backup Sharing

+
Parent topic: Backup Sharing

 

 

 
diff --git a/docs/cbr/api-ref/UpdatePolicy.html b/docs/cbr/api-ref/UpdatePolicy.html
index 21c02027f..fc0b40e0e 100644
--- a/docs/cbr/api-ref/UpdatePolicy.html
+++ b/docs/cbr/api-ref/UpdatePolicy.html
@@ -3,7 +3,7 @@
 
Modifying a Policy
Function
This API is used to modify a policy.

 

-
URI
PUT /v3/{project_id}/policies/{policy_id}

+
URI
PUT /v3/{project_id}/policies/{policy_id}

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -597,7 +597,7 @@
 

 

-
Parent topic: Policies

+
Parent topic: Policies

 

 

 
diff --git a/docs/cbr/api-ref/UpdateVault.html b/docs/cbr/api-ref/UpdateVault.html
index f9e2af9bb..f8049553b 100644
--- a/docs/cbr/api-ref/UpdateVault.html
+++ b/docs/cbr/api-ref/UpdateVault.html
@@ -3,7 +3,7 @@
 
Modifying a Vault
Function
This API is used to modify a vault based on its ID.

 

-
URI
PUT /v3/{project_id}/vaults/{vault_id}

+
URI
PUT /v3/{project_id}/vaults/{vault_id}

 
 
Table 1 Path Parameters
Parameter

 		
 
 

@@ -206,7 +206,7 @@
 
-
@@ -215,7 +215,7 @@
 
Table 1 Path Parameters
Parameter

 		
 
No

 
Array of Tag objects

+
Array of BindRulesTags objects

 		
 
Filters automatically associated resources by tag.

 

 

 
-
Table 7 Tag
Parameter

+

@@ -231,12 +231,8 @@
 
-
-
@@ -601,7 +592,7 @@
 
Table 7 BindRulesTags
Parameter

 		
 
Mandatory

 		
 
String

 
Key

-
It can contain a maximum of 36 characters.

-
It cannot be an empty string.

-
Spaces before and after a key will be discarded.

-
It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (|), and slashes (/)

-
It can contain only letters, digits, hyphens (-), and underscores (_).

+
The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>\,|/

+
The key can contain only letters, digits, underscores (_), and hyphens (-).

 		
 

 
value

@@ -245,13 +241,8 @@
 		
 
String

 
Value

-
It is mandatory when a tag is added and optional when a tag is deleted.

-
It can contain a maximum of 43 characters.

-
It can be an empty string.

-
Spaces before and after a value will be discarded.

-
It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (|), and slashes (/)

-
It can contain only letters, digits, hyphens (-), and underscores (_).

+
The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

+
The value can contain only letters, digits, underscores (_), and hyphens (-).

 		
 

 

 

 
-

-
+
+
+
Table 13 VaultBindRules
Parameter

+

@@ -609,30 +600,11 @@
 
-
-
-
-
-
-
Table 13 Tag
Parameter

 		
 
Type

 		
 

 
tags

+
key

 
Array of Tag objects

+
String

 
Filters automatically associated resources by tag.

-

-

-
-

-
-
-
-
-
-
-
-
-
-
Table 14 Tag
Parameter

-
Type

-
Description

-
key

-
String

-
Key

+
Key

 
It can contain a maximum of 36 characters.

 
It cannot be an empty string.

 
Spaces before and after a key will be discarded.

@@ -640,11 +612,11 @@
 
It can contain only letters, digits, hyphens (-), and underscores (_).

 		
 
value

+
value

 
String

+
String

 
Value

+
Value

 
It is mandatory when a tag is added and optional when a tag is deleted.

 
It can contain a maximum of 43 characters.

 
It can be an empty string.

@@ -656,6 +628,53 @@
 

 

 

+
+

+
+
+
+
+
+
+
+
+
+
Table 14 VaultBindRules
Parameter

+
Type

+
Description

+
tags

+
Array of BindRulesTags objects

+
Filters automatically associated resources by tag.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 15 BindRulesTags
Parameter

+
Type

+
Description

+
key

+
String

+
The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>\,|/

+
The key can contain only letters, digits, underscores (_), and hyphens (-).

+
value

+
String

+
The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

+
The value can contain only letters, digits, underscores (_), and hyphens (-).

+

+

 
 
Example Requests
PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d
 
@@ -731,7 +750,7 @@
 

 

 

-
Parent topic: Vaults

+
Parent topic: Vaults

 

 

 
diff --git a/docs/cbr/api-ref/cbr_04_0015.html b/docs/cbr/api-ref/cbr_04_0015.html
index c423010d3..e4de2eb8b 100644
--- a/docs/cbr/api-ref/cbr_04_0015.html
+++ b/docs/cbr/api-ref/cbr_04_0015.html
@@ -7,19 +7,19 @@
 
 
diff --git a/docs/cbr/api-ref/cbr_04_0025.html b/docs/cbr/api-ref/cbr_04_0025.html
index 6c793a16c..dd95d363d 100644
--- a/docs/cbr/api-ref/cbr_04_0025.html
+++ b/docs/cbr/api-ref/cbr_04_0025.html
@@ -8,7 +8,13 @@
 		
 

 
2022-12-02

+
2023-03-21

+
Updated the following content:

+
  • Modified the issue that response parameters in the table are inconsistent with those in the example response in section "Creating a Vault."
  • Modified the rules defined by bind_rules for vault APIs.
  • Modified parameter restrictions in section "Querying Vault Resources."
  • Modified the vault's minimum capacity in section "Creating a Vault."
  • Modified the description of api_version in section "Querying a Specified API Version."

+
2022-12-02

 		
 
Updated the following content:

 
Added section "Permissions and Supported Actions."

diff --git a/docs/cbr/api-ref/topic_300000001.html b/docs/cbr/api-ref/topic_300000001.html
new file mode 100644
index 000000000..527c87efa
--- /dev/null
+++ b/docs/cbr/api-ref/topic_300000001.html
@@ -0,0 +1,18 @@
+
+
+
Tasks

+
    

+

+

+
+
+

+
Parent topic: CBR APIs

+

+

+
diff --git a/docs/cbr/api-ref/topic_300000002.html b/docs/cbr/api-ref/topic_300000002.html
index 54fbb573b..43ec420b1 100644
--- a/docs/cbr/api-ref/topic_300000002.html
+++ b/docs/cbr/api-ref/topic_300000002.html
@@ -1,13 +1,19 @@
 
 
-
Tasks

+
Backup Sharing

 
    

 

 

 
 
diff --git a/docs/cbr/api-ref/topic_300000003.html b/docs/cbr/api-ref/topic_300000003.html
new file mode 100644
index 000000000..71440f2fc
--- /dev/null
+++ b/docs/cbr/api-ref/topic_300000003.html
@@ -0,0 +1,18 @@
+
+
+
Restore Points

+
    

+

+
+
diff --git a/docs/cbr/api-ref/topic_300000004.html b/docs/cbr/api-ref/topic_300000004.html
index 54c729bc6..68bad0762 100644
--- a/docs/cbr/api-ref/topic_300000004.html
+++ b/docs/cbr/api-ref/topic_300000004.html
@@ -1,19 +1,27 @@
 
 
-
Backup Sharing

+
Vaults

 
    

 

 

 
 
diff --git a/docs/cbr/api-ref/topic_300000005.html b/docs/cbr/api-ref/topic_300000005.html
index 43afe461e..9910f828d 100644
--- a/docs/cbr/api-ref/topic_300000005.html
+++ b/docs/cbr/api-ref/topic_300000005.html
@@ -1,13 +1,17 @@
 
 
-
Restore Points

+
Backups

 
    

 

 

 
 
diff --git a/docs/cbr/api-ref/topic_300000006.html b/docs/cbr/api-ref/topic_300000006.html
index a36befcb8..ceb1142df 100644
--- a/docs/cbr/api-ref/topic_300000006.html
+++ b/docs/cbr/api-ref/topic_300000006.html
@@ -1,27 +1,19 @@
 
 
-
Vaults

+
Policies

 
    

 

 

 
 
diff --git a/docs/cbr/api-ref/topic_300000007.html b/docs/cbr/api-ref/topic_300000007.html
index 91f57d8a9..66a20ad14 100644
--- a/docs/cbr/api-ref/topic_300000007.html
+++ b/docs/cbr/api-ref/topic_300000007.html
@@ -1,17 +1,21 @@
 
 
-
Backups

+
Tags

 
    

 

 

 
 
diff --git a/docs/cbr/api-ref/topic_300000008.html b/docs/cbr/api-ref/topic_300000008.html
deleted file mode 100644
index a4d501231..000000000
--- a/docs/cbr/api-ref/topic_300000008.html
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-
Policies

-
    

-

-
-
diff --git a/docs/cbr/api-ref/topic_300000011.html b/docs/cbr/api-ref/topic_300000011.html
deleted file mode 100644
index bd5d4509f..000000000
--- a/docs/cbr/api-ref/topic_300000011.html
+++ /dev/null
@@ -1,26 +0,0 @@
-
-
-
Tags

-
    

-

-
-