From e98ae60365e0955ad7b5f29cd6f3dbafeb894124 Mon Sep 17 00:00:00 2001 From: "Zaoxu, Li" Date: Thu, 12 Sep 2024 08:27:22 +0000 Subject: [PATCH] cbr_api0124 Added CBR actions Reviewed-by: Muller, Martin Co-authored-by: Zaoxu, Li Co-committed-by: Zaoxu, Li --- docs/cbr/api-ref/CreatePolicy.html | 487 ++++++++++++++--------------- docs/cbr/api-ref/UpdatePolicy.html | 487 ++++++++++++++--------------- docs/cbr/api-ref/cbr_04_0001.html | 2 +- docs/cbr/api-ref/cbr_04_0018.html | 335 ++++++++++---------- docs/cbr/api-ref/cbr_04_0025.html | 14 +- 5 files changed, 655 insertions(+), 670 deletions(-) diff --git a/docs/cbr/api-ref/CreatePolicy.html b/docs/cbr/api-ref/CreatePolicy.html index 312d4de1..87e01f86 100644 --- a/docs/cbr/api-ref/CreatePolicy.html +++ b/docs/cbr/api-ref/CreatePolicy.html @@ -1,564 +1,561 @@

Creating a Policy

-

Function

This API is used to create a backup 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

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID
-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 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.
-
Table 3 Request body parameters

Parameter

+
- - - - - - -
Table 3 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

policy

+

policy

Yes

+

Yes

PolicyCreate object

+

PolicyCreate object

Request body for creating a policy

+

Request body for creating a policy
-
Table 4 PolicyCreate

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 4 PolicyCreate

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

enabled

+

enabled

No

+

No

Boolean

+

Boolean

Whether to enable the policy

-

Default: true

+

Whether to enable the policy

+

Default: true

name

+

name

Yes

+

Yes

String

+

String

Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).

-

Minimum: 1

-

Maximum: 64

+

Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).

+

Minimum: 1

+

Maximum: 64

operation_definition

+

operation_definition

Yes

+

Yes

PolicyoODCreate object

+

PolicyoODCreate object

Scheduling parameter

+

Scheduling parameter

operation_type

+

operation_type

Yes

+

Yes

String

+

String

Protection type, which can be backup or replication

+

Protection type, which can be backup or replication

trigger

+

trigger

Yes

+

Yes

PolicyTriggerReq object

+

PolicyTriggerReq object

Time rule for the policy execution

+

Time rule for the policy execution
-
Table 5 PolicyoODCreate

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 PolicyoODCreate

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

day_backups

+

day_backups

No

+

No

Integer

+

Integer

Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-

Minimum: 0

-

Maximum: 100

+

Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be configured at the same time.

+

Minimum: 0

+

Maximum: 100

destination_project_id

+

destination_project_id

No

+

No

String

+

String

ID of the replication destination project, which is mandatory for cross-region replication

+

ID of the replication destination project, which is mandatory for cross-region replication

destination_region

+

destination_region

No

+

No

String

+

String

ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

+

ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

max_backups

+

max_backups

No

+

No

Integer

+

Integer

Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently. This parameter and retention_duration_days cannot be configured at the same time.

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

month_backups

+

month_backups

No

+

No

Integer

+

Integer

Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-

Minimum: 0

-

Maximum: 100

+

Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be configured at the same time.

+

Minimum: 0

+

Maximum: 100

retention_duration_days

+

retention_duration_days

No

+

No

Integer

+

Integer

Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently. This parameter cannot be configured if max_backups, day_backups, week_backups, month_backups, or year_backups is configured.

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

timezone

+

timezone

No

+

No

String

+

String

Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

+

Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

week_backups

+

week_backups

No

+

No

Integer

+

Integer

Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+

Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be configured at the same time.

year_backups

+

year_backups

No

+

No

Integer

+

Integer

Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-

Minimum: 0

-

Maximum: 100

+

Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be configured at the same time.

+

Minimum: 0

+

Maximum: 100
-
Table 6 PolicyTriggerReq

Parameter

+
- - - - - - -
Table 6 PolicyTriggerReq

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

properties

+

properties

Yes

+

Yes

PolicyTriggerPropertiesReq object

+

PolicyTriggerPropertiesReq object

Scheduler attributes

+

Scheduler attributes
-
Table 7 PolicyTriggerPropertiesReq

Parameter

+
- - - - - - -
Table 7 PolicyTriggerPropertiesReq

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

pattern

+

pattern

Yes

+

Yes

Array of strings

+

Array of strings

Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

+

Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00
-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 8 Response body parameters

Parameter

+
- - - - -
Table 8 Response body parameters

Parameter

Type

+

Type

Description

+

Description

policy

+

policy

Policy object

+

Policy object

Response to the request for creating a policy

+

Response to the request for creating a policy
-
Table 9 Policy

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 9 Policy

Parameter

Type

+

Type

Description

+

Description

enabled

+

enabled

Boolean

+

Boolean

Whether the policy is enabled

+

Whether the policy is enabled

id

+

id

String

+

String

Policy ID

+

Policy ID

name

+

name

String

+

String

Policy Name

+

Policy Name

operation_definition

+

operation_definition

PolicyoODCreate object

+

PolicyoODCreate object

Policy attributes

+

Policy attributes

operation_type

+

operation_type

String

+

String

Protection type, which can be backup or replication

-

Enumeration values:

-

  • backup

    -

  • replication

    -
+

Protection type, which can be backup or replication

+

Enumeration values:

+
  • backup
  • replication

trigger

+

trigger

PolicyTriggerResp object

+

PolicyTriggerResp object

Time scheduling rule for the policy

+

Time scheduling rule for the policy

associated_vaults

+

associated_vaults

Array of PolicyAssociateVault objects

+

Array of PolicyAssociateVault objects

Associated vault

+

Associated vault
-
Table 10 PolicyoODCreate

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 PolicyoODCreate

Parameter

Type

+

Type

Description

+

Description

day_backups

+

day_backups

Integer

+

Integer

Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-

Minimum: 0

-

Maximum: 100

+

Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+

Minimum: 0

+

Maximum: 100

destination_project_id

+

destination_project_id

String

+

String

ID of the replication destination project, which is mandatory for cross-region replication

+

ID of the replication destination project, which is mandatory for cross-region replication

destination_region

+

destination_region

String

+

String

ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

+

ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

max_backups

+

max_backups

Integer

+

Integer

Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

month_backups

+

month_backups

Integer

+

Integer

Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-

Minimum: 0

-

Maximum: 100

+

Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+

Minimum: 0

+

Maximum: 100

retention_duration_days

+

retention_duration_days

Integer

+

Integer

Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

timezone

+

timezone

String

+

String

Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

+

Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

week_backups

+

week_backups

Integer

+

Integer

Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+

Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

year_backups

+

year_backups

Integer

+

Integer

Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-

Minimum: 0

-

Maximum: 100

+

Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+

Minimum: 0

+

Maximum: 100
-
Table 11 PolicyTriggerResp

Parameter

+
- - - - - - - - - - - - - -
Table 11 PolicyTriggerResp

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Scheduler ID

+

Scheduler ID

name

+

name

String

+

String

Scheduler name

+

Scheduler name

properties

+

properties

PolicyTriggerPropertiesResp object

+

PolicyTriggerPropertiesResp object

Scheduler attributes

+

Scheduler attributes

type

+

type

String

+

String

Scheduler type. Currently, only time (periodic scheduling) is supported.

-

Enumeration values:

-

  • time

    -
+

Scheduler type. Currently, only time (periodic scheduling) is supported.

+

Enumeration values:

+
  • time
-
Table 12 PolicyTriggerPropertiesResp

Parameter

+
- - - - - - - -
Table 12 PolicyTriggerPropertiesResp

Parameter

Type

+

Type

Description

+

Description

pattern

+

pattern

Array of strings

+

Array of strings

Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

+

Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

start_time

+

start_time

String

+

String

Start time of the scheduler, for example, 2020-01-08 09:59:49

+

Start time of the scheduler, for example, 2020-01-08 09:59:49
-
Table 13 PolicyAssociateVault

Parameter

+
- - - - - - - -
Table 13 PolicyAssociateVault

Parameter

Type

+

Type

Description

+

Description

destination_vault_id

+

destination_vault_id

String

+

String

ID of the associated remote vault

+

ID of the associated remote vault

vault_id

+

vault_id

String

+

String

Vault ID

+

Vault ID
-

Example Requests

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
+
Example Requests
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
 
 {
   "policy" : {
@@ -581,9 +578,9 @@
   }
 }

 

-
Example Responses
Status code: 200

-
OK

-
{
+
Example Responses
Status code: 200

+
OK

+
{
   "policy" : {
     "name" : "policy001",
     "enabled" : true,
@@ -609,23 +606,23 @@
   }
 }

 

-
Status Codes

-
Status Code

+
Status Codes

+

-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
OK

+
OK

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cbr/api-ref/UpdatePolicy.html b/docs/cbr/api-ref/UpdatePolicy.html
index 6f4ccffa..00d228ae 100644
--- a/docs/cbr/api-ref/UpdatePolicy.html
+++ b/docs/cbr/api-ref/UpdatePolicy.html
@@ -1,564 +1,561 @@
 
 
 
Modifying a Policy

-
Function
This API is used to modify 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

+

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

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
policy_id

+
policy_id

 
Yes

+
Yes

 
String

+
String

 
Policy ID

+
Policy ID

 		
 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID

+
Project ID

 		
 

 
 

 

 
-
Request Parameters

-
Table 2 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 2 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.

 		
 

 
 

 

 
-
Table 3 Request body parameters
Parameter

+

-
-
-
-
-
-
-
Table 3 Request body parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
policy

+
policy

 
Yes

+
Yes

 
PolicyUpdate object

+
PolicyUpdate object

 
Request body of modifying a policy

+
Request body of modifying a policy

 		
 

 
 

 

 
-
Table 4 PolicyUpdate
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 4 PolicyUpdate
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
enabled

+
enabled

 
No

+
No

 
Boolean

+
Boolean

 
Whether to enable the policy

-
Default: true

+
Whether to enable the policy

+
Default: true

 		
 
name

+
name

 
No

+
No

 
String

+
String

 
Policy Name

-
Minimum: 1

-
Maximum: 64

+
Policy Name

+
Minimum: 1

+
Maximum: 64

 		
 
operation_definition

+
operation_definition

 
No

+
No

 
PolicyoODCreate object

+
PolicyoODCreate object

 
Scheduling parameter

+
Scheduling parameter

 		
 
trigger

+
trigger

 
No

+
No

 
PolicyTriggerReq object

+
PolicyTriggerReq object

 
Time rule for the policy execution

+
Time rule for the policy execution

 		
 

 
 

 

 
-
Table 5 PolicyoODCreate
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 PolicyoODCreate
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
day_backups

+
day_backups

 
No

+
No

 
Integer

+
Integer

 
Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-
Minimum: 0

-
Maximum: 100

+
Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be configured at the same time.

+
Minimum: 0

+
Maximum: 100

 		
 
destination_project_id

+
destination_project_id

 
No

+
No

 
String

+
String

 
ID of the replication destination project, which is mandatory for cross-region replication

+
ID of the replication destination project, which is mandatory for cross-region replication

 		
 
destination_region

+
destination_region

 
No

+
No

 
String

+
String

 
ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

+
ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

 		
 
max_backups

+
max_backups

 
No

+
No

 
Integer

+
Integer

 
Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

-
Minimum: 1

-
Maximum: 99999

-
Default: -1

+
Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently. This parameter and retention_duration_days cannot be configured at the same time.

+
Minimum: 1

+
Maximum: 99999

+
Default: -1

 		
 
month_backups

+
month_backups

 
No

+
No

 
Integer

+
Integer

 
Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-
Minimum: 0

-
Maximum: 100

+
Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be configured at the same time.

+
Minimum: 0

+
Maximum: 100

 		
 
retention_duration_days

+
retention_duration_days

 
No

+
No

 
Integer

+
Integer

 
Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

-
Minimum: 1

-
Maximum: 99999

-
Default: -1

+
Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently. This parameter cannot be configured if max_backups, day_backups, week_backups, month_backups, or year_backups is configured.

+
Minimum: 1

+
Maximum: 99999

+
Default: -1

 		
 
timezone

+
timezone

 
No

+
No

 
String

+
String

 
Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

+
Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups. This parameter and retention_duration_days cannot be configured at the same time.

 		
 
week_backups

+
week_backups

 
No

+
No

 
Integer

+
Integer

 
Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+
Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be configured at the same time.

 		
 
year_backups

+
year_backups

 
No

+
No

 
Integer

+
Integer

 
Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-
Minimum: 0

-
Maximum: 100

+
Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be configured at the same time.

+
Minimum: 0

+
Maximum: 100

 		
 

 
 

 

 
-
Table 6 PolicyTriggerReq
Parameter

+

-
-
-
-
-
-
-
Table 6 PolicyTriggerReq
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
properties

+
properties

 
Yes

+
Yes

 
PolicyTriggerPropertiesReq object

+
PolicyTriggerPropertiesReq object

 
Scheduler attributes

+
Scheduler attributes

 		
 

 
 

 

 
-
Table 7 PolicyTriggerPropertiesReq
Parameter

+

-
-
-
-
-
-
-
Table 7 PolicyTriggerPropertiesReq
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
pattern

+
pattern

 
Yes

+
Yes

 
Array of strings

+
Array of strings

 
Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

+
Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

 		
 

 
 

 

 
-
Response Parameters
Status code: 200

+
Response Parameters
Status code: 200

 
-
Table 8 Response body parameters
Parameter

+

-
-
-
-
-
Table 8 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
policy

+
policy

 
Policy object

+
Policy object

 
Response to the request for creating a policy

+
Response to the request for creating a policy

 		
 

 
 

 

 
-
Table 9 Policy
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 9 Policy
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
enabled

+
enabled

 
Boolean

+
Boolean

 
Whether the policy is enabled

+
Whether the policy is enabled

 		
 
id

+
id

 
String

+
String

 
Policy ID

+
Policy ID

 		
 
name

+
name

 
String

+
String

 
Policy Name

+
Policy Name

 		
 
operation_definition

+
operation_definition

 
PolicyoODCreate object

+
PolicyoODCreate object

 
Policy attributes

+
Policy attributes

 		
 
operation_type

+
operation_type

 
String

+
String

 
Protection type, which can be backup or replication

-
Enumeration values:

-
  • backup
    
-
  • replication
    
-

+
Protection type, which can be backup or replication

+
Enumeration values:

+
  • backup
  • replication

 		
 
trigger

+
trigger

 
PolicyTriggerResp object

+
PolicyTriggerResp object

 
Time scheduling rule for the policy

+
Time scheduling rule for the policy

 		
 
associated_vaults

+
associated_vaults

 
Array of PolicyAssociateVault objects

+
Array of PolicyAssociateVault objects

 
Associated vault

+
Associated vault

 		
 

 
 

 

 
-
Table 10 PolicyoODCreate
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 10 PolicyoODCreate
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
day_backups

+
day_backups

 
Integer

+
Integer

 
Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-
Minimum: 0

-
Maximum: 100

+
Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+
Minimum: 0

+
Maximum: 100

 		
 
destination_project_id

+
destination_project_id

 
String

+
String

 
ID of the replication destination project, which is mandatory for cross-region replication

+
ID of the replication destination project, which is mandatory for cross-region replication

 		
 
destination_region

+
destination_region

 
String

+
String

 
ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

+
ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

 		
 
max_backups

+
max_backups

 
Integer

+
Integer

 
Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

-
Minimum: 1

-
Maximum: 99999

-
Default: -1

+
Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

+
Minimum: 1

+
Maximum: 99999

+
Default: -1

 		
 
month_backups

+
month_backups

 
Integer

+
Integer

 
Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-
Minimum: 0

-
Maximum: 100

+
Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+
Minimum: 0

+
Maximum: 100

 		
 
retention_duration_days

+
retention_duration_days

 
Integer

+
Integer

 
Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

-
Minimum: 1

-
Maximum: 99999

-
Default: -1

+
Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

+
Minimum: 1

+
Maximum: 99999

+
Default: -1

 		
 
timezone

+
timezone

 
String

+
String

 
Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

+
Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

 		
 
week_backups

+
week_backups

 
Integer

+
Integer

 
Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+
Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

 		
 
year_backups

+
year_backups

 
Integer

+
Integer

 
Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

-
Minimum: 0

-
Maximum: 100

+
Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

+
Minimum: 0

+
Maximum: 100

 		
 

 
 

 

 
-
Table 11 PolicyTriggerResp
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 11 PolicyTriggerResp
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
id

+
id

 
String

+
String

 
Scheduler ID

+
Scheduler ID

 		
 
name

+
name

 
String

+
String

 
Scheduler name

+
Scheduler name

 		
 
properties

+
properties

 
PolicyTriggerPropertiesResp object

+
PolicyTriggerPropertiesResp object

 
Scheduler attributes

+
Scheduler attributes

 		
 
type

+
type

 
String

+
String

 
Scheduler type. Currently, only time (periodic scheduling) is supported.

-
Enumeration values:

-
  • time
    
-

+
Scheduler type. Currently, only time (periodic scheduling) is supported.

+
Enumeration values:

+
  • time

 		
 

 
 

 

 
-
Table 12 PolicyTriggerPropertiesResp
Parameter

+

-
-
-
-
-
-
-
-
Table 12 PolicyTriggerPropertiesResp
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
pattern

+
pattern

 
Array of strings

+
Array of strings

 
Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

+
Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

 		
 
start_time

+
start_time

 
String

+
String

 
Start time of the scheduler, for example, 2020-01-08 09:59:49

+
Start time of the scheduler, for example, 2020-01-08 09:59:49

 		
 

 
 

 

 
-

-
@@ -132,7 +143,7 @@
 
-
@@ -189,37 +200,55 @@
 
+
+
+
+
+
+
Table 13 PolicyAssociateVault
Parameter

+

-
-
-
-
-
-
-
-
Table 13 PolicyAssociateVault
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
destination_vault_id

+
destination_vault_id

 
String

+
String

 
ID of the associated remote vault

+
ID of the associated remote vault

 		
 
vault_id

+
vault_id

 
String

+
String

 
Vault ID

+
Vault ID

 		
 

 
 

 

 
-
Example Requests
PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies/cbb3ce6f-3332-4e7c-b98e-77290d8471ff
+
Example Requests
PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies/cbb3ce6f-3332-4e7c-b98e-77290d8471ff
 
 {
   "policy" : {
@@ -580,9 +577,9 @@
   }
 }

 

-
Example Responses
Status code: 200

-
OK

-
{
+
Example Responses
Status code: 200

+
OK

+
{
   "policy" : {
     "name" : "policy001",
     "associated_vaults" : [ ],
@@ -609,23 +606,23 @@
   }
 }

 

-
Status Codes

-

-
@@ -71,6 +71,17 @@
 
+
+
+
+
+
+
Status Code

+
Status Codes

+

-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
OK

+
OK

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cbr/api-ref/cbr_04_0001.html b/docs/cbr/api-ref/cbr_04_0001.html
index 56e8c1b3..d26e8161 100644
--- a/docs/cbr/api-ref/cbr_04_0001.html
+++ b/docs/cbr/api-ref/cbr_04_0001.html
@@ -1,7 +1,7 @@
 
 
 
API Usage Guidelines

-
Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+
Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL,uri indicates the resource path, that is, the API access path.

 
Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

 
For details about how to use APIs, see API Usage Guidelines.

 

diff --git a/docs/cbr/api-ref/cbr_04_0018.html b/docs/cbr/api-ref/cbr_04_0018.html
index 5552825f..464b3d1c 100644
--- a/docs/cbr/api-ref/cbr_04_0018.html
+++ b/docs/cbr/api-ref/cbr_04_0018.html
@@ -41,7 +41,7 @@
 

 
Action

 
Related Action

+
Dependencies

 		
 
IAM Project

 
√

 		
 
Querying the replication capability

+
GET /v3/{project_id}/replication-capabilities

+
cbr:backups:queryReplicationCapability

+
-

+
√

+

 
 

 

@@ -82,7 +93,7 @@
 

 
Action

 
Related Action

+
Dependencies

 		
 
IAM Project

 
√

 		
 
Removing resources

+
Dissociating resources

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

 
√

 		
 
Migrating a resource

+
POST /v3/{project_id}/vaults/{vault_id}/migrateresources

+
cbr:vaults:migrateResources

+
cbr:vaults:addResources

+
√

+

 
 

 

 
 
Restore Point

-
Permission

+

-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-
@@ -227,75 +256,63 @@
 
Backup Sharing

-
Permission

 
API

+
API

 
Action

+
Action

 
Related Action

+
Dependencies

 
IAM Project

-
Enterprise Project

+
IAM Project

 		
 

 
Creating a restore point

+
Replicating a restore point

 
POST /v3/{project_id}/checkpoints

+
POST /v3/{project_id}/checkpoints/replicate

 
cbr:vaults:backup

+
cbr:vaults:replicate

 
ecs:cloudServers:list

+
-

+
√

+
Creating a restore point

+
POST /v3/{project_id}/checkpoints

+
cbr:vaults:backup

+
ecs:cloudServers:list

 
evs:volumes:list

 
√

-
√

+
√

 		
 

 
 
 
Permission

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -303,84 +320,72 @@
 
Backup

-
Permission

 
API

+
API

 
Action

+
Action

 
IAM Project

-
Enterprise Project

+
IAM Project

 		
 

 
Adding a share member

+
Creating a share member

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

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

 
cbr:member:create

+
cbr:member:create

 
√

-
√

+
√

 		
 
Updating the share member status

+
Updating the share member status

 
PUT

+
PUT

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

 
cbr:member:update

+
cbr:member:update

 
√

-
√

+
√

 		
 
Querying details about a share member

+
Querying a specified share member

 
GET

+
GET

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

 
cbr:member:get

+
cbr:member:get

 
√

-
√

+
√

 		
 
Obtaining the share member list

+
Querying the share member list

 
GET

+
GET

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

 
cbr:member:list

+
cbr:member:list

 
√

-
√

+
√

 		
 
Deleting a specified share member

+
Deleting a share member

 
DELETE

+
DELETE

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

 
cbr:member:delete

+
cbr:member:delete

 
√

-
√

+
√

 		
 

 
 
 
Permission

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
@@ -388,71 +393,59 @@
 
Policy

-
Permission

 
API

+
API

 
Action

+
Action

 
Related Action

+
Dependencies

 
IAM Project

-
Enterprise Project

+
IAM Project

 		
 

 
Querying all backups

+
Listing backups

 
GET /v3/{project_id}/backups

+
GET /v3/{project_id}/backups

 
cbr:backups:list

+
cbr:backups:list

 
-

+
-

 
√

-
√

+
√

 		
 
Querying a specified backup

+
Querying a specified backup

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

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

 
cbr:backups:get

+
cbr:backups:get

 
-

+
-

 
√

-
√

+
√

 		
 
Deleting a backup

+
Deleting a backup

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

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

 
cbr:backups:delete

+
cbr:backups:delete

 
-

+
-

 
√

-
√

+
√

 		
 
Synchronizing a backup

+
Restoring from a backup

 
POST /v3/{project_id}/backups/sync

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

 
cbr:backups:sync

+
cbr:backups:restore

 
-

-
√

-
√

-
Restoring data using a backup

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

-
cbr:backups:restore

-
ecs:cloudServers:list

+
ecs:cloudServers:list

 
evs:volumes:list

 
√

+
√

 
√

+
Replicating a backup

+
POST /v3/{project_id}/backups/{backup_id}/replicate

+
cbr:backups:replicate

+
-

+
√

 		
 

 
 
 
Permission

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -460,82 +453,68 @@
 
Tag

-
Permission

 
API

+
API

 
Action

+
Action

 
IAM Project

-
Enterprise Project

+
IAM Project

 		
 

 
Querying the policy list

+
Querying the policy list

 
GET /v3/{project_id}/policies

+
GET /v3/{project_id}/policies

 
cbr:policies:list

+
cbr:policies:list

 
√

-
√

+
√

 		
 
Creating a policy

+
Creating a policy

 
POST /v3/{project_id}/policies

+
POST /v3/{project_id}/policies

 
cbr:policies:create

+
cbr:policies:create

 
√

-
√

+
√

 		
 
Querying a policy

+
Querying a specified policy

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

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

 
cbr:policies:get

+
cbr:policies:get

 
√

-
√

+
√

 		
 
Modifying a policy

+
Updating a policy

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

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

 
cbr:policies:update

+
cbr:policies:update

 
√

-
√

+
√

 		
 
Deleting a policy

+
Deleting a policy

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

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

 
cbr:policies:delete

+
cbr:policies:delete

 
√

-
√

+
√

 		
 

 
 
 
Permission

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/cbr/api-ref/cbr_04_0025.html b/docs/cbr/api-ref/cbr_04_0025.html
index f5e12233..2189d514 100644
--- a/docs/cbr/api-ref/cbr_04_0025.html
+++ b/docs/cbr/api-ref/cbr_04_0025.html
@@ -8,7 +8,19 @@
 
-
+
+
+
+
+
+
Permission

 
API

+
API

 
Action

+
Action

 
IAM Project

-
Enterprise Project

+
IAM Project

 		
 

 
Querying the vault resource instances

+
Querying the vault resources

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

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

 
cbr:vaults:listResourceInstances

+
cbr:vaults:listResourceInstances

 
√

-
√

+
√

 		
 
Batch adding or deleting vault resource tags

+
Batch adding or deleting tags of a vault resource

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

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

 
cbr:vaults:bulkCreateOrDeleteTags

+
cbr:vaults:bulkCreateOrDeleteTags

 
√

-
√

+
√

 		
 
Adding a vault resource tag

+
Adding a tag to a vault resource

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

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

 
cbr:vaults:setTags

+
cbr:vaults:setTags

 
√

-
√

+
√

 		
 
Deleting a vault resource tag

+
Deleting a tag of a vault resource

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

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

 
cbr:vaults:deleteTags

+
cbr:vaults:deleteTags

 
√

-
√

+
√

 		
 
Querying a vault resource tag

+
Querying tags of a vault resource

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

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

 
cbr:vaults:getTags

+
cbr:vaults:getTags

 
√

-
√

+
√

 		
 
Querying a vault project tag

+
Querying tags of a vault project

 
GET /v3/{project_id}/vault/tags

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

 
cbr:vaults:listProjectTags

+
cbr:vaults:listProjectTags

 
√

-
√

+
√

 		
 

 
 
 
2023-10-23

+
2024-09-09

+
Updated the following content:

+
  • Added the description that the retention_duration_days, max_backups, day_backups, week_backups, month_backups, and year_backups fields cannot be set at the same time in sections "Creating a Policy" and "Modifying a Policy."

+
2024-01-23

+
Updated the following content:

+
  • Added the following CBR actions: querying the storage usage, updating vault orders, replicating a restore point, querying the vault list in other regions, migrating a resource, replicating a backup, and querying the replication capability.

+
2023-10-23

 		
 
Updated the following content:

 
  • Added support for cross-region replication.