diff --git a/docs/cbr/api-ref/ALL_META.TXT.json b/docs/cbr/api-ref/ALL_META.TXT.json index 8fc17ffe5..6347373db 100644 --- a/docs/cbr/api-ref/ALL_META.TXT.json +++ b/docs/cbr/api-ref/ALL_META.TXT.json @@ -41,7 +41,7 @@ { "uri":"topic_300000000.html", "node_id":"topic_300000000.xml", - "product_code":"", + "product_code":"cbr", "code":"3", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -49,7 +49,10 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "prodname":"cbr", + "documenttype":"api", + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Tasks", @@ -58,7 +61,7 @@ { "uri":"ListOpLogs.html", "node_id":"listoplogs.xml", - "product_code":"", + "product_code":"cbr", "code":"4", "des":"This API is used to query the task list.GET /v3/{project_id}/operation-logsStatus code: 200Status code: 404Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -66,9 +69,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ListOpLogs" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying the Task List", @@ -77,7 +81,7 @@ { "uri":"ShowOpLog.html", "node_id":"showoplog.xml", - "product_code":"", + "product_code":"cbr", "code":"5", "des":"This API is used to query a task by task ID.GET /v3/{project_id}/operation-logs/{operation_log_id}Status code: 200Status code: 404Status code: 200OKStatus code: 404The ta", "doc_type":"api", @@ -85,9 +89,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowOpLog" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying a Single Task", @@ -96,7 +101,7 @@ { "uri":"topic_300000001.html", "node_id":"topic_300000001.xml", - "product_code":"", + "product_code":"cbr", "code":"6", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -104,7 +109,10 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "prodname":"cbr", + "documenttype":"api", + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Vaults", @@ -113,7 +121,7 @@ { "uri":"CreateVault.html", "node_id":"createvault.xml", - "product_code":"", + "product_code":"cbr", "code":"7", "des":"This API is used to create a vault.POST /v3/{project_id}/vaultsStatus code: 200Status code: 400Creating a server backup vault, associating resources, and adding tagsPOST ", "doc_type":"api", @@ -121,9 +129,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"CreateVault" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Creating a Vault", @@ -132,7 +141,7 @@ { "uri":"ListVault.html", "node_id":"listvault.xml", - "product_code":"", + "product_code":"cbr", "code":"8", "des":"This API is used to query the vault list.GET /v3/{project_id}/vaultsStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -140,9 +149,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ListVault" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying the Vault List", @@ -151,7 +161,7 @@ { "uri":"ShowVault.html", "node_id":"showvault.xml", - "product_code":"", + "product_code":"cbr", "code":"9", "des":"This API is used to query a specified vault based on its ID.GET /v3/{project_id}/vaults/{vault_id}Status code: 200Status code: 404Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -159,9 +169,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowVault" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying a Specified Vault", @@ -170,7 +181,7 @@ { "uri":"UpdateVault.html", "node_id":"updatevault.xml", - "product_code":"", + "product_code":"cbr", "code":"10", "des":"This API is used to modify a vault based on its ID.PUT /v3/{project_id}/vaults/{vault_id}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -178,9 +189,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"UpdateVault" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Modifying a Vault", @@ -189,7 +201,7 @@ { "uri":"DeleteVault.html", "node_id":"deletevault.xml", - "product_code":"", + "product_code":"cbr", "code":"11", "des":"Deleting a vault. Once a vault is deleted, all backups in the vault will be deleted.DELETE /v3/{project_id}/vaults/{vault_id}NoneNoneSee Error Codes.", "doc_type":"api", @@ -197,9 +209,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"DeleteVault" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Deleting a Vault", @@ -208,7 +221,7 @@ { "uri":"AddVaultResource.html", "node_id":"addvaultresource.xml", - "product_code":"", + "product_code":"cbr", "code":"12", "des":"This API is used to associate resources with a vault.POST /v3/{project_id}/vaults/{vault_id}/addresourcesStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -216,9 +229,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"AddVaultResource" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Associating Resources", @@ -227,7 +241,7 @@ { "uri":"AssociateVaultPolicy.html", "node_id":"associatevaultpolicy.xml", - "product_code":"", + "product_code":"cbr", "code":"13", "des":"This API is used to apply a policy to a vault.POST /v3/{project_id}/vaults/{vault_id}/associatepolicyStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -235,9 +249,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"AssociateVaultPolicy" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Applying a Policy to a Vault", @@ -246,7 +261,7 @@ { "uri":"DisassociateVaultPolicy.html", "node_id":"disassociatevaultpolicy.xml", - "product_code":"", + "product_code":"cbr", "code":"14", "des":"This API is used to remove a policy from a vault.POST /v3/{project_id}/vaults/{vault_id}/dissociatepolicyStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -254,9 +269,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"DisassociateVaultPolicy" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Removing a Policy from a Vault", @@ -265,7 +281,7 @@ { "uri":"MigrateVaultResource.html", "node_id":"migratevaultresource.xml", - "product_code":"", + "product_code":"cbr", "code":"15", "des":"This API is used to associate resources with another vault and migrate the resource backups to that destination vault.POST /v3/{project_id}/vaults/{vault_id}/migrateresou", "doc_type":"api", @@ -273,9 +289,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"MigrateVaultResource" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Migrating Resources", @@ -284,7 +301,7 @@ { "uri":"RemoveVaultResource.html", "node_id":"removevaultresource.xml", - "product_code":"", + "product_code":"cbr", "code":"16", "des":"This API is used to dissociate resources from a vault.POST /v3/{project_id}/vaults/{vault_id}/removeresourcesStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -292,9 +309,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"RemoveVaultResource" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Dissociating Resources", @@ -303,7 +321,7 @@ { "uri":"topic_300000002.html", "node_id":"topic_300000002.xml", - "product_code":"", + "product_code":"cbr", "code":"17", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -311,7 +329,10 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "prodname":"cbr", + "documenttype":"api", + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"API Version Query", @@ -320,7 +341,7 @@ { "uri":"ListVersions.html", "node_id":"listversions.xml", - "product_code":"", + "product_code":"cbr", "code":"18", "des":"This API is used to query the information of API versions.GET /NoneStatus code: 300NoneNoneSee Error Codes.", "doc_type":"api", @@ -328,9 +349,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ListVersions" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying API Versions", @@ -339,7 +361,7 @@ { "uri":"ShowVersion.html", "node_id":"showversion.xml", - "product_code":"", + "product_code":"cbr", "code":"19", "des":"This API is used to query the information of a specified API version.GET /{api_version}NoneStatus code: 300NoneNoneSee Error Codes.", "doc_type":"api", @@ -347,9 +369,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowVersion" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying a Specified API Version", @@ -358,7 +381,7 @@ { "uri":"topic_300000003.html", "node_id":"topic_300000003.xml", - "product_code":"", + "product_code":"cbr", "code":"20", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -366,7 +389,10 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "prodname":"cbr", + "documenttype":"api", + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Policies", @@ -375,7 +401,7 @@ { "uri":"ListPolicies.html", "node_id":"listpolicies.xml", - "product_code":"", + "product_code":"cbr", "code":"21", "des":"This API is used to query the policy list.GET /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -383,9 +409,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ListPolicies" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying the Policy List", @@ -394,7 +421,7 @@ { "uri":"CreatePolicy.html", "node_id":"createpolicy.xml", - "product_code":"", + "product_code":"cbr", "code":"22", "des":"This API is used to create a backup policy.POST /v3/{project_id}/policiesStatus code: 200Creating a backup policy with backups automatically executed at 14:00 everyday an", "doc_type":"api", @@ -402,9 +429,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"CreatePolicy" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Creating a Policy", @@ -413,7 +441,7 @@ { "uri":"UpdatePolicy.html", "node_id":"updatepolicy.xml", - "product_code":"", + "product_code":"cbr", "code":"23", "des":"This API is used to modify a policy.PUT /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -421,9 +449,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"UpdatePolicy" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Modifying a Policy", @@ -432,7 +461,7 @@ { "uri":"DeletePolicy.html", "node_id":"deletepolicy.xml", - "product_code":"", + "product_code":"cbr", "code":"24", "des":"This API is used to delete a policy.DELETE /v3/{project_id}/policies/{policy_id}NoneNoneSee Error Codes.", "doc_type":"api", @@ -440,9 +469,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"DeletePolicy" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Deleting a Policy", @@ -451,7 +481,7 @@ { "uri":"ShowPolicy.html", "node_id":"showpolicy.xml", - "product_code":"", + "product_code":"cbr", "code":"25", "des":"This API is used to query a single policy.GET /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -459,9 +489,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowPolicy" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying a Single Policy", @@ -470,7 +501,7 @@ { "uri":"topic_300000004.html", "node_id":"topic_300000004.xml", - "product_code":"", + "product_code":"cbr", "code":"26", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -478,7 +509,10 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "prodname":"cbr", + "documenttype":"api", + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Backups", @@ -487,7 +521,7 @@ { "uri":"ListBackups.html", "node_id":"listbackups.xml", - "product_code":"", + "product_code":"cbr", "code":"27", "des":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -495,9 +529,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ListBackups" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying All Backups", @@ -506,7 +541,7 @@ { "uri":"DeleteBackup.html", "node_id":"deletebackup.xml", - "product_code":"", + "product_code":"cbr", "code":"28", "des":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.", "doc_type":"api", @@ -514,9 +549,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"DeleteBackup" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Deleting a Backup", @@ -525,7 +561,7 @@ { "uri":"ShowBackup.html", "node_id":"showbackup.xml", - "product_code":"", + "product_code":"cbr", "code":"29", "des":"This API is used to query the backup of a specific ID.GET /v3/{project_id}/backups/{backup_id}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -533,9 +569,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowBackup" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying a Specified Backup", @@ -544,7 +581,7 @@ { "uri":"CopyBackup.html", "node_id":"copybackup.xml", - "product_code":"", + "product_code":"cbr", "code":"30", "des":"This API is used to replicate a backup across regions.POST /v3/{project_id}/backups/{backup_id}/replicateStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -552,9 +589,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"CopyBackup" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Replicating a Backup", @@ -563,7 +601,7 @@ { "uri":"RestoreBackup.html", "node_id":"restorebackup.xml", - "product_code":"", + "product_code":"cbr", "code":"31", "des":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", "doc_type":"api", @@ -571,9 +609,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"RestoreBackup" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Restoring a Backup", @@ -582,7 +621,7 @@ { "uri":"topic_300000005.html", "node_id":"topic_300000005.xml", - "product_code":"", + "product_code":"cbr", "code":"32", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -590,7 +629,10 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "prodname":"cbr", + "documenttype":"api", + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Protection", @@ -599,7 +641,7 @@ { "uri":"ShowReplicationCapabilities.html", "node_id":"showreplicationcapabilities.xml", - "product_code":"", + "product_code":"cbr", "code":"33", "des":"This API is used to query the replication capability of the current region.GET /v3/{project_id}/replication-capabilitiesStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -607,9 +649,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowReplicationCapabilities" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying the Replication Capability", @@ -618,7 +661,7 @@ { "uri":"topic_300000006.html", "node_id":"topic_300000006.xml", - "product_code":"", + "product_code":"cbr", "code":"34", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -626,7 +669,10 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "prodname":"cbr", + "documenttype":"api", + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Backup Sharing", @@ -635,7 +681,7 @@ { "uri":"AddMember.html", "node_id":"addmember.xml", - "product_code":"", + "product_code":"cbr", "code":"35", "des":"This API is used to add a member with whom the backup can be shared. Only cloud server backups can be shared among tenants in the same region.POST /v3/{project_id}/backup", "doc_type":"api", @@ -643,9 +689,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"AddMember" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Adding a Share Member", @@ -654,7 +701,7 @@ { "uri":"ShowMembersDetail.html", "node_id":"showmembersdetail.xml", - "product_code":"", + "product_code":"cbr", "code":"36", "des":"This API is used to obtain the list of backup share members.GET /v3/{project_id}/backups/{backup_id}/membersStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -662,9 +709,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowMembersDetail" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Obtaining the Share Member List", @@ -673,7 +721,7 @@ { "uri":"UpdateMemberStatus.html", "node_id":"updatememberstatus.xml", - "product_code":"", + "product_code":"cbr", "code":"37", "des":"This API is used to update the status of a backup share member.PUT /v3/{project_id}/backups/{backup_id}/members/{member_id}Status code: 200Status code: 200OKSee Error Cod", "doc_type":"api", @@ -681,9 +729,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"UpdateMemberStatus" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Updating the Share Member Status", @@ -692,7 +741,7 @@ { "uri":"DeleteMember.html", "node_id":"deletemember.xml", - "product_code":"", + "product_code":"cbr", "code":"38", "des":"This API is used to delete a specified backup share member.DELETE /v3/{project_id}/backups/{backup_id}/members/{member_id}NoneNoneSee Error Codes.", "doc_type":"api", @@ -700,9 +749,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"DeleteMember" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Deleting a Specified Share Member", @@ -711,7 +761,7 @@ { "uri":"ShowMemberDetail.html", "node_id":"showmemberdetail.xml", - "product_code":"", + "product_code":"cbr", "code":"39", "des":"This API is used to obtain the details of a backup share member.GET /v3/{project_id}/backups/{backup_id}/members/{member_id}Status code: 200Status code: 200OKSee Error Co", "doc_type":"api", @@ -719,9 +769,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowMemberDetail" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying Share Member Details", @@ -730,7 +781,7 @@ { "uri":"topic_300000007.html", "node_id":"topic_300000007.xml", - "product_code":"", + "product_code":"cbr", "code":"40", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -738,7 +789,10 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "prodname":"cbr", + "documenttype":"api", + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Tags", @@ -747,7 +801,7 @@ { "uri":"ShowVaultResourceInstances.html", "node_id":"showvaultresourceinstances.xml", - "product_code":"", + "product_code":"cbr", "code":"41", "des":"This API is used to filter resources by tag.Tag Management Service (TMS) uses this API to filter and list resources of each service by tag. These services must have the q", "doc_type":"api", @@ -755,9 +809,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowVaultResourceInstances" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying Vault Resources", @@ -766,7 +821,7 @@ { "uri":"ShowVaultProjectTag.html", "node_id":"showvaultprojecttag.xml", - "product_code":"", + "product_code":"cbr", "code":"42", "des":"This API is used to query a tenant's tag set in a specific region and of a specific instance type.TMS uses this API to list tags created by a tenant to facilitate tag cre", "doc_type":"api", @@ -774,9 +829,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowVaultProjectTag" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying Tags of a Vault Project", @@ -785,7 +841,7 @@ { "uri":"CreateVaultTags.html", "node_id":"createvaulttags.xml", - "product_code":"", + "product_code":"cbr", "code":"43", "des":"This API is used to add a tag to an associated resource. A resource can have a maximum of 20 tags.This API is idempotent. If a to-be-added tag has the same key as an exis", "doc_type":"api", @@ -793,9 +849,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"CreateVaultTags" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Adding a Tag to an Associated Resource", @@ -804,7 +861,7 @@ { "uri":"ShowVaultTag.html", "node_id":"showvaulttag.xml", - "product_code":"", + "product_code":"cbr", "code":"44", "des":"This API is used to query tags of a specified resource.TMS uses this API to query all tags of a specified resource.GET /v3/{project_id}/vault/{vault_id}/tagsNoneStatus co", "doc_type":"api", @@ -812,9 +869,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowVaultTag" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying Tags of an Associated Resource", @@ -823,7 +881,7 @@ { "uri":"BatchCreateAndDeleteVaultTags.html", "node_id":"batchcreateanddeletevaulttags.xml", - "product_code":"", + "product_code":"cbr", "code":"45", "des":"This API is used to batch add or delete tags for a specified instance.TMS uses this API to manage service resource tags.A resource can have a maximum of 20 tags.This API ", "doc_type":"api", @@ -831,9 +889,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"BatchCreateAndDeleteVaultTags" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Batch Adding or Deleting Tags of a Vault", @@ -842,7 +901,7 @@ { "uri":"DeleteVaultTag.html", "node_id":"deletevaulttag.xml", - "product_code":"", + "product_code":"cbr", "code":"46", "des":"This API is used to delete a tag from an associated resource. The API is idempotent. When you delete a nonexistent tag, error code 404 will be returned. Tag keys cannot b", "doc_type":"api", @@ -850,9 +909,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"DeleteVaultTag" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Deleting a Tag from an Associated Resource", @@ -861,7 +921,7 @@ { "uri":"topic_300000008.html", "node_id":"topic_300000008.xml", - "product_code":"", + "product_code":"cbr", "code":"47", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -869,7 +929,10 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "prodname":"cbr", + "documenttype":"api", + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Restore Points", @@ -878,7 +941,7 @@ { "uri":"CreateCheckpoint.html", "node_id":"createcheckpoint.xml", - "product_code":"", + "product_code":"cbr", "code":"48", "des":"This API is used to back up a vault and generate a restore point.POST /v3/{project_id}/checkpointsStatus code: 200Creating backupsStatus code: 200OKSee Error Codes.", "doc_type":"api", @@ -886,9 +949,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"CreateCheckpoint" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Creating a Restore Point", @@ -897,7 +961,7 @@ { "uri":"CopyCheckpoint.html", "node_id":"copycheckpoint.xml", - "product_code":"", + "product_code":"cbr", "code":"49", "des":"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.P", "doc_type":"api", @@ -905,9 +969,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"CopyCheckpoint" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Replicating a Restore Point", @@ -916,7 +981,7 @@ { "uri":"ShowCheckpoint.html", "node_id":"showcheckpoint.xml", - "product_code":"", + "product_code":"cbr", "code":"50", "des":"This API is used to query a specified restore point based on its ID.GET /v3/{project_id}/checkpoints/{checkpoint_id}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -924,9 +989,10 @@ "search_title":"", "metedata":[ { - "opensource":"true", + "prodname":"cbr", "documenttype":"api", - "operation_id":"ShowCheckpoint" + "opensource":"true", + "operation_id":"ListOpLogs;ShowOpLog;CreateVault;ListVault;ShowVault;UpdateVault;DeleteVault;AddVaultResource;AssociateVaultPolicy;DisassociateVaultPolicy;MigrateVaultResource;RemoveVaultResource;ListVersions;ShowVersion;ListPolicies;CreatePolicy;UpdatePolicy;DeletePolicy;ShowPolicy;ListBackups;DeleteBackup;ShowBackup;CopyBackup;RestoreBackup;ShowReplicationCapabilities;AddMember;ShowMembersDetail;UpdateMemberStatus;DeleteMember;ShowMemberDetail;ShowVaultResourceInstances;ShowVaultProjectTag;CreateVaultTags;ShowVaultTag;BatchCreateAndDeleteVaultTags;DeleteVaultTag;CreateCheckpoint;CopyCheckpoint;ShowCheckpoint" } ], "title":"Querying a Restore Point", @@ -975,7 +1041,7 @@ "code":"53", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Category of CBR Actions,Permissions Policies and Supported Actions,API Reference", + "kw":"CBR Actions,Permissions Policies and Supported Actions,API Reference", "search_title":"", "metedata":[ { @@ -983,7 +1049,7 @@ "prodname":"cbr" } ], - "title":"Category of CBR Actions", + "title":"CBR Actions", "githuburl":"" }, { diff --git a/docs/cbr/api-ref/CLASS.TXT.json b/docs/cbr/api-ref/CLASS.TXT.json index 575775397..3a20dfd99 100644 --- a/docs/cbr/api-ref/CLASS.TXT.json +++ b/docs/cbr/api-ref/CLASS.TXT.json @@ -19,7 +19,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"cbr", "title":"Tasks", "uri":"topic_300000000.html", "doc_type":"api", @@ -28,7 +28,7 @@ }, { "desc":"This API is used to query the task list.GET /v3/{project_id}/operation-logsStatus code: 200Status code: 404Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying the Task List", "uri":"ListOpLogs.html", "doc_type":"api", @@ -37,7 +37,7 @@ }, { "desc":"This API is used to query a task by task ID.GET /v3/{project_id}/operation-logs/{operation_log_id}Status code: 200Status code: 404Status code: 200OKStatus code: 404The ta", - "product_code":"", + "product_code":"cbr", "title":"Querying a Single Task", "uri":"ShowOpLog.html", "doc_type":"api", @@ -46,7 +46,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"cbr", "title":"Vaults", "uri":"topic_300000001.html", "doc_type":"api", @@ -55,7 +55,7 @@ }, { "desc":"This API is used to create a vault.POST /v3/{project_id}/vaultsStatus code: 200Status code: 400Creating a server backup vault, associating resources, and adding tagsPOST ", - "product_code":"", + "product_code":"cbr", "title":"Creating a Vault", "uri":"CreateVault.html", "doc_type":"api", @@ -64,7 +64,7 @@ }, { "desc":"This API is used to query the vault list.GET /v3/{project_id}/vaultsStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying the Vault List", "uri":"ListVault.html", "doc_type":"api", @@ -73,7 +73,7 @@ }, { "desc":"This API is used to query a specified vault based on its ID.GET /v3/{project_id}/vaults/{vault_id}Status code: 200Status code: 404Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying a Specified Vault", "uri":"ShowVault.html", "doc_type":"api", @@ -82,7 +82,7 @@ }, { "desc":"This API is used to modify a vault based on its ID.PUT /v3/{project_id}/vaults/{vault_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Modifying a Vault", "uri":"UpdateVault.html", "doc_type":"api", @@ -91,7 +91,7 @@ }, { "desc":"Deleting a vault. Once a vault is deleted, all backups in the vault will be deleted.DELETE /v3/{project_id}/vaults/{vault_id}NoneNoneSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Deleting a Vault", "uri":"DeleteVault.html", "doc_type":"api", @@ -100,7 +100,7 @@ }, { "desc":"This API is used to associate resources with a vault.POST /v3/{project_id}/vaults/{vault_id}/addresourcesStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Associating Resources", "uri":"AddVaultResource.html", "doc_type":"api", @@ -109,7 +109,7 @@ }, { "desc":"This API is used to apply a policy to a vault.POST /v3/{project_id}/vaults/{vault_id}/associatepolicyStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Applying a Policy to a Vault", "uri":"AssociateVaultPolicy.html", "doc_type":"api", @@ -118,7 +118,7 @@ }, { "desc":"This API is used to remove a policy from a vault.POST /v3/{project_id}/vaults/{vault_id}/dissociatepolicyStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Removing a Policy from a Vault", "uri":"DisassociateVaultPolicy.html", "doc_type":"api", @@ -127,7 +127,7 @@ }, { "desc":"This API is used to associate resources with another vault and migrate the resource backups to that destination vault.POST /v3/{project_id}/vaults/{vault_id}/migrateresou", - "product_code":"", + "product_code":"cbr", "title":"Migrating Resources", "uri":"MigrateVaultResource.html", "doc_type":"api", @@ -136,7 +136,7 @@ }, { "desc":"This API is used to dissociate resources from a vault.POST /v3/{project_id}/vaults/{vault_id}/removeresourcesStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Dissociating Resources", "uri":"RemoveVaultResource.html", "doc_type":"api", @@ -145,7 +145,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"cbr", "title":"API Version Query", "uri":"topic_300000002.html", "doc_type":"api", @@ -154,7 +154,7 @@ }, { "desc":"This API is used to query the information of API versions.GET /NoneStatus code: 300NoneNoneSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying API Versions", "uri":"ListVersions.html", "doc_type":"api", @@ -163,7 +163,7 @@ }, { "desc":"This API is used to query the information of a specified API version.GET /{api_version}NoneStatus code: 300NoneNoneSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying a Specified API Version", "uri":"ShowVersion.html", "doc_type":"api", @@ -172,7 +172,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"cbr", "title":"Policies", "uri":"topic_300000003.html", "doc_type":"api", @@ -181,7 +181,7 @@ }, { "desc":"This API is used to query the policy list.GET /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying the Policy List", "uri":"ListPolicies.html", "doc_type":"api", @@ -190,7 +190,7 @@ }, { "desc":"This API is used to create a backup policy.POST /v3/{project_id}/policiesStatus code: 200Creating a backup policy with backups automatically executed at 14:00 everyday an", - "product_code":"", + "product_code":"cbr", "title":"Creating a Policy", "uri":"CreatePolicy.html", "doc_type":"api", @@ -199,7 +199,7 @@ }, { "desc":"This API is used to modify a policy.PUT /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Modifying a Policy", "uri":"UpdatePolicy.html", "doc_type":"api", @@ -208,7 +208,7 @@ }, { "desc":"This API is used to delete a policy.DELETE /v3/{project_id}/policies/{policy_id}NoneNoneSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Deleting a Policy", "uri":"DeletePolicy.html", "doc_type":"api", @@ -217,7 +217,7 @@ }, { "desc":"This API is used to query a single policy.GET /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying a Single Policy", "uri":"ShowPolicy.html", "doc_type":"api", @@ -226,7 +226,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"cbr", "title":"Backups", "uri":"topic_300000004.html", "doc_type":"api", @@ -235,7 +235,7 @@ }, { "desc":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying All Backups", "uri":"ListBackups.html", "doc_type":"api", @@ -244,7 +244,7 @@ }, { "desc":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Deleting a Backup", "uri":"DeleteBackup.html", "doc_type":"api", @@ -253,7 +253,7 @@ }, { "desc":"This API is used to query the backup of a specific ID.GET /v3/{project_id}/backups/{backup_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying a Specified Backup", "uri":"ShowBackup.html", "doc_type":"api", @@ -262,7 +262,7 @@ }, { "desc":"This API is used to replicate a backup across regions.POST /v3/{project_id}/backups/{backup_id}/replicateStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Replicating a Backup", "uri":"CopyBackup.html", "doc_type":"api", @@ -271,7 +271,7 @@ }, { "desc":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Restoring a Backup", "uri":"RestoreBackup.html", "doc_type":"api", @@ -280,7 +280,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"cbr", "title":"Protection", "uri":"topic_300000005.html", "doc_type":"api", @@ -289,7 +289,7 @@ }, { "desc":"This API is used to query the replication capability of the current region.GET /v3/{project_id}/replication-capabilitiesStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying the Replication Capability", "uri":"ShowReplicationCapabilities.html", "doc_type":"api", @@ -298,7 +298,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"cbr", "title":"Backup Sharing", "uri":"topic_300000006.html", "doc_type":"api", @@ -307,7 +307,7 @@ }, { "desc":"This API is used to add a member with whom the backup can be shared. Only cloud server backups can be shared among tenants in the same region.POST /v3/{project_id}/backup", - "product_code":"", + "product_code":"cbr", "title":"Adding a Share Member", "uri":"AddMember.html", "doc_type":"api", @@ -316,7 +316,7 @@ }, { "desc":"This API is used to obtain the list of backup share members.GET /v3/{project_id}/backups/{backup_id}/membersStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Obtaining the Share Member List", "uri":"ShowMembersDetail.html", "doc_type":"api", @@ -325,7 +325,7 @@ }, { "desc":"This API is used to update the status of a backup share member.PUT /v3/{project_id}/backups/{backup_id}/members/{member_id}Status code: 200Status code: 200OKSee Error Cod", - "product_code":"", + "product_code":"cbr", "title":"Updating the Share Member Status", "uri":"UpdateMemberStatus.html", "doc_type":"api", @@ -334,7 +334,7 @@ }, { "desc":"This API is used to delete a specified backup share member.DELETE /v3/{project_id}/backups/{backup_id}/members/{member_id}NoneNoneSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Deleting a Specified Share Member", "uri":"DeleteMember.html", "doc_type":"api", @@ -343,7 +343,7 @@ }, { "desc":"This API is used to obtain the details of a backup share member.GET /v3/{project_id}/backups/{backup_id}/members/{member_id}Status code: 200Status code: 200OKSee Error Co", - "product_code":"", + "product_code":"cbr", "title":"Querying Share Member Details", "uri":"ShowMemberDetail.html", "doc_type":"api", @@ -352,7 +352,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"cbr", "title":"Tags", "uri":"topic_300000007.html", "doc_type":"api", @@ -361,7 +361,7 @@ }, { "desc":"This API is used to filter resources by tag.Tag Management Service (TMS) uses this API to filter and list resources of each service by tag. These services must have the q", - "product_code":"", + "product_code":"cbr", "title":"Querying Vault Resources", "uri":"ShowVaultResourceInstances.html", "doc_type":"api", @@ -370,7 +370,7 @@ }, { "desc":"This API is used to query a tenant's tag set in a specific region and of a specific instance type.TMS uses this API to list tags created by a tenant to facilitate tag cre", - "product_code":"", + "product_code":"cbr", "title":"Querying Tags of a Vault Project", "uri":"ShowVaultProjectTag.html", "doc_type":"api", @@ -379,7 +379,7 @@ }, { "desc":"This API is used to add a tag to an associated resource. A resource can have a maximum of 20 tags.This API is idempotent. If a to-be-added tag has the same key as an exis", - "product_code":"", + "product_code":"cbr", "title":"Adding a Tag to an Associated Resource", "uri":"CreateVaultTags.html", "doc_type":"api", @@ -388,7 +388,7 @@ }, { "desc":"This API is used to query tags of a specified resource.TMS uses this API to query all tags of a specified resource.GET /v3/{project_id}/vault/{vault_id}/tagsNoneStatus co", - "product_code":"", + "product_code":"cbr", "title":"Querying Tags of an Associated Resource", "uri":"ShowVaultTag.html", "doc_type":"api", @@ -397,7 +397,7 @@ }, { "desc":"This API is used to batch add or delete tags for a specified instance.TMS uses this API to manage service resource tags.A resource can have a maximum of 20 tags.This API ", - "product_code":"", + "product_code":"cbr", "title":"Batch Adding or Deleting Tags of a Vault", "uri":"BatchCreateAndDeleteVaultTags.html", "doc_type":"api", @@ -406,7 +406,7 @@ }, { "desc":"This API is used to delete a tag from an associated resource. The API is idempotent. When you delete a nonexistent tag, error code 404 will be returned. Tag keys cannot b", - "product_code":"", + "product_code":"cbr", "title":"Deleting a Tag from an Associated Resource", "uri":"DeleteVaultTag.html", "doc_type":"api", @@ -415,7 +415,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"cbr", "title":"Restore Points", "uri":"topic_300000008.html", "doc_type":"api", @@ -424,7 +424,7 @@ }, { "desc":"This API is used to back up a vault and generate a restore point.POST /v3/{project_id}/checkpointsStatus code: 200Creating backupsStatus code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Creating a Restore Point", "uri":"CreateCheckpoint.html", "doc_type":"api", @@ -433,7 +433,7 @@ }, { "desc":"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.P", - "product_code":"", + "product_code":"cbr", "title":"Replicating a Restore Point", "uri":"CopyCheckpoint.html", "doc_type":"api", @@ -442,7 +442,7 @@ }, { "desc":"This API is used to query a specified restore point based on its ID.GET /v3/{project_id}/checkpoints/{checkpoint_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"cbr", "title":"Querying a Restore Point", "uri":"ShowCheckpoint.html", "doc_type":"api", @@ -470,7 +470,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cbr", - "title":"Category of CBR Actions", + "title":"CBR Actions", "uri":"cbr_04_0018.html", "doc_type":"api", "p_code":"51", diff --git a/docs/cbr/api-ref/CreatePolicy.html b/docs/cbr/api-ref/CreatePolicy.html index 60ac75fba..8756c4927 100644 --- a/docs/cbr/api-ref/CreatePolicy.html +++ b/docs/cbr/api-ref/CreatePolicy.html @@ -1,562 +1,566 @@

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

Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

-

Minimum: 0

-

Maximum: 100

+

Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

+

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

Replication destination region, which is mandatory for cross-region replication The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

+

Replication destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

max_backups

+

max_backups

No

+

No

Integer

+

Integer

Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. This parameter and retention_duration_days cannot be both applied.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Maximum number of backups that can be automatically created for an object. The value can be -1 or 1-99999. If the value is set to -1, backups will not be cleared by the quantity of backups. If this parameter and retention_duration_days are both left blank, backups will be retained permanently. This field and retention_duration_days cannot be both set.

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

month_backups

+

month_backups

No

+

No

Integer

+

Integer

Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

-

Minimum: 0

-

Maximum: 100

+

Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

+

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. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

timezone

+

timezone

No

+

No

String

+

String

Time zone where the user is located, for example, UTC+01: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. The format is UTC+01:00. If any of the parameters of yearly, monthly, weekly, or daily backup is selected, this parameter cannot be left empty.

week_backups

+

week_backups

No

+

No

Integer

+

Integer

Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

+

Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

year_backups

+

year_backups

No

+

No

Integer

+

Integer

Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

-

Minimum: 0

-

Maximum: 100

+

Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

+

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

Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

-

Minimum: 0

-

Maximum: 100

+

Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

+

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

Replication destination region, which is mandatory for cross-region replication The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

+

Replication destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

max_backups

+

max_backups

Integer

+

Integer

Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. This parameter and retention_duration_days cannot be both applied.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Maximum number of backups that can be automatically created for an object. The value can be -1 or 1-99999. If the value is set to -1, backups will not be cleared by the quantity of backups. If this parameter and retention_duration_days are both left blank, backups will be retained permanently. This field and retention_duration_days cannot be both set.

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

month_backups

+

month_backups

Integer

+

Integer

Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

-

Minimum: 0

-

Maximum: 100

+

Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

+

Minimum: 0

+

Maximum: 100

retention_duration_days

+

retention_duration_days

Integer

+

Integer

Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

timezone

+

timezone

String

+

String

Time zone where the user is located, for example, UTC+01: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. The format is UTC+01:00. If any of the parameters of yearly, monthly, weekly, or daily backup is selected, this parameter cannot be left empty.

week_backups

+

week_backups

Integer

+

Integer

Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

+

Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

year_backups

+

year_backups

Integer

+

Integer

Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

-

Minimum: 0

-

Maximum: 100

+

Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

+

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

  • Creating a backup policy with backups automatically executed at 14:00 everyday and with each backup saved for one day
    POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
    +

    Example Requests

    • Creating a backup policy with backups automatically executed at 14:00 everyday and with each backup saved for one day

      +
      POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
       
       {
         "policy" : {
      @@ -578,7 +582,8 @@
           }
         }
       }
      -
    • Creating a replication policy with backups automatically replicated at 14:00 everyday and with each backup saved for one day
      POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
      +
    • Creating a replication policy with backups automatically replicated at 14:00 everyday and with each backup saved for one day

      +
      POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
       
       {
         "policy" : {
      @@ -604,9 +609,10 @@
       }
    -

    Example Responses

    Status code: 200

    -

    OK

    -
    • The backup policy is created. The backup policy is to automatically perform backup at 14:00 everyday and save each backup for one day.
      {
      +

      Example Responses

      Status code: 200

      +

      OK

      +
      • The backup policy is created. The backup policy is to automatically perform backup at 14:00 everyday and save each backup for one day.

        +
        {
           "policy" : {
             "name" : "policy001",
             "enabled" : true,
        @@ -631,7 +637,8 @@
             "id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
           }
         }
        -
      • The replication policy is created. The replication policy is to automatically replicate backups at 14:00 everyday and save each backup for one day.
        {
        +
      • Succeeded in creating a replication policy. The policy is to perform replication at 14:00 every day from Monday to Sunday. The retention policy is based on the backup retention period, which is one day.

        +
        {
           "policy" : {
             "name" : "policy002",
             "enabled" : true,
        @@ -660,23 +667,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/ListPolicies.html b/docs/cbr/api-ref/ListPolicies.html index c1e60d491..2691fb5f7 100644 --- a/docs/cbr/api-ref/ListPolicies.html +++ b/docs/cbr/api-ref/ListPolicies.html @@ -1,369 +1,374 @@

      Querying the Policy List

      -

      Function

      This API is used to query the policy list.

      +

      Function

      This API is used to query the policy list.

      -

      URI

      GET /v3/{project_id}/policies

      +

      URI

      GET /v3/{project_id}/policies

      -
      Table 1 Path Parameters

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID

      +

      Project ID

      -
      Table 2 Query Parameters

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      operation_type

      +

      operation_type

      No

      +

      No

      String

      +

      String

      Policy type, which can be backup or replication

      -

      Enumeration values:

      -
      • backup
      • replication
      +

      Policy type, which can be backup or replication

      +

      Enumeration values:

      +
      • backup

        +
      • replication

        +

      vault_id

      +

      vault_id

      No

      +

      No

      String

      +

      String

      Vault ID

      +

      Vault ID

      -

      Request Parameters

      -
      Table 3 Request header parameters

      Parameter

      +

      Request Parameters

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      User token

      -

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

      +

      User token

      +

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

      -

      Response Parameters

      Status code: 200

      +

      Response Parameters

      Status code: 200

      -
      Table 4 Response body parameters

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      policies

      +

      policies

      Array of Policy objects

      +

      Array of Policy objects

      Policy list

      +

      Policy list

      count

      +

      count

      Integer

      +

      Integer

      Total number of policies

      +

      Total number of policies

      -
      Table 5 Policy

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - -
      Table 5 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 6 PolicyoODCreate

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 6 PolicyoODCreate

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      day_backups

      +

      day_backups

      Integer

      +

      Integer

      Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      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

      Replication destination region, which is mandatory for cross-region replication The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

      +

      Replication destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

      max_backups

      +

      max_backups

      Integer

      +

      Integer

      Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 1

      -

      Maximum: 99999

      -

      Default: -1

      +

      Maximum number of backups that can be automatically created for an object. The value can be -1 or 1-99999. If the value is set to -1, backups will not be cleared by the quantity of backups. If this parameter and retention_duration_days are both left blank, backups will be retained permanently. This field and retention_duration_days cannot be both set.

      +

      Minimum: 1

      +

      Maximum: 99999

      +

      Default: -1

      month_backups

      +

      month_backups

      Integer

      +

      Integer

      Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      Minimum: 0

      +

      Maximum: 100

      retention_duration_days

      +

      retention_duration_days

      Integer

      +

      Integer

      Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

      -

      Minimum: 1

      -

      Maximum: 99999

      -

      Default: -1

      +

      Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

      +

      Minimum: 1

      +

      Maximum: 99999

      +

      Default: -1

      timezone

      +

      timezone

      String

      +

      String

      Time zone where the user is located, for example, UTC+01: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. The format is UTC+01:00. If any of the parameters of yearly, monthly, weekly, or daily backup is selected, this parameter cannot be left empty.

      week_backups

      +

      week_backups

      Integer

      +

      Integer

      Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      year_backups

      +

      year_backups

      Integer

      +

      Integer

      Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      Minimum: 0

      +

      Maximum: 100

      -
      Table 7 PolicyTriggerResp

      Parameter

      +
      - - - - - - - - - - - - - -
      Table 7 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 8 PolicyTriggerPropertiesResp

      Parameter

      +
      - - - - - - - -
      Table 8 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 9 PolicyAssociateVault

      Parameter

      +
      - - - - - - - -
      Table 9 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

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

      Example Requests

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

      Example Responses

      Status code: 200

      -

      OK

      -
      {
      +

      Example Responses

      Status code: 200

      +

      OK

      +
      {
         "policies" : [ {
           "name" : "policy001",
           "associated_vaults" : [ ],
      @@ -391,23 +396,23 @@
         "count" : 10
       }
      -

      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/ListVault.html b/docs/cbr/api-ref/ListVault.html index df647bf0d..dabad5db6 100644 --- a/docs/cbr/api-ref/ListVault.html +++ b/docs/cbr/api-ref/ListVault.html @@ -1,620 +1,630 @@

      Querying the Vault List

      -

      Function

      This API is used to query the vault list.

      +

      Function

      This API is used to query the vault list.

      -

      URI

      GET /v3/{project_id}/vaults

      +

      URI

      GET /v3/{project_id}/vaults

      -
      Table 1 Path Parameters

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID

      +

      Project ID

      -
      Table 2 Query Parameters

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      cloud_type

      +

      cloud_type

      No

      +

      No

      String

      +

      String

      Cloud type, which is public

      +

      Cloud type, which is public

      id

      +

      id

      No

      +

      No

      String

      +

      String

      Vault ID

      +

      Vault ID

      limit

      +

      limit

      No

      +

      No

      Integer

      +

      Integer

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

      -

      Minimum: 1

      -

      Maximum: 1000

      +

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

      +

      Minimum: 1

      +

      Maximum: 1000

      name

      +

      name

      No

      +

      No

      String

      +

      String

      Vault name

      +

      Vault name

      object_type

      +

      object_type

      No

      +

      No

      String

      +

      String

      Object type, which can be server or disk

      +

      Object type, which can be server or disk

      offset

      +

      offset

      No

      +

      No

      Integer

      +

      Integer

      Offset value. The value must be a positive integer.

      +

      Offset value. The value must be a positive integer.

      policy_id

      +

      policy_id

      No

      +

      No

      String

      +

      String

      Policy ID

      +

      Policy ID

      protect_type

      +

      protect_type

      No

      +

      No

      String

      +

      String

      Protection type, which is backup

      +

      Protection type, which is backup

      resource_ids

      +

      resource_ids

      No

      +

      No

      String

      +

      String

      Resource ID

      +

      Resource ID

      status

      +

      status

      No

      +

      No

      String

      +

      String

      Status

      +

      Status

      -

      Request Parameters

      -
      Table 3 Request header parameters

      Parameter

      +

      Request Parameters

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      No

      +

      No

      String

      +

      String

      User token

      -

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

      +

      User token

      +

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

      -

      Response Parameters

      Status code: 200

      +

      Response Parameters

      Status code: 200

      -
      Table 4 Response body parameters

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      vaults

      +

      vaults

      Array of Vault objects

      +

      Array of Vault objects

      Vault instance list

      +

      Vault instance list

      count

      +

      count

      Integer

      +

      Integer

      Number of vaults

      +

      Number of vaults

      limit

      +

      limit

      Integer

      +

      Integer

      Number of records displayed on each page

      -

      Minimum: 1

      -

      Maximum: 1000

      -

      Default: 1000

      +

      Number of records displayed on each page

      +

      Minimum: 1

      +

      Maximum: 1000

      +

      Default: 1000

      offset

      +

      offset

      Integer

      +

      Integer

      Offset where the query starts

      -

      Minimum: 0

      -

      Default: 0

      +

      Offset where the query starts

      +

      Minimum: 0

      +

      Default: 0

      -
      Table 5 Vault

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 5 Vault

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      billing

      +

      billing

      Billing object

      +

      Billing object

      Operation info

      +

      Operation info

      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

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

      +

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

      bind_rules

      +

      bind_rules

      VaultBindRules object

      +

      VaultBindRules object

      Association rule

      +

      Association rule

      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.

      locked

      +

      locked

      Boolean

      +

      Boolean

      Whether the vault is locked.

      +

      Whether the vault is locked.

      -
      Table 6 Billing

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 6 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 can be backup or replication

      +

      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 7 ResourceResp

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 7 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 8 ResourceExtraInfo

      Parameter

      +
      - - - - -
      Table 8 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 9 Tag

      Parameter

      +
      - - - - - - - -
      Table 9 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 10 VaultBindRules

      Parameter

      +
      - - - - -
      Table 10 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 11 BindRulesTags

      Parameter

      +
      - - - - - - - -
      Table 11 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 (-).

      -

      Example Requests

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

      Example Requests

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

      Example Responses

      Status code: 200

      -

      OK

      -
      {
      +

      Example Responses

      Status code: 200

      +

      OK

      +
      {
         "vaults" : [ {
           "id" : "a335f9e1-1628-4c64-a7be-38656e5ec19c",
           "name" : "vault-8538",
      @@ -644,23 +654,23 @@
         "count" : 50
       }
      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - -

      Status Code

      Description

      +

      Description

      200

      +

      200

      OK

      +

      OK

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/cbr/api-ref/ShowPolicy.html b/docs/cbr/api-ref/ShowPolicy.html index 1b6898efa..f3fa2bad1 100644 --- a/docs/cbr/api-ref/ShowPolicy.html +++ b/docs/cbr/api-ref/ShowPolicy.html @@ -1,338 +1,341 @@

      Querying a Single Policy

      -

      Function

      This API is used to query a single policy.

      +

      Function

      This API is used to query a single policy.

      -

      URI

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

      +

      URI

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

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - -
      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.

      -

      Default: MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX...

      +

      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.

      +

      Default: MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX...

      -

      Response Parameters

      Status code: 200

      +

      Response Parameters

      Status code: 200

      -
      Table 3 Response body parameters

      Parameter

      +
      - - - - -
      Table 3 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 4 Policy

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - -
      Table 4 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 5 PolicyoODCreate

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      day_backups

      +

      day_backups

      Integer

      +

      Integer

      Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      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

      Replication destination region, which is mandatory for cross-region replication The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

      +

      Replication destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

      max_backups

      +

      max_backups

      Integer

      +

      Integer

      Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 1

      -

      Maximum: 99999

      -

      Default: -1

      +

      Maximum number of backups that can be automatically created for an object. The value can be -1 or 1-99999. If the value is set to -1, backups will not be cleared by the quantity of backups. If this parameter and retention_duration_days are both left blank, backups will be retained permanently. This field and retention_duration_days cannot be both set.

      +

      Minimum: 1

      +

      Maximum: 99999

      +

      Default: -1

      month_backups

      +

      month_backups

      Integer

      +

      Integer

      Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      Minimum: 0

      +

      Maximum: 100

      retention_duration_days

      +

      retention_duration_days

      Integer

      +

      Integer

      Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

      -

      Minimum: 1

      -

      Maximum: 99999

      -

      Default: -1

      +

      Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

      +

      Minimum: 1

      +

      Maximum: 99999

      +

      Default: -1

      timezone

      +

      timezone

      String

      +

      String

      Time zone where the user is located, for example, UTC+01: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. The format is UTC+01:00. If any of the parameters of yearly, monthly, weekly, or daily backup is selected, this parameter cannot be left empty.

      week_backups

      +

      week_backups

      Integer

      +

      Integer

      Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      year_backups

      +

      year_backups

      Integer

      +

      Integer

      Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      Minimum: 0

      +

      Maximum: 100

      -
      Table 6 PolicyTriggerResp

      Parameter

      +
      - - - - - - - - - - - - - -
      Table 6 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 7 PolicyTriggerPropertiesResp

      Parameter

      +
      - - - - - - - -
      Table 7 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 8 PolicyAssociateVault

      Parameter

      +
      - - - - - - - -
      Table 8 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

      GET  https://{endpoint}/v3/{project_id}/policies/{policy_id}
      +

      Example Requests

      GET  https://{endpoint}/v3/{project_id}/policies/{policy_id}
      -

      Example Responses

      Status code: 200

      -

      OK

      -
      {
      +

      Example Responses

      Status code: 200

      +

      OK

      +
      {
         "policy" : {
           "name" : "policy001",
           "associated_vaults" : [ ],
      @@ -359,23 +362,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/ShowVaultResourceInstances.html b/docs/cbr/api-ref/ShowVaultResourceInstances.html index aa7501227..57a32977f 100644 --- a/docs/cbr/api-ref/ShowVaultResourceInstances.html +++ b/docs/cbr/api-ref/ShowVaultResourceInstances.html @@ -1,751 +1,766 @@

      Querying Vault Resources

      -

      Function

      This API is used to filter resources by tag.

      -

      Tag Management Service (TMS) uses this API to filter and list resources of each service by tag. These services must have the query capabilities.

      +

      Function

      This API is used to filter resources by tag.

      +

      Tag Management Service (TMS) uses this API to filter and list resources of each service by tag. These services must have the query capabilities.

      -

      URI

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

      +

      URI

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

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - -
      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 body parameters

      Parameter

      +

      Request Parameters

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 2 Request body parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      without_any_tag

      +

      without_any_tag

      No

      +

      No

      Boolean

      +

      Boolean

      If this parameter is set to true, all resources without tags are queried. In this case, the tag, not_tags, tags_any, and not_tags_any fields are ignored.

      +

      If this parameter is set to true, all resources without tags are queried. In this case, the tag, not_tags, tags_any, and not_tags_any fields are ignored.

      tags

      +

      tags

      No

      +

      No

      Array of TagsReq objects

      +

      Array of TagsReq objects

      List of included tags

      -

      This list cannot be an empty list.

      -

      The list can contain up to 20 keys.

      -

      Keys in this list must be unique.

      -

      Values in this list are in an AND relationship.

      -

      The response returns resources containing all tags in this list. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship.

      -

      If no filtering condition is specified, full data is returned.

      +

      List of included tags

      +

      This list cannot be an empty list.

      +

      The list can contain up to 20 keys.

      +

      Keys in this list must be unique.

      +

      Values in this list are in an AND relationship.

      +

      The response returns resources containing all tags in this list. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship.

      +

      If no filtering condition is specified, full data is returned.

      tags_any

      +

      tags_any

      No

      +

      No

      Array of TagsReq objects

      +

      Array of TagsReq objects

      List of any included tags

      -

      This list cannot be an empty list.

      -

      The list can contain up to 20 keys.

      -

      Keys in this list must be unique.

      -

      The response returns resources containing any tag in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.

      -

      If no filtering condition is specified, full data is returned.

      +

      List of any included tags

      +

      This list cannot be an empty list.

      +

      The list can contain up to 20 keys.

      +

      Keys in this list must be unique.

      +

      The response returns resources containing any tag in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.

      +

      If no filtering condition is specified, full data is returned.

      not_tags

      +

      not_tags

      No

      +

      No

      Array of TagsReq objects

      +

      Array of TagsReq objects

      List of excluded tags

      -

      This list cannot be an empty list.

      -

      The list can contain up to 20 keys.

      -

      Keys in this list must be unique.

      -

      The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship.

      -

      If no filtering condition is specified, full data is returned.

      +

      List of excluded tags

      +

      This list cannot be an empty list.

      +

      The list can contain up to 20 keys.

      +

      Keys in this list must be unique.

      +

      The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship.

      +

      If no filtering condition is specified, full data is returned.

      not_tags_any

      +

      not_tags_any

      No

      +

      No

      Array of TagsReq objects

      +

      Array of TagsReq objects

      List of any excluded tags

      -

      This list cannot be an empty list.

      -

      The list can contain up to 20 keys.

      -

      Keys in this list must be unique.

      -

      The response returns resources without any tags in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.

      -

      If no filtering condition is specified, full data is returned.

      +

      List of any excluded tags

      +

      This list cannot be an empty list.

      +

      The list can contain up to 20 keys.

      +

      Keys in this list must be unique.

      +

      The response returns resources without any tags in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.

      +

      If no filtering condition is specified, full data is returned.

      limit

      +

      limit

      No

      +

      No

      String

      +

      String

      Query count. (This parameter is not displayed when action is set to count.) If action is set to filter, the value defaults to 1000. The value ranges from 1 to 1000. If you set a value not within this range, an error will be reported. The number of returned records does not exceed the value of limit.

      +

      Query count. (This parameter is not displayed when action is set to count.) If action is set to filter, the value defaults to 1000. The value ranges from 1 to 1000. If you set a value not within this range, an error will be reported. The number of returned records does not exceed the value of limit.

      offset

      +

      offset

      No

      +

      No

      String

      +

      String

      Index position. (This parameter is not displayed when action is set to count.) If action is set to filter, the value defaults to 0 and the minimum value of offset is 0. The first record in the query result is the offset+1 record that meets the query criteria.

      +

      Index position. (This parameter is not displayed when action is set to count.) If action is set to filter, the value defaults to 0 and the minimum value of offset is 0. The first record in the query result is the offset+1 record that meets the query criteria.

      action

      +

      action

      Yes

      +

      Yes

      String

      +

      String

      Operation identifier. Possible values are filter and count. The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned.

      +

      Operation identifier. Possible values are filter and count. The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned.

      matches

      +

      matches

      No

      +

      No

      Array of Match objects

      +

      Array of Match objects

      Search criteria supported by resources

      -

      Keys in this list must be unique.

      -

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

      +

      Search criteria supported by resources

      +

      Keys in this list must be unique.

      +

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

      cloud_type

      +

      cloud_type

      No

      +

      No

      String

      +

      String

      Cloud type, which is public

      +

      Cloud type

      +

      Enumeration values:

      +
      • public

        +

      object_type

      +

      object_type

      No

      +

      No

      String

      +

      String

      Resource type

      -

      Enumeration values:

      -
      • server
      • disk
      +

      Resource type

      +

      Enumeration values:

      +
      • server

        +
      • disk

        +
      -
      Table 3 TagsReq

      Parameter

      +
      - - - - - - - - - - -
      Table 3 TagsReq

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      key

      +

      key

      Yes

      +

      Yes

      String

      +

      String

      Key

      -

      It contains a maximum of 127 Unicode characters.

      -

      A tag key cannot be an empty string.

      -

      Spaces before and after a key will be deprecated.

      +

      Key

      +

      It contains a maximum of 127 Unicode characters.

      +

      A tag key cannot be an empty string.

      +

      Spaces before and after a key will be deprecated.

      values

      +

      values

      Yes

      +

      Yes

      Array of strings

      +

      Array of strings

      Lists the values

      -

      The list can contain up to 20 values.

      -

      A tag value contains up to 255 Unicode characters. Spaces before and after a key will be deprecated.

      -

      Values in this list must be unique.

      -

      Values in this list are in an OR relationship.

      -

      This list can be empty and each value can be an empty character string.

      -

      An empty value list means any values.

      -

      * is a reserved character in the system. If the value starts with *, fuzzy match is performed based on the value following *. The value cannot contain only *.

      +

      Lists the values

      +

      The list can contain up to 20 values.

      +

      A tag value contains up to 255 Unicode characters. Spaces before and after a key will be deprecated.

      +

      Values in this list must be unique.

      +

      Values in this list are in an OR relationship.

      +

      This list can be empty and each value can be an empty character string.

      +

      An empty value list means any values.

      +

      * is a reserved character in the system. If the value starts with *, fuzzy match is performed based on the value following *. The value cannot contain only *.

      -
      Table 4 Match

      Parameter

      +
      - - - - - - - - - - -
      Table 4 Match

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      key

      +

      key

      Yes

      +

      Yes

      String

      +

      String

      Key

      -

      A key can only be set to resource_name, indicating the resource name.

      +

      Key

      +

      A key can only be set to resource_name, indicating the resource name.

      value

      +

      value

      Yes

      +

      Yes

      String

      +

      String

      Value

      -

      A value consists of up to 255 characters

      -

      If key is set to resource_name, an empty character string indicates exact match and any non-empty string indicates fuzzy match.

      +

      Value

      +

      A value consists of up to 255 characters

      +

      If key is set to resource_name, an empty character string indicates exact match and any non-empty string indicates fuzzy match.

      -

      Response Parameters

      Status code: 200

      +

      Response Parameters

      Status code: 200

      -
      Table 5 Response body parameters

      Parameter

      +
      - - - - - - - -
      Table 5 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      resources

      +

      resources

      Array of TagResource objects

      +

      Array of TagResource objects

      List of matched resources (This parameter is not displayed if action is set to count.)

      +

      List of matched resources (This parameter is not displayed if action is set to count.)

      total_count

      +

      total_count

      Integer

      +

      Integer

      Total number of matched resources

      +

      Total number of matched resources

      -
      Table 6 TagResource

      Parameter

      +
      - - - - - - - - - - - - - -
      Table 6 TagResource

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      resource_id

      +

      resource_id

      String

      +

      String

      Resource ID

      +

      Resource ID

      resource_detail

      +

      resource_detail

      Array of Vault objects

      +

      Array of Vault objects

      Resource details

      +

      Resource details

      tags

      +

      tags

      Array of Tag objects

      +

      Array of Tag objects

      Tag list

      -

      If there is no tag, an empty array is used by default.

      +

      Tag list

      +

      If there is no tag, an empty array is used by default.

      resource_name

      +

      resource_name

      String

      +

      String

      Resource name

      +

      Resource name

      -
      Table 7 Vault

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 7 Vault

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      billing

      +

      billing

      Billing object

      +

      Billing object

      Operation info

      +

      Operation info

      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

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

      +

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

      bind_rules

      +

      bind_rules

      VaultBindRules object

      +

      VaultBindRules object

      Association rule

      +

      Association rule

      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.

      locked

      +

      locked

      Boolean

      +

      Boolean

      Whether the vault is locked.

      +

      Whether the vault is locked.

      -
      Table 8 Billing

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 8 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 can be backup or replication

      +

      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 9 ResourceResp

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 9 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 10 ResourceExtraInfo

      Parameter

      +
      - - - - -
      Table 10 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 11 VaultBindRules

      Parameter

      +
      - - - - -
      Table 11 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 12 BindRulesTags

      Parameter

      +
      - - - - - - - -
      Table 12 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 (-).

      -
      Table 13 Tag

      Parameter

      +
      - - - - - - - -
      Table 13 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 (_).

      -

      Status code: 400

      +

      Status code: 400

      -
      Table 14 Response body parameters

      Parameter

      +
      - - - - - - - -
      Table 14 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      error_code

      +

      error_code

      String

      +

      String

      For details, see Error Codes.

      +

      For details, see Error Codes.

      error_msg

      +

      error_msg

      String

      +

      String

      Error message

      +

      Error message

      -

      Example Requests

      POST  https://{endpoint}/v3/{project_id}/vault/resource_instances/action
      +

      Example Requests

      POST  https://{endpoint}/v3/{project_id}/vault/resource_instances/action
       
       {
         "tags" : [ {
      @@ -755,36 +770,36 @@
         "action" : "filter"
       }
      -

      Example Responses

      Status code: 200

      -

      OK

      -
      {
      +

      Example Responses

      Status code: 200

      +

      OK

      +
      {
         "tags" : [ {
           "key" : "string"
         } ]
       }
      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - - - -

      Status Code

      Description

      +

      Description

      200

      +

      200

      OK

      +

      OK

      400

      +

      400

      Bad Request

      +

      Bad Request

      -

      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 2739a5105..8c63c6568 100644 --- a/docs/cbr/api-ref/UpdatePolicy.html +++ b/docs/cbr/api-ref/UpdatePolicy.html @@ -1,562 +1,565 @@

      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

      Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      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

      Replication destination region, which is mandatory for cross-region replication The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

      +

      Replication destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

      max_backups

      +

      max_backups

      No

      +

      No

      Integer

      +

      Integer

      Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 1

      -

      Maximum: 99999

      -

      Default: -1

      +

      Maximum number of backups that can be automatically created for an object. The value can be -1 or 1-99999. If the value is set to -1, backups will not be cleared by the quantity of backups. If this parameter and retention_duration_days are both left blank, backups will be retained permanently. This field and retention_duration_days cannot be both set.

      +

      Minimum: 1

      +

      Maximum: 99999

      +

      Default: -1

      month_backups

      +

      month_backups

      No

      +

      No

      Integer

      +

      Integer

      Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      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. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

      -

      Minimum: 1

      -

      Maximum: 99999

      -

      Default: -1

      +

      Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

      +

      Minimum: 1

      +

      Maximum: 99999

      +

      Default: -1

      timezone

      +

      timezone

      No

      +

      No

      String

      +

      String

      Time zone where the user is located, for example, UTC+01: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. The format is UTC+01:00. If any of the parameters of yearly, monthly, weekly, or daily backup is selected, this parameter cannot be left empty.

      week_backups

      +

      week_backups

      No

      +

      No

      Integer

      +

      Integer

      Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      year_backups

      +

      year_backups

      No

      +

      No

      Integer

      +

      Integer

      Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      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

      Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      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

      Replication destination region, which is mandatory for cross-region replication The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

      +

      Replication destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).

      max_backups

      +

      max_backups

      Integer

      +

      Integer

      Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 1

      -

      Maximum: 99999

      -

      Default: -1

      +

      Maximum number of backups that can be automatically created for an object. The value can be -1 or 1-99999. If the value is set to -1, backups will not be cleared by the quantity of backups. If this parameter and retention_duration_days are both left blank, backups will be retained permanently. This field and retention_duration_days cannot be both set.

      +

      Minimum: 1

      +

      Maximum: 99999

      +

      Default: -1

      month_backups

      +

      month_backups

      Integer

      +

      Integer

      Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      Minimum: 0

      +

      Maximum: 100

      retention_duration_days

      +

      retention_duration_days

      Integer

      +

      Integer

      Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

      -

      Minimum: 1

      -

      Maximum: 99999

      -

      Default: -1

      +

      Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by 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 applied together with max_backups, day_backups, week_backups, month_backups, and year_backups.

      +

      Minimum: 1

      +

      Maximum: 99999

      +

      Default: -1

      timezone

      +

      timezone

      String

      +

      String

      Time zone where the user is located, for example, UTC+01: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. The format is UTC+01:00. If any of the parameters of yearly, monthly, weekly, or daily backup is selected, this parameter cannot be left empty.

      week_backups

      +

      week_backups

      Integer

      +

      Integer

      Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      year_backups

      +

      year_backups

      Integer

      +

      Integer

      Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied.

      +

      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

      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" : {
      @@ -578,9 +581,9 @@
         }
       }
      -

      Example Responses

      Status code: 200

      -

      OK

      -
      {
      +

      Example Responses

      Status code: 200

      +

      OK

      +
      {
         "policy" : {
           "name" : "policy001",
           "associated_vaults" : [ ],
      @@ -607,23 +610,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/cbr_04_0016.html b/docs/cbr/api-ref/cbr_04_0016.html index 0ceaa2c2e..e7920aee5 100644 --- a/docs/cbr/api-ref/cbr_04_0016.html +++ b/docs/cbr/api-ref/cbr_04_0016.html @@ -6,7 +6,7 @@
      diff --git a/docs/cbr/api-ref/cbr_04_0018.html b/docs/cbr/api-ref/cbr_04_0018.html index 464b3d1c7..22b9139a7 100644 --- a/docs/cbr/api-ref/cbr_04_0018.html +++ b/docs/cbr/api-ref/cbr_04_0018.html @@ -1,6 +1,6 @@ -

      Category of CBR Actions

      +

      CBR Actions

      Task

      diff --git a/docs/cbr/api-ref/cbr_04_0025.html b/docs/cbr/api-ref/cbr_04_0025.html index 986a2459d..3df36b813 100644 --- a/docs/cbr/api-ref/cbr_04_0025.html +++ b/docs/cbr/api-ref/cbr_04_0025.html @@ -8,10 +8,10 @@ -

      Permission

      2025-02-20

      +

      2025-03-27

      Updated the following content:

      -
      • Added the backup locking function and the locked field in sections "Creating a Vault", "Querying a Specified Vault", "Querying the Vault List", "Modifying a Vault", and "Querying the Vault Resources."
      • Optimized some parameter descriptions.
      +
      • Added the backup locking function and the locked field in sections "Creating a Vault", "Querying a Specified Vault", "Querying the Vault List", "Modifying a Vault", and "Querying the Vault Resources."
      • Optimized some parameter descriptions.

      2024-09-09