{
"members" : [ {
"status" : "pending",
- "image_id" : null,
"backup_id" : "0b07081e-3ec7-4e77-8571-54e2947da422",
- "vault_id" : null,
"dest_project_id" : "075e6035d300d48c2fd0c00b78b71ebf",
- "created_at" : "2020-02-05T10:38:34.209782",
- "updated_at" : null,
+ "created_at" : "2020-02-05T10:38:34.210+00:00",
"id" : "3c5a3015-c3a0-4dc6-a1e2-917b90f62319"
} ]
}
@@ -237,7 +234,7 @@
This API is used to replicate a backup across regions.
+POST /v3/{project_id}/backups/{backup_id}/replicate
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
backup_id + |
+Yes + |
+String + |
+ID of the backup to be replicated + |
+
project_id + |
+Yes + |
+String + |
+Project ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+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. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
replicate + |
+Yes + |
+BackupReplicateReqBody object + |
+Replication parameter + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
description + |
+No + |
+String + |
+Replica description +Minimum: 0 +Maximum: 255 + |
+
destination_project_id + |
+Yes + |
+String + |
+ID of the replication destination project + |
+
destination_region + |
+Yes + |
+String + |
+Replication destination region +Minimum: 0 +Maximum: 255 + |
+
destination_vault_id + |
+Yes + |
+String + |
+ID of the vault in the replication destination region + |
+
enable_acceleration + |
+No + |
+Boolean + |
+Whether to enable the acceleration function to shorten the replication time for cross-region replication. If this parameter is not set, the acceleration function is disabled. +Default: false + |
+
name + |
+No + |
+String + |
+Replica name +Minimum: 1 +Maximum: 64 + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
replication + |
+BackupReplicateRespBody object + |
+Replication response parameter + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
backup_id + |
+String + |
+ID of the source backup used for replication + |
+
destination_project_id + |
+String + |
+ID of the replication destination project + |
+
destination_region + |
+String + |
+Replication destination region + |
+
destination_vault_id + |
+String + |
+ID of the vault in the replication destination region + |
+
project_id + |
+String + |
+ID of the project where replication is performed + |
+
provider_id + |
+String + |
+Resource type ID + |
+
replication_record_id + |
+String + |
+Replication record ID + |
+
source_region + |
+String + |
+Replication source region + |
+
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/a5200268-74a5-4806-acc6-95793ab0228b/replicate
+
+{
+ "replicate" : {
+ "description" : "backup_description",
+ "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
+ "destination_region" : "region2",
+ "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
+ "enable_acceleration" : false,
+ "name" : "backup_name"
+ }
+}
+Status code: 200
+OK
+{
+ "replication" : {
+ "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
+ "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
+ "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d",
+ "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
+ "destination_region" : "region2",
+ "source_region" : "region1",
+ "project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
+ "replication_record_id" : "1579a71e-8d8d-41e6-85dc-d77f5ce8d91a"
+ }
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to replicate a restore point. In compare to console, it is vault replication and this API replicates all backups from source vault to destination vault.
+POST /v3/{project_id}/checkpoints/replicate
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+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. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
replicate + |
+Yes + |
+CheckpointReplicateParam object + |
+Parameters in the request body of performing a replication + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
auto_trigger + |
+No + |
+Boolean + |
+Whether to automatically trigger replication this time. The default value is false, indicating the replication needs to be manually triggered. + |
+
destination_project_id + |
+Yes + |
+String + |
+ID of the replication destination project + |
+
destination_region + |
+Yes + |
+String + |
+ID of the replication destination region +Minimum: 0 +Maximum: 255 + |
+
destination_vault_id + |
+Yes + |
+String + |
+ID of the vault in the replication destination region + |
+
enable_acceleration + |
+No + |
+Boolean + |
+Whether to enable the acceleration function to shorten the time spent on cross-region replication. + |
+
vault_id + |
+Yes + |
+String + |
+Vault ID (UUID) + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
replication + |
+CheckpointReplicateRespBody object + |
++ |
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
backups + |
+Array of CheckpointReplicateRespbackups objects + |
+List of backups to be replicated + |
+
destination_project_id + |
+String + |
+ID of the replication destination project + |
+
destination_region + |
+String + |
+Replication destination region + |
+
destination_vault_id + |
+String + |
+ID of the vault in the replication destination region + |
+
project_id + |
+String + |
+ID of the project where replication is performed + |
+
provider_id + |
+String + |
+Backup provider ID, which specifies whether the backup object is a server or disk + |
+
source_region + |
+String + |
+Replication source region + |
+
vault_id + |
+String + |
+Vault ID + |
+
Replicating backups
+POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/checkpoints/replicate
+
+{
+ "replicate" : {
+ "auto_trigger" : false,
+ "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
+ "destination_region" : "region2",
+ "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
+ "enable_acceleration" : false,
+ "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce"
+ }
+}
+Status code: 200
+OK
+{
+ "replication" : {
+ "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
+ "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
+ "source_region" : "region1",
+ "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
+ "destination_region" : "region2",
+ "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
+ "backups" : [ {
+ "replication_record_id" : "de128dfa-5451-4905-9c11-8fc842b2f41e",
+ "backup_id" : "7558e1a3-7046-4787-95cd-14b0ad0642a8"
+ }, {
+ "replication_record_id" : "892a7d1e-17c8-4751-ad75-cfbed7051857",
+ "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d"
+ }, {
+ "replication_record_id" : "8bf5ce8f-bfa1-4d57-98de-d6159ab9d86d",
+ "backup_id" : "aa00034d-ef40-443d-ab7a-dc846d988cdf"
+ } ],
+ "project_id" : "4229d7a45436489f8c3dc2b1d35d4987"
+ }
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+{
"checkpoint" : {
"status" : "protecting",
- "created_at" : "2019-05-10T07:59:12.733403",
+ "created_at" : "2019-05-10T07:59:12.733+00:00",
"vault" : {
"skipped_resources" : [ ],
"id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
"resources" : [ {
"name" : "ecs-1f0f-0002",
- "resource_size" : "40",
+ "resource_size" : 40,
"protect_status" : "available",
"type" : "OS::Nova::Server",
- "id" : "94eba8b2-acc9-4d82-badc-127144cc5526",
- "extra_info" : null
+ "id" : "94eba8b2-acc9-4d82-badc-127144cc5526"
} ],
"name" : "vault-be94"
},
@@ -601,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 fe62e0791..3f278086e 100644
--- a/docs/cbr/api-ref/CreatePolicy.html
+++ b/docs/cbr/api-ref/CreatePolicy.html
@@ -1,529 +1,577 @@
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 is backup
+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.
+Minimum: 0
+Maximum: 100
max_backups
+destination_project_id
No
+No
Integer
+String
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
+ID of the replication destination project, which is mandatory for cross-region replication
month_backups
+destination_region
No
+No
Integer
+String
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
+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 (-).
retention_duration_days
+enable_acceleration
No
+No
Integer
+Boolean
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
+Whether to enable the acceleration function to shorten the replication time for cross-region replication. If this parameter is not set, the acceleration function is disabled.
timezone
+max_backups
No
+No
String
+Integer
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.
+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
week_backups
+month_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 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
year_backups
+retention_duration_days
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
+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
+No
+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.
+week_backups
+No
+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.
+year_backups
+No
+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
-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 is backup
-Enumeration values:
-- backup
+Protection type, which is 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
max_backups
+destination_project_id
Integer
+String
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
+ID of the replication destination project, which is mandatory for cross-region replication
month_backups
+destination_region
Integer
+String
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
+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 (-).
retention_duration_days
+enable_acceleration
Integer
+Boolean
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
+Whether to enable the acceleration function to shorten the replication time for cross-region replication. If this parameter is not set, the acceleration function is disabled.
timezone
+max_backups
String
+Integer
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.
+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
week_backups
+month_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 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
year_backups
+retention_duration_days
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
+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
+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.
+week_backups
+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.
+year_backups
+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
-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" : {
@@ -546,17 +594,16 @@
}
}
-Example Responses
Status code: 200
-OK
-{
+Example Responses
Status code: 200
+OK
+{
"policy" : {
"name" : "policy001",
- "associated_vaults" : null,
"enabled" : true,
"trigger" : {
"properties" : {
"pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
- "start_time" : "2019-05-08 06:57:05"
+ "start_time" : "2019-05-08T06:57:05.000+00:00"
},
"type" : "time",
"id" : "d67269a6-5369-42d7-8150-5254bd446328",
@@ -575,28 +622,28 @@
}
}
-Status Codes
-Status Code
+Status Codes
+Status Code
Description
+Description
200
+200
OK
+OK
-
diff --git a/docs/cbr/api-ref/CreateVault.html b/docs/cbr/api-ref/CreateVault.html
index 43ed7eb45..20ce669e4 100644
--- a/docs/cbr/api-ref/CreateVault.html
+++ b/docs/cbr/api-ref/CreateVault.html
@@ -1,893 +1,904 @@
Creating a Vault
-Function
This API is used to create 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
+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
vault
+vault
Yes
+Yes
VaultCreate object
+VaultCreate object
Parameters for creating a vault
+Parameters for creating a vault
-Table 4 VaultCreate Parameter
+Table 4 VaultCreate Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
backup_policy_id
+backup_policy_id
No
+No
String
+String
Backup policy ID. If the value of this parameter is null, automatic backup is not performed.
+Backup policy ID. If the value of this parameter is null, automatic backup is not performed.
billing
+billing
Yes
+Yes
BillingCreate object
+BillingCreate object
Parameter information for creation
+Parameter information for creation
description
+description
No
+No
String
+String
User-defined vault description
-Minimum: 0
-Maximum: 64
+User-defined vault description
+Minimum: 0
+Maximum: 64
name
+name
Yes
+Yes
String
+String
Vault name
-Minimum: 1
-Maximum: 64
+Vault name
+Minimum: 1
+Maximum: 64
resources
+resources
Yes
+Yes
Array of ResourceCreate objects
+Array of ResourceCreate objects
Associated resources. Set this parameter to [] if no resources are associated when creating a vault.
-Array Length: 0 - 255
+Associated resources. Set this parameter to [] if no resources are associated when creating a vault.
+Array Length: 0 - 255
tags
+tags
No
+No
Array of Tag objects
+Array of Tag objects
Tag list This list cannot be an empty list. The list can contain up to 20 keys. Keys in this list must be unique.
+Tag list This list cannot be an empty list. The list can contain up to 20 keys. Keys in this list must be unique.
auto_bind
+auto_bind
No
+No
Boolean
+Boolean
Whether automatic association is supported
+Whether automatic association is supported
bind_rules
+bind_rules
No
+No
VaultBindRules object
+VaultBindRules object
Rules for automatic association
+Rules for automatic association
-Table 5 BillingCreate Parameter
+Table 5 BillingCreate Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
cloud_type
+cloud_type
No
+No
String
+String
Cloud type, which is public
+Cloud type, which is public
consistent_level
+consistent_level
Yes
+Yes
String
+String
Vault specification, which is crash_consistent by default (crash consistent backup)
+Vault specification, which is crash_consistent by default (crash consistent backup)
object_type
+object_type
Yes
+Yes
String
+String
Object type, which can be server, disk, or turbo
+Object type, which can be server, disk, or turbo
protect_type
+protect_type
Yes
+Yes
String
+String
Protection type, which is backup
+Protection type, which can be backup or replication
size
+size
Yes
+Yes
Integer
+Integer
Capacity, in GB
-Minimum: 10
-Maximum: 10485760
+Capacity, in GB
+Minimum: 10
+Maximum: 10485760
charging_mode
+charging_mode
No
+No
String
+String
Billing mode, which is post_paid
-Default: post_paid
+Billing mode, which is post_paid
+Default: post_paid
is_auto_renew
+is_auto_renew
No
+No
Boolean
+Boolean
Whether to automatically renew the subscription after expiration. By default, it is not renewed.
-Default: false
+Whether to automatically renew the subscription after expiration. By default, it is not renewed.
+Default: false
is_auto_pay
+is_auto_pay
No
+No
Boolean
+Boolean
Whether the fee is automatically deducted from the customer's account balance after an order is submitted. The non-automatic payment mode is used by default.
-Default: false
+Whether the fee is automatically deducted from the customer's account balance after an order is submitted. The non-automatic payment mode is used by default.
+Default: false
console_url
+console_url
No
+No
String
+String
Redirection URL
-Minimum: 1
-Maximum: 255
+Redirection URL
+Minimum: 1
+Maximum: 255
-Table 6 ResourceCreate Parameter
+Table 6 ResourceCreate Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
extra_info
+extra_info
No
+No
ResourceExtraInfo object
+ResourceExtraInfo object
Additional information of the resource
+Additional information of the resource
id
+id
Yes
+Yes
String
+String
ID of the resource to be backed up
+ID of the resource to be backed up
type
+type
Yes
+Yes
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
name
+name
No
+No
String
+String
Resource name
-Minimum: 0
-Maximum: 255
+Resource name
+Minimum: 0
+Maximum: 255
-Table 7 ResourceExtraInfo Parameter
+Table 7 ResourceExtraInfo Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
exclude_volumes
+exclude_volumes
No
+No
Array of strings
+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.
+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 8 Tag Parameter
+Table 8 Tag Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
key
+key
Yes
+Yes
String
+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 (_).
+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 (_).
value
+value
No
+No
String
+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 (_).
+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 (_).
-Table 9 VaultBindRules Parameter
+Table 9 VaultBindRules Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
tags
+tags
No
+No
Array of BindRulesTags objects
+Array of BindRulesTags objects
Filters automatically associated resources by tag.
+Filters automatically associated resources by tag.
-Table 10 BindRulesTags Parameter
+Table 10 BindRulesTags Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
key
+key
Yes
+Yes
String
+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 (-).
+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
+value
No
+No
String
+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 (-).
+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
+Response Parameters
Status code: 200
-Table 11 Response body parameters Parameter
+Table 11 Response body parameters Parameter
Type
+Type
Description
+Description
vault
+vault
VaultCreateResource object
+VaultCreateResource object
Objects returned after a vault query
+Objects returned after a vault query
-Table 12 VaultCreateResource Parameter
+Table 12 VaultCreateResource Parameter
Type
+Type
Description
+Description
billing
+billing
Billing object
+Billing object
Operations information
+Operations information
description
+description
String
+String
User-defined vault description
-Minimum: 0
-Maximum: 255
+User-defined vault description
+Minimum: 0
+Maximum: 255
id
+id
String
+String
Vault ID
+Vault ID
name
+name
String
+String
Vault name
-Minimum: 1
-Maximum: 64
+Vault name
+Minimum: 1
+Maximum: 64
project_id
+project_id
String
+String
Project ID
+Project ID
provider_id
+provider_id
String
+String
ID of the vault resource type
+ID of the vault resource type
resources
+resources
Array of ResourceResp objects
+Array of ResourceResp objects
Vault resources
+Vault resources
tags
+tags
Array of Tag objects
+Array of Tag objects
Vault tags
+Vault tags
auto_bind
+auto_bind
Boolean
+Boolean
Whether to enable automatic association. Its default value is false (not enable).
+Whether to enable automatic association. Its default value is false (not enable).
bind_rules
+bind_rules
VaultBindRules object
+VaultBindRules object
Association rules
+Association rules
user_id
+user_id
String
+String
User ID
+User 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
auto_expand
+auto_expand
Boolean
+Boolean
Whether to enable auto capacity expansion for the vault.
+Whether to enable auto capacity expansion for the vault.
-Table 13 Billing Parameter
+Table 13 Billing Parameter
Type
+Type
Description
+Description
allocated
+allocated
Integer
+Integer
Allocated capacity, in GB.
+Allocated capacity, in GB.
charging_mode
+charging_mode
String
+String
Billing mode, which is post_paid
+Billing mode, which is post_paid
cloud_type
+cloud_type
String
+String
Cloud type, which is public
+Cloud type, which is public
consistent_level
+consistent_level
String
+String
Vault specification, which is crash_consistent by default (crash consistent backup)
+Vault specification, which is crash_consistent by default (crash consistent backup)
object_type
+object_type
String
+String
Object type, which can be server, disk, or turbo
+Object type, which can be server, disk, or turbo
order_id
+order_id
String
+String
Order ID
+Order ID
product_id
+product_id
String
+String
Product ID
+Product ID
protect_type
+protect_type
String
+String
Protection type, which is backup
+Protection type, which can be backup or replication
size
+size
Integer
+Integer
Capacity, in GB
-Minimum: 1
-Maximum: 10485760
+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
-Enumeration values:
-- available
- lock
- frozen
- deleting
- error
+Vault status
+Enumeration values:
+available
+lock
+frozen
+deleting
+error
+
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 14 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
-Minimum: 0
-Maximum: 255
+Name of the resource to be backed up
+Minimum: 0
+Maximum: 255
protect_status
+protect_status
String
+String
Protection status
-Enumeration values:
-- available
- error
- protecting
- restoring
- removing
+Protection status
+Enumeration values:
+available
+error
+protecting
+restoring
+removing
+
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 15 ResourceExtraInfo Parameter
+Table 15 ResourceExtraInfo Parameter
Type
+Type
Description
+Description
exclude_volumes
+exclude_volumes
Array of strings
+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.
+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 16 Tag Parameter
+Table 16 Tag Parameter
Type
+Type
Description
+Description
key
+key
String
+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 (_).
+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 (_).
value
+value
String
+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 (_).
+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 (_).
-Table 17 VaultBindRules Parameter
+Table 17 VaultBindRules Parameter
Type
+Type
Description
+Description
tags
+tags
Array of BindRulesTags objects
+Array of BindRulesTags objects
Filters automatically associated resources by tag.
+Filters automatically associated resources by tag.
-Table 18 BindRulesTags Parameter
+Table 18 BindRulesTags Parameter
Type
+Type
Description
+Description
key
+key
String
+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 (-).
+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
+value
String
+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 (-).
+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
+Status code: 400
-Table 19 Response body parameters Parameter
+Table 19 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
-Example Requests
- Creating a server backup vault, associating resources, and adding tags
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
+Example Requests
Creating a server backup vault, associating resources, and adding tags
+POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
{
"vault" : {
@@ -919,7 +930,8 @@
"enterprise_project_id" : "0"
}
}
-- Creating a disk backup vault (with mandatory parameters only)
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
+ Creating a disk backup vault (with mandatory parameters only)
+ POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
{
"vault" : {
@@ -938,9 +950,9 @@
}
-Example Responses
Status code: 200
-OK
-{
+Example Responses
Status code: 200
+OK
+{
"vault" : {
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"description" : "vault_description",
@@ -948,7 +960,7 @@
"value" : "value01",
"key" : "key01"
} ],
- "enterprise_project_id" : "0",
+ "enterprise_project_id" : 0,
"auto_bind" : false,
"id" : "ad7627ae-5b0b-492e-b6bd-cd809b745197",
"user_id" : "38d65be2ecd840d19046e239e841a734",
@@ -957,18 +969,15 @@
"status" : "available",
"used" : 0,
"protect_type" : "backup",
- "order_id" : null,
"object_type" : "server",
"allocated" : 40,
"spec_code" : "vault.backup.server.normal",
"size" : 100,
"cloud_type" : "public",
- "product_id" : null,
"consistent_level" : "crash_consistent",
- "storage_unit" : null,
"charging_mode" : "post_paid"
},
- "created_at" : "2019-05-23T12:51:10.071232",
+ "created_at" : "2019-05-23T12:51:10.071+00:00",
"project_id" : "fc347bc64ccd4589ae52e4f44b7433c7",
"resources" : [ {
"name" : "ecs-b977-0002",
@@ -985,33 +994,33 @@
}
}
-Status Codes
-Status Code
+Status Codes
+Status Code
Description
+Description
200
+200
OK
+OK
400
+400
Bad Request
+Bad Request
-
diff --git a/docs/cbr/api-ref/CreateVaultTags.html b/docs/cbr/api-ref/CreateVaultTags.html
index 22f5bba71..9425895f1 100644
--- a/docs/cbr/api-ref/CreateVaultTags.html
+++ b/docs/cbr/api-ref/CreateVaultTags.html
@@ -170,7 +170,7 @@
diff --git a/docs/cbr/api-ref/DeleteBackup.html b/docs/cbr/api-ref/DeleteBackup.html
index 4b6d19101..264b8cb81 100644
--- a/docs/cbr/api-ref/DeleteBackup.html
+++ b/docs/cbr/api-ref/DeleteBackup.html
@@ -88,7 +88,7 @@
diff --git a/docs/cbr/api-ref/DeleteMember.html b/docs/cbr/api-ref/DeleteMember.html
index d03481a09..4497168ea 100644
--- a/docs/cbr/api-ref/DeleteMember.html
+++ b/docs/cbr/api-ref/DeleteMember.html
@@ -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 1ddec14d2..d303a6adb 100644
--- a/docs/cbr/api-ref/DeletePolicy.html
+++ b/docs/cbr/api-ref/DeletePolicy.html
@@ -88,7 +88,7 @@
diff --git a/docs/cbr/api-ref/DeleteVault.html b/docs/cbr/api-ref/DeleteVault.html
index 060182231..dc1cb5943 100644
--- a/docs/cbr/api-ref/DeleteVault.html
+++ b/docs/cbr/api-ref/DeleteVault.html
@@ -88,7 +88,7 @@
diff --git a/docs/cbr/api-ref/DeleteVaultTag.html b/docs/cbr/api-ref/DeleteVaultTag.html
index 033a42a8f..f9ab749c1 100644
--- a/docs/cbr/api-ref/DeleteVaultTag.html
+++ b/docs/cbr/api-ref/DeleteVaultTag.html
@@ -106,7 +106,7 @@
diff --git a/docs/cbr/api-ref/DisassociateVaultPolicy.html b/docs/cbr/api-ref/DisassociateVaultPolicy.html
index 22b68e3ed..ef38e81b8 100644
--- a/docs/cbr/api-ref/DisassociateVaultPolicy.html
+++ b/docs/cbr/api-ref/DisassociateVaultPolicy.html
@@ -167,7 +167,7 @@
diff --git a/docs/cbr/api-ref/ListBackups.html b/docs/cbr/api-ref/ListBackups.html
index 56038683a..e452eaee6 100644
--- a/docs/cbr/api-ref/ListBackups.html
+++ b/docs/cbr/api-ref/ListBackups.html
@@ -600,7 +600,7 @@
"backups" : [ {
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99",
- "updated_at" : "2020-02-21T07:07:25.113761",
+ "updated_at" : "2020-02-21T07:07:25.114+00:00",
"vault_id" : "cca85ea5-00a4-418d-9222-bd83985bc515",
"id" : "b1c4afd9-e7a6-4888-9010-c2bac3aa7910",
"resource_az" : "br-iaas-odin1a",
@@ -619,14 +619,14 @@
"status" : "available",
"resource_name" : "test001-02",
"description" : "",
- "expired_at" : "2020-05-21T07:00:54.060493",
+ "expired_at" : "2020-05-21T07:00:54.060+00:00",
"name" : "autobk_b629",
- "created_at" : "2020-02-21T07:00:54.065135",
+ "created_at" : "2020-02-21T07:00:54.065+00:00",
"resource_type" : "OS::Nova::Server"
}, {
"provider_id" : "d1603440-187d-4516-af25-121250c7cc97",
"checkpoint_id" : "f64c351f-769f-4c04-8806-fd90a59e9b12",
- "updated_at" : "2020-02-21T07:09:37.767084",
+ "updated_at" : "2020-02-21T07:09:37.767+00:00",
"vault_id" : "79bd9daa-884f-4f84-b8fe-235d58cd927d",
"id" : "5606aab5-2dc2-4498-8144-dc848d099af5",
"resource_az" : "br-iaas-odin1a",
@@ -646,9 +646,9 @@
"status" : "available",
"resource_name" : "qsy_000",
"description" : "",
- "expired_at" : "2020-03-22T07:00:34.877896",
+ "expired_at" : "2020-03-22T07:00:34.878+00:00",
"name" : "autobk_6809",
- "created_at" : "2020-02-21T07:00:34.882174",
+ "created_at" : "2020-02-21T07:00:34.882+00:00",
"resource_type" : "OS::Cinder::Volume"
} ]
}
@@ -674,7 +674,7 @@
diff --git a/docs/cbr/api-ref/ListOpLogs.html b/docs/cbr/api-ref/ListOpLogs.html
index 57ae3e7b4..2be0c2c9a 100644
--- a/docs/cbr/api-ref/ListOpLogs.html
+++ b/docs/cbr/api-ref/ListOpLogs.html
@@ -291,6 +291,7 @@
delete
vault_delete
remove_resource
+replication
operation_logs
Array of OperationLog objects
+Array of OperationLog objects
Task list
-Table 18 OperationLog Parameter
+Table 18 OperationLog Parameter
Type
error_info
OpErrorInfo object
+OpErrorInfo object
Task error message
extra_info
OpExtraInfo object
+OpExtraInfo object
Task extension information
delete
vault_delete
remove_resource
+replication
-Table 19 OpErrorInfo Parameter
+
-Table 20 OpExtraInfo Parameter
+Table 20 OpExtraInfo Parameter
Type
backup
OpExtendInfoBckup object
+OpExtendInfoBckup object
Extended parameters of backup
common
OpExtendInfoCommon object
+OpExtendInfoCommon object
Common parameters
delete
OpExtendInfoDelete object
+OpExtendInfoDelete object
Extended parameters of deletion
sync
OpExtendInfoSync object
+OpExtendInfoSync object
Extended parameters of synchronization
remove_resources
OpExtendInfoRemoveResources object
+OpExtendInfoRemoveResources object
Extended parameters of removing resources from a vault
resource
Resource object
+Resource object
Resource information
restore
OpExtendInfoRestore object
+OpExtendInfoRestore object
Extended parameters of restoration
vault_delete
OpExtendInfoVaultDelete object
+OpExtendInfoVaultDelete object
Extended parameters of deleting a vault
-Table 21 OpExtendInfoBckup Parameter
+
-Table 22 OpExtendInfoCommon Parameter
+
-Table 23 OpExtendInfoDelete Parameter
+
-Table 24 OpExtendInfoSync Parameter
+
-Table 25 OpExtendInfoRemoveResources Parameter
+Table 25 OpExtendInfoRemoveResources Parameter
Type
resources
Array of Resource objects
+Array of Resource objects
Resource information
-Table 26 Resource Parameter
+Table 26 Resource Parameter
Type
extra_info
ResourceExtraInfo object
+ResourceExtraInfo object
Vault name
-