diff --git a/docs/cbr/api-ref/ALL_META.TXT.json b/docs/cbr/api-ref/ALL_META.TXT.json index db268644b..8fc17ffe5 100644 --- a/docs/cbr/api-ref/ALL_META.TXT.json +++ b/docs/cbr/api-ref/ALL_META.TXT.json @@ -45,61 +45,6 @@ "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", - "kw":"API Version Query", - "search_title":"", - "metedata":[ - { - "documenttype":"api" - } - ], - "title":"API Version Query", - "githuburl":"" - }, - { - "uri":"ListVersions.html", - "node_id":"listversions.xml", - "product_code":"", - "code":"4", - "des":"This API is used to query the information of API versions.GET /NoneStatus code: 300NoneNoneSee Error Codes.", - "doc_type":"api", - "kw":"Querying API Versions,API Version Query,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ListVersions" - } - ], - "title":"Querying API Versions", - "githuburl":"" - }, - { - "uri":"ShowVersion.html", - "node_id":"showversion.xml", - "product_code":"", - "code":"5", - "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", - "kw":"Querying a Specified API Version,API Version Query,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ShowVersion" - } - ], - "title":"Querying a Specified API Version", - "githuburl":"" - }, - { - "uri":"topic_300000001.html", - "node_id":"topic_300000001.xml", - "product_code":"", - "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", "kw":"Tasks", "search_title":"", "metedata":[ @@ -114,7 +59,7 @@ "uri":"ListOpLogs.html", "node_id":"listoplogs.xml", "product_code":"", - "code":"7", + "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", "kw":"Querying the Task List,Tasks,API Reference", @@ -133,7 +78,7 @@ "uri":"ShowOpLog.html", "node_id":"showoplog.xml", "product_code":"", - "code":"8", + "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", "kw":"Querying a Single Task,Tasks,API Reference", @@ -149,270 +94,10 @@ "githuburl":"" }, { - "uri":"topic_300000002.html", - "node_id":"topic_300000002.xml", + "uri":"topic_300000001.html", + "node_id":"topic_300000001.xml", "product_code":"", - "code":"9", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Protection", - "search_title":"", - "metedata":[ - { - "documenttype":"api" - } - ], - "title":"Protection", - "githuburl":"" - }, - { - "uri":"ShowReplicationCapabilities.html", - "node_id":"showreplicationcapabilities.xml", - "product_code":"", - "code":"10", - "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", - "kw":"Querying the Replication Capability,Protection,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ShowReplicationCapabilities" - } - ], - "title":"Querying the Replication Capability", - "githuburl":"" - }, - { - "uri":"topic_300000003.html", - "node_id":"topic_300000003.xml", - "product_code":"", - "code":"11", - "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":"Backups", - "search_title":"", - "metedata":[ - { - "documenttype":"api" - } - ], - "title":"Backups", - "githuburl":"" - }, - { - "uri":"ListBackups.html", - "node_id":"listbackups.xml", - "product_code":"", - "code":"12", - "des":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.", - "doc_type":"api", - "kw":"Querying All Backups,Backups,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ListBackups" - } - ], - "title":"Querying All Backups", - "githuburl":"" - }, - { - "uri":"DeleteBackup.html", - "node_id":"deletebackup.xml", - "product_code":"", - "code":"13", - "des":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.", - "doc_type":"api", - "kw":"Deleting a Backup,Backups,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"DeleteBackup" - } - ], - "title":"Deleting a Backup", - "githuburl":"" - }, - { - "uri":"ShowBackup.html", - "node_id":"showbackup.xml", - "product_code":"", - "code":"14", - "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", - "kw":"Querying a Specified Backup,Backups,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ShowBackup" - } - ], - "title":"Querying a Specified Backup", - "githuburl":"" - }, - { - "uri":"CopyBackup.html", - "node_id":"copybackup.xml", - "product_code":"", - "code":"15", - "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", - "kw":"Replicating a Backup,Backups,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"CopyBackup" - } - ], - "title":"Replicating a Backup", - "githuburl":"" - }, - { - "uri":"RestoreBackup.html", - "node_id":"restorebackup.xml", - "product_code":"", - "code":"16", - "des":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", - "doc_type":"api", - "kw":"Restoring a Backup,Backups,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"RestoreBackup" - } - ], - "title":"Restoring a Backup", - "githuburl":"" - }, - { - "uri":"topic_300000004.html", - "node_id":"topic_300000004.xml", - "product_code":"", - "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", - "kw":"Backup Sharing", - "search_title":"", - "metedata":[ - { - "documenttype":"api" - } - ], - "title":"Backup Sharing", - "githuburl":"" - }, - { - "uri":"AddMember.html", - "node_id":"addmember.xml", - "product_code":"", - "code":"18", - "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", - "kw":"Adding a Share Member,Backup Sharing,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"AddMember" - } - ], - "title":"Adding a Share Member", - "githuburl":"" - }, - { - "uri":"ShowMembersDetail.html", - "node_id":"showmembersdetail.xml", - "product_code":"", - "code":"19", - "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", - "kw":"Obtaining the Share Member List,Backup Sharing,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ShowMembersDetail" - } - ], - "title":"Obtaining the Share Member List", - "githuburl":"" - }, - { - "uri":"UpdateMemberStatus.html", - "node_id":"updatememberstatus.xml", - "product_code":"", - "code":"20", - "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", - "kw":"Updating the Share Member Status,Backup Sharing,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"UpdateMemberStatus" - } - ], - "title":"Updating the Share Member Status", - "githuburl":"" - }, - { - "uri":"DeleteMember.html", - "node_id":"deletemember.xml", - "product_code":"", - "code":"21", - "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", - "kw":"Deleting a Specified Share Member,Backup Sharing,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"DeleteMember" - } - ], - "title":"Deleting a Specified Share Member", - "githuburl":"" - }, - { - "uri":"ShowMemberDetail.html", - "node_id":"showmemberdetail.xml", - "product_code":"", - "code":"22", - "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", - "kw":"Querying Share Member Details,Backup Sharing,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ShowMemberDetail" - } - ], - "title":"Querying Share Member Details", - "githuburl":"" - }, - { - "uri":"topic_300000005.html", - "node_id":"topic_300000005.xml", - "product_code":"", - "code":"23", + "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", "kw":"Vaults", @@ -429,7 +114,7 @@ "uri":"CreateVault.html", "node_id":"createvault.xml", "product_code":"", - "code":"24", + "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", "kw":"Creating a Vault,Vaults,API Reference", @@ -448,7 +133,7 @@ "uri":"ListVault.html", "node_id":"listvault.xml", "product_code":"", - "code":"25", + "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", "kw":"Querying the Vault List,Vaults,API Reference", @@ -467,7 +152,7 @@ "uri":"ShowVault.html", "node_id":"showvault.xml", "product_code":"", - "code":"26", + "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", "kw":"Querying a Specified Vault,Vaults,API Reference", @@ -486,7 +171,7 @@ "uri":"UpdateVault.html", "node_id":"updatevault.xml", "product_code":"", - "code":"27", + "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", "kw":"Modifying a Vault,Vaults,API Reference", @@ -505,8 +190,8 @@ "uri":"DeleteVault.html", "node_id":"deletevault.xml", "product_code":"", - "code":"28", - "des":"This API is used to delete vaults. Once a vault is deleted, all backups in the vault are cleared.DELETE /v3/{project_id}/vaults/{vault_id}NoneNoneSee Error Codes.", + "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", "kw":"Deleting a Vault,Vaults,API Reference", "search_title":"", @@ -524,7 +209,7 @@ "uri":"AddVaultResource.html", "node_id":"addvaultresource.xml", "product_code":"", - "code":"29", + "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", "kw":"Associating Resources,Vaults,API Reference", @@ -543,7 +228,7 @@ "uri":"AssociateVaultPolicy.html", "node_id":"associatevaultpolicy.xml", "product_code":"", - "code":"30", + "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", "kw":"Applying a Policy to a Vault,Vaults,API Reference", @@ -562,7 +247,7 @@ "uri":"DisassociateVaultPolicy.html", "node_id":"disassociatevaultpolicy.xml", "product_code":"", - "code":"31", + "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", "kw":"Removing a Policy from a Vault,Vaults,API Reference", @@ -581,7 +266,7 @@ "uri":"MigrateVaultResource.html", "node_id":"migratevaultresource.xml", "product_code":"", - "code":"32", + "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", "kw":"Migrating Resources,Vaults,API Reference", @@ -600,7 +285,7 @@ "uri":"RemoveVaultResource.html", "node_id":"removevaultresource.xml", "product_code":"", - "code":"33", + "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", "kw":"Dissociating Resources,Vaults,API Reference", @@ -616,141 +301,65 @@ "githuburl":"" }, { - "uri":"topic_300000006.html", - "node_id":"topic_300000006.xml", + "uri":"topic_300000002.html", + "node_id":"topic_300000002.xml", "product_code":"", - "code":"34", + "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", - "kw":"Tags", + "kw":"API Version Query", "search_title":"", "metedata":[ { "documenttype":"api" } ], - "title":"Tags", + "title":"API Version Query", "githuburl":"" }, { - "uri":"ShowVaultResourceInstances.html", - "node_id":"showvaultresourceinstances.xml", + "uri":"ListVersions.html", + "node_id":"listversions.xml", "product_code":"", - "code":"35", - "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 ", + "code":"18", + "des":"This API is used to query the information of API versions.GET /NoneStatus code: 300NoneNoneSee Error Codes.", "doc_type":"api", - "kw":"Querying Vault Resources,Tags,API Reference", + "kw":"Querying API Versions,API Version Query,API Reference", "search_title":"", "metedata":[ { "opensource":"true", "documenttype":"api", - "operation_id":"ShowVaultResourceInstances" + "operation_id":"ListVersions" } ], - "title":"Querying Vault Resources", + "title":"Querying API Versions", "githuburl":"" }, { - "uri":"ShowVaultProjectTag.html", - "node_id":"showvaultprojecttag.xml", + "uri":"ShowVersion.html", + "node_id":"showversion.xml", "product_code":"", - "code":"36", - "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 cr", + "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", - "kw":"Querying Tags of a Vault Project,Tags,API Reference", + "kw":"Querying a Specified API Version,API Version Query,API Reference", "search_title":"", "metedata":[ { "opensource":"true", "documenttype":"api", - "operation_id":"ShowVaultProjectTag" + "operation_id":"ShowVersion" } ], - "title":"Querying Tags of a Vault Project", + "title":"Querying a Specified API Version", "githuburl":"" }, { - "uri":"CreateVaultTags.html", - "node_id":"createvaulttags.xml", + "uri":"topic_300000003.html", + "node_id":"topic_300000003.xml", "product_code":"", - "code":"37", - "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 exi", - "doc_type":"api", - "kw":"Adding a Tag to an Associated Resource,Tags,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"CreateVaultTags" - } - ], - "title":"Adding a Tag to an Associated Resource", - "githuburl":"" - }, - { - "uri":"ShowVaultTag.html", - "node_id":"showvaulttag.xml", - "product_code":"", - "code":"38", - "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 c", - "doc_type":"api", - "kw":"Querying Tags of an Associated Resource,Tags,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ShowVaultTag" - } - ], - "title":"Querying Tags of an Associated Resource", - "githuburl":"" - }, - { - "uri":"BatchCreateAndDeleteVaultTags.html", - "node_id":"batchcreateanddeletevaulttags.xml", - "product_code":"", - "code":"39", - "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 A", - "doc_type":"api", - "kw":"Batch Adding or Deleting Tags of a Vault,Tags,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"BatchCreateAndDeleteVaultTags" - } - ], - "title":"Batch Adding or Deleting Tags of a Vault", - "githuburl":"" - }, - { - "uri":"DeleteVaultTag.html", - "node_id":"deletevaulttag.xml", - "product_code":"", - "code":"40", - "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", - "kw":"Deleting a Tag from an Associated Resource,Tags,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"DeleteVaultTag" - } - ], - "title":"Deleting a Tag from an Associated Resource", - "githuburl":"" - }, - { - "uri":"topic_300000007.html", - "node_id":"topic_300000007.xml", - "product_code":"", - "code":"41", + "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", "kw":"Policies", @@ -767,7 +376,7 @@ "uri":"ListPolicies.html", "node_id":"listpolicies.xml", "product_code":"", - "code":"42", + "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", "kw":"Querying the Policy List,Policies,API Reference", @@ -786,8 +395,8 @@ "uri":"CreatePolicy.html", "node_id":"createpolicy.xml", "product_code":"", - "code":"43", - "des":"This API is used to create a backup policy.POST /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", + "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", "kw":"Creating a Policy,Policies,API Reference", "search_title":"", @@ -805,7 +414,7 @@ "uri":"UpdatePolicy.html", "node_id":"updatepolicy.xml", "product_code":"", - "code":"44", + "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", "kw":"Modifying a Policy,Policies,API Reference", @@ -824,7 +433,7 @@ "uri":"DeletePolicy.html", "node_id":"deletepolicy.xml", "product_code":"", - "code":"45", + "code":"24", "des":"This API is used to delete a policy.DELETE /v3/{project_id}/policies/{policy_id}NoneNoneSee Error Codes.", "doc_type":"api", "kw":"Deleting a Policy,Policies,API Reference", @@ -843,7 +452,7 @@ "uri":"ShowPolicy.html", "node_id":"showpolicy.xml", "product_code":"", - "code":"46", + "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", "kw":"Querying a Single Policy,Policies,API Reference", @@ -858,6 +467,397 @@ "title":"Querying a Single Policy", "githuburl":"" }, + { + "uri":"topic_300000004.html", + "node_id":"topic_300000004.xml", + "product_code":"", + "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", + "kw":"Backups", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Backups", + "githuburl":"" + }, + { + "uri":"ListBackups.html", + "node_id":"listbackups.xml", + "product_code":"", + "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", + "kw":"Querying All Backups,Backups,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListBackups" + } + ], + "title":"Querying All Backups", + "githuburl":"" + }, + { + "uri":"DeleteBackup.html", + "node_id":"deletebackup.xml", + "product_code":"", + "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", + "kw":"Deleting a Backup,Backups,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteBackup" + } + ], + "title":"Deleting a Backup", + "githuburl":"" + }, + { + "uri":"ShowBackup.html", + "node_id":"showbackup.xml", + "product_code":"", + "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", + "kw":"Querying a Specified Backup,Backups,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowBackup" + } + ], + "title":"Querying a Specified Backup", + "githuburl":"" + }, + { + "uri":"CopyBackup.html", + "node_id":"copybackup.xml", + "product_code":"", + "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", + "kw":"Replicating a Backup,Backups,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CopyBackup" + } + ], + "title":"Replicating a Backup", + "githuburl":"" + }, + { + "uri":"RestoreBackup.html", + "node_id":"restorebackup.xml", + "product_code":"", + "code":"31", + "des":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", + "doc_type":"api", + "kw":"Restoring a Backup,Backups,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"RestoreBackup" + } + ], + "title":"Restoring a Backup", + "githuburl":"" + }, + { + "uri":"topic_300000005.html", + "node_id":"topic_300000005.xml", + "product_code":"", + "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", + "kw":"Protection", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Protection", + "githuburl":"" + }, + { + "uri":"ShowReplicationCapabilities.html", + "node_id":"showreplicationcapabilities.xml", + "product_code":"", + "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", + "kw":"Querying the Replication Capability,Protection,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowReplicationCapabilities" + } + ], + "title":"Querying the Replication Capability", + "githuburl":"" + }, + { + "uri":"topic_300000006.html", + "node_id":"topic_300000006.xml", + "product_code":"", + "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", + "kw":"Backup Sharing", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Backup Sharing", + "githuburl":"" + }, + { + "uri":"AddMember.html", + "node_id":"addmember.xml", + "product_code":"", + "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", + "kw":"Adding a Share Member,Backup Sharing,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"AddMember" + } + ], + "title":"Adding a Share Member", + "githuburl":"" + }, + { + "uri":"ShowMembersDetail.html", + "node_id":"showmembersdetail.xml", + "product_code":"", + "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", + "kw":"Obtaining the Share Member List,Backup Sharing,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowMembersDetail" + } + ], + "title":"Obtaining the Share Member List", + "githuburl":"" + }, + { + "uri":"UpdateMemberStatus.html", + "node_id":"updatememberstatus.xml", + "product_code":"", + "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", + "kw":"Updating the Share Member Status,Backup Sharing,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateMemberStatus" + } + ], + "title":"Updating the Share Member Status", + "githuburl":"" + }, + { + "uri":"DeleteMember.html", + "node_id":"deletemember.xml", + "product_code":"", + "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", + "kw":"Deleting a Specified Share Member,Backup Sharing,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteMember" + } + ], + "title":"Deleting a Specified Share Member", + "githuburl":"" + }, + { + "uri":"ShowMemberDetail.html", + "node_id":"showmemberdetail.xml", + "product_code":"", + "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", + "kw":"Querying Share Member Details,Backup Sharing,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowMemberDetail" + } + ], + "title":"Querying Share Member Details", + "githuburl":"" + }, + { + "uri":"topic_300000007.html", + "node_id":"topic_300000007.xml", + "product_code":"", + "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", + "kw":"Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Tags", + "githuburl":"" + }, + { + "uri":"ShowVaultResourceInstances.html", + "node_id":"showvaultresourceinstances.xml", + "product_code":"", + "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", + "kw":"Querying Vault Resources,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowVaultResourceInstances" + } + ], + "title":"Querying Vault Resources", + "githuburl":"" + }, + { + "uri":"ShowVaultProjectTag.html", + "node_id":"showvaultprojecttag.xml", + "product_code":"", + "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", + "kw":"Querying Tags of a Vault Project,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowVaultProjectTag" + } + ], + "title":"Querying Tags of a Vault Project", + "githuburl":"" + }, + { + "uri":"CreateVaultTags.html", + "node_id":"createvaulttags.xml", + "product_code":"", + "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", + "kw":"Adding a Tag to an Associated Resource,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateVaultTags" + } + ], + "title":"Adding a Tag to an Associated Resource", + "githuburl":"" + }, + { + "uri":"ShowVaultTag.html", + "node_id":"showvaulttag.xml", + "product_code":"", + "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", + "kw":"Querying Tags of an Associated Resource,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowVaultTag" + } + ], + "title":"Querying Tags of an Associated Resource", + "githuburl":"" + }, + { + "uri":"BatchCreateAndDeleteVaultTags.html", + "node_id":"batchcreateanddeletevaulttags.xml", + "product_code":"", + "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", + "kw":"Batch Adding or Deleting Tags of a Vault,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchCreateAndDeleteVaultTags" + } + ], + "title":"Batch Adding or Deleting Tags of a Vault", + "githuburl":"" + }, + { + "uri":"DeleteVaultTag.html", + "node_id":"deletevaulttag.xml", + "product_code":"", + "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", + "kw":"Deleting a Tag from an Associated Resource,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteVaultTag" + } + ], + "title":"Deleting a Tag from an Associated Resource", + "githuburl":"" + }, { "uri":"topic_300000008.html", "node_id":"topic_300000008.xml", diff --git a/docs/cbr/api-ref/AddMember.html b/docs/cbr/api-ref/AddMember.html index adacdde3d..ebfffc2ac 100644 --- a/docs/cbr/api-ref/AddMember.html +++ b/docs/cbr/api-ref/AddMember.html @@ -1,7 +1,7 @@

Adding a Share Member

-

Function

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

+

Function

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

URI

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

@@ -54,7 +54,8 @@

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.

X-User-Profile

@@ -96,45 +97,45 @@

Response Parameters

Status code: 200

-
Table 4 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

members

+

members

Array of Member objects

+

Array of Member objects

Response parameters of adding a backup share member

+

Response parameters of adding a backup share member

count

+

count

Integer

+

Integer

Number of share members that the backup is shared to

+

Number of share members that the backup is shared to

-
Table 5 Member

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - @@ -234,7 +235,7 @@
diff --git a/docs/cbr/api-ref/AddVaultResource.html b/docs/cbr/api-ref/AddVaultResource.html index 438aa0ab0..9f0d5229d 100644 --- a/docs/cbr/api-ref/AddVaultResource.html +++ b/docs/cbr/api-ref/AddVaultResource.html @@ -1,7 +1,7 @@

Associating Resources

-

Function

This API is used to associate resources with a vault.

+

Function

This API is used to associate resources with a vault.

URI

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

@@ -54,7 +54,8 @@
- @@ -162,19 +163,19 @@

Response Parameters

Status code: 200

-
Table 5 Member

Parameter

Type

+

Type

Description

+

Description

status

+

status

String

+

String

Backup sharing status

+

Backup sharing status

Enumeration values:

  • pending

  • accepted

    @@ -142,53 +143,53 @@

created_at

+

created_at

String

+

String

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

+

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

updated_at

+

updated_at

String

+

String

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

+

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

backup_id

+

backup_id

String

+

String

Backup ID

+

Backup ID

image_id

+

image_id

String

+

String

ID of the image created by using the accepted shared backup

+

ID of the image created by using the accepted shared backup

dest_project_id

+

dest_project_id

String

+

String

ID of the project with which the backup is shared

+

ID of the project with which the backup is shared

vault_id

+

vault_id

String

+

String

ID of the vault where the shared backup is stored

+

ID of the vault where the shared backup is stored

id

+

id

String

+

String

ID of the shared record

+

ID of the shared record

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 6 Response body parameters

Parameter

+
- - - - - @@ -220,7 +221,7 @@
diff --git a/docs/cbr/api-ref/AssociateVaultPolicy.html b/docs/cbr/api-ref/AssociateVaultPolicy.html index 51bc2ae4c..557059a9c 100644 --- a/docs/cbr/api-ref/AssociateVaultPolicy.html +++ b/docs/cbr/api-ref/AssociateVaultPolicy.html @@ -1,7 +1,7 @@

Applying a Policy to a Vault

-

Function

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

+

Function

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

URI

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

@@ -54,7 +54,8 @@
- @@ -86,45 +87,45 @@

Response Parameters

Status code: 200

-
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

add_resource_ids

+

add_resource_ids

Array of strings

+

Array of strings

List of resource IDs that have been added

+

List of resource IDs that have been added

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 4 Response body parameters

Parameter

+
- - - - -
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

associate_policy

+

associate_policy

VaultPolicyResp object

+

VaultPolicyResp object

Details of applying a policy to a vault

+

Details of applying a policy to a vault

-
Table 5 VaultPolicyResp

Parameter

+
- - - - - - - - @@ -167,7 +168,7 @@
diff --git a/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html b/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html index 765f4fd5b..a93a6d950 100644 --- a/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html +++ b/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html @@ -1,7 +1,14 @@

Batch Adding or Deleting Tags of a Vault

-

Function

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

+

Function

This API is used to batch add or delete tags for a specified instance.

+

TMS uses this API to manage service resource tags.

+

A resource can have a maximum of 20 tags.

+

This API is idempotent.

+

If there are duplicate keys in the request body when you add tags, an error is reported.

+

If a to-be-added tag has the same key as an existing tag, the tag will be added and will overwrite the existing tag.

+

When deleting tags, duplicate keys are allowed.

+

When deleting tags, if some tags do not exist, the deletion is considered to be successful by default. The character set of the tags will not be verified. A key and a value can each consist of up to 127 and 255 characters. When you delete tags, the tags structure cannot be missing, and the key cannot be left blank or be an empty string.

URI

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

@@ -122,26 +129,26 @@

Response Parameters

Status code: 400

-
Table 5 VaultPolicyResp

Parameter

Type

+

Type

Description

+

Description

policy_id

+

policy_id

String

+

String

Configured policy ID

+

Configured policy ID

vault_id

+

vault_id

String

+

String

Vault ID for configuring the policy ID

+

Vault ID for configuring the policy ID

Table 4 Response body parameters

Parameter

+
- - - - - - - - @@ -190,7 +197,7 @@
diff --git a/docs/cbr/api-ref/CLASS.TXT.json b/docs/cbr/api-ref/CLASS.TXT.json index 397a8bc81..575775397 100644 --- a/docs/cbr/api-ref/CLASS.TXT.json +++ b/docs/cbr/api-ref/CLASS.TXT.json @@ -20,47 +20,20 @@ { "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":"", - "title":"API Version Query", + "title":"Tasks", "uri":"topic_300000000.html", "doc_type":"api", "p_code":"2", "code":"3" }, - { - "desc":"This API is used to query the information of API versions.GET /NoneStatus code: 300NoneNoneSee Error Codes.", - "product_code":"", - "title":"Querying API Versions", - "uri":"ListVersions.html", - "doc_type":"api", - "p_code":"3", - "code":"4" - }, - { - "desc":"This API is used to query the information of a specified API version.GET /{api_version}NoneStatus code: 300NoneNoneSee Error Codes.", - "product_code":"", - "title":"Querying a Specified API Version", - "uri":"ShowVersion.html", - "doc_type":"api", - "p_code":"3", - "code":"5" - }, - { - "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":"", - "title":"Tasks", - "uri":"topic_300000001.html", - "doc_type":"api", - "p_code":"2", - "code":"6" - }, { "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":"", "title":"Querying the Task List", "uri":"ListOpLogs.html", "doc_type":"api", - "p_code":"6", - "code":"7" + "p_code":"3", + "code":"4" }, { "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", @@ -68,143 +41,17 @@ "title":"Querying a Single Task", "uri":"ShowOpLog.html", "doc_type":"api", - "p_code":"6", - "code":"8" - }, - { - "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":"", - "title":"Protection", - "uri":"topic_300000002.html", - "doc_type":"api", - "p_code":"2", - "code":"9" - }, - { - "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":"", - "title":"Querying the Replication Capability", - "uri":"ShowReplicationCapabilities.html", - "doc_type":"api", - "p_code":"9", - "code":"10" - }, - { - "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":"", - "title":"Backups", - "uri":"topic_300000003.html", - "doc_type":"api", - "p_code":"2", - "code":"11" - }, - { - "desc":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"", - "title":"Querying All Backups", - "uri":"ListBackups.html", - "doc_type":"api", - "p_code":"11", - "code":"12" - }, - { - "desc":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.", - "product_code":"", - "title":"Deleting a Backup", - "uri":"DeleteBackup.html", - "doc_type":"api", - "p_code":"11", - "code":"13" - }, - { - "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":"", - "title":"Querying a Specified Backup", - "uri":"ShowBackup.html", - "doc_type":"api", - "p_code":"11", - "code":"14" - }, - { - "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":"", - "title":"Replicating a Backup", - "uri":"CopyBackup.html", - "doc_type":"api", - "p_code":"11", - "code":"15" - }, - { - "desc":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", - "product_code":"", - "title":"Restoring a Backup", - "uri":"RestoreBackup.html", - "doc_type":"api", - "p_code":"11", - "code":"16" - }, - { - "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":"", - "title":"Backup Sharing", - "uri":"topic_300000004.html", - "doc_type":"api", - "p_code":"2", - "code":"17" - }, - { - "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":"", - "title":"Adding a Share Member", - "uri":"AddMember.html", - "doc_type":"api", - "p_code":"17", - "code":"18" - }, - { - "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":"", - "title":"Obtaining the Share Member List", - "uri":"ShowMembersDetail.html", - "doc_type":"api", - "p_code":"17", - "code":"19" - }, - { - "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":"", - "title":"Updating the Share Member Status", - "uri":"UpdateMemberStatus.html", - "doc_type":"api", - "p_code":"17", - "code":"20" - }, - { - "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":"", - "title":"Deleting a Specified Share Member", - "uri":"DeleteMember.html", - "doc_type":"api", - "p_code":"17", - "code":"21" - }, - { - "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":"", - "title":"Querying Share Member Details", - "uri":"ShowMemberDetail.html", - "doc_type":"api", - "p_code":"17", - "code":"22" + "p_code":"3", + "code":"5" }, { "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":"", "title":"Vaults", - "uri":"topic_300000005.html", + "uri":"topic_300000001.html", "doc_type":"api", "p_code":"2", - "code":"23" + "code":"6" }, { "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 ", @@ -212,8 +59,8 @@ "title":"Creating a Vault", "uri":"CreateVault.html", "doc_type":"api", - "p_code":"23", - "code":"24" + "p_code":"6", + "code":"7" }, { "desc":"This API is used to query the vault list.GET /v3/{project_id}/vaultsStatus code: 200Status code: 200OKSee Error Codes.", @@ -221,8 +68,8 @@ "title":"Querying the Vault List", "uri":"ListVault.html", "doc_type":"api", - "p_code":"23", - "code":"25" + "p_code":"6", + "code":"8" }, { "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.", @@ -230,8 +77,8 @@ "title":"Querying a Specified Vault", "uri":"ShowVault.html", "doc_type":"api", - "p_code":"23", - "code":"26" + "p_code":"6", + "code":"9" }, { "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.", @@ -239,17 +86,17 @@ "title":"Modifying a Vault", "uri":"UpdateVault.html", "doc_type":"api", - "p_code":"23", - "code":"27" + "p_code":"6", + "code":"10" }, { - "desc":"This API is used to delete vaults. Once a vault is deleted, all backups in the vault are cleared.DELETE /v3/{project_id}/vaults/{vault_id}NoneNoneSee Error Codes.", + "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":"", "title":"Deleting a Vault", "uri":"DeleteVault.html", "doc_type":"api", - "p_code":"23", - "code":"28" + "p_code":"6", + "code":"11" }, { "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.", @@ -257,8 +104,8 @@ "title":"Associating Resources", "uri":"AddVaultResource.html", "doc_type":"api", - "p_code":"23", - "code":"29" + "p_code":"6", + "code":"12" }, { "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.", @@ -266,8 +113,8 @@ "title":"Applying a Policy to a Vault", "uri":"AssociateVaultPolicy.html", "doc_type":"api", - "p_code":"23", - "code":"30" + "p_code":"6", + "code":"13" }, { "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.", @@ -275,8 +122,8 @@ "title":"Removing a Policy from a Vault", "uri":"DisassociateVaultPolicy.html", "doc_type":"api", - "p_code":"23", - "code":"31" + "p_code":"6", + "code":"14" }, { "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", @@ -284,8 +131,8 @@ "title":"Migrating Resources", "uri":"MigrateVaultResource.html", "doc_type":"api", - "p_code":"23", - "code":"32" + "p_code":"6", + "code":"15" }, { "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.", @@ -293,80 +140,44 @@ "title":"Dissociating Resources", "uri":"RemoveVaultResource.html", "doc_type":"api", - "p_code":"23", - "code":"33" + "p_code":"6", + "code":"16" }, { "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":"", - "title":"Tags", - "uri":"topic_300000006.html", + "title":"API Version Query", + "uri":"topic_300000002.html", "doc_type":"api", "p_code":"2", - "code":"34" + "code":"17" }, { - "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 ", + "desc":"This API is used to query the information of API versions.GET /NoneStatus code: 300NoneNoneSee Error Codes.", "product_code":"", - "title":"Querying Vault Resources", - "uri":"ShowVaultResourceInstances.html", + "title":"Querying API Versions", + "uri":"ListVersions.html", "doc_type":"api", - "p_code":"34", - "code":"35" + "p_code":"17", + "code":"18" }, { - "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 cr", + "desc":"This API is used to query the information of a specified API version.GET /{api_version}NoneStatus code: 300NoneNoneSee Error Codes.", "product_code":"", - "title":"Querying Tags of a Vault Project", - "uri":"ShowVaultProjectTag.html", + "title":"Querying a Specified API Version", + "uri":"ShowVersion.html", "doc_type":"api", - "p_code":"34", - "code":"36" - }, - { - "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 exi", - "product_code":"", - "title":"Adding a Tag to an Associated Resource", - "uri":"CreateVaultTags.html", - "doc_type":"api", - "p_code":"34", - "code":"37" - }, - { - "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 c", - "product_code":"", - "title":"Querying Tags of an Associated Resource", - "uri":"ShowVaultTag.html", - "doc_type":"api", - "p_code":"34", - "code":"38" - }, - { - "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 A", - "product_code":"", - "title":"Batch Adding or Deleting Tags of a Vault", - "uri":"BatchCreateAndDeleteVaultTags.html", - "doc_type":"api", - "p_code":"34", - "code":"39" - }, - { - "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":"", - "title":"Deleting a Tag from an Associated Resource", - "uri":"DeleteVaultTag.html", - "doc_type":"api", - "p_code":"34", - "code":"40" + "p_code":"17", + "code":"19" }, { "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":"", "title":"Policies", - "uri":"topic_300000007.html", + "uri":"topic_300000003.html", "doc_type":"api", "p_code":"2", - "code":"41" + "code":"20" }, { "desc":"This API is used to query the policy list.GET /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", @@ -374,17 +185,17 @@ "title":"Querying the Policy List", "uri":"ListPolicies.html", "doc_type":"api", - "p_code":"41", - "code":"42" + "p_code":"20", + "code":"21" }, { - "desc":"This API is used to create a backup policy.POST /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", + "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":"", "title":"Creating a Policy", "uri":"CreatePolicy.html", "doc_type":"api", - "p_code":"41", - "code":"43" + "p_code":"20", + "code":"22" }, { "desc":"This API is used to modify a policy.PUT /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", @@ -392,8 +203,8 @@ "title":"Modifying a Policy", "uri":"UpdatePolicy.html", "doc_type":"api", - "p_code":"41", - "code":"44" + "p_code":"20", + "code":"23" }, { "desc":"This API is used to delete a policy.DELETE /v3/{project_id}/policies/{policy_id}NoneNoneSee Error Codes.", @@ -401,8 +212,8 @@ "title":"Deleting a Policy", "uri":"DeletePolicy.html", "doc_type":"api", - "p_code":"41", - "code":"45" + "p_code":"20", + "code":"24" }, { "desc":"This API is used to query a single policy.GET /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", @@ -410,7 +221,196 @@ "title":"Querying a Single Policy", "uri":"ShowPolicy.html", "doc_type":"api", - "p_code":"41", + "p_code":"20", + "code":"25" + }, + { + "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":"", + "title":"Backups", + "uri":"topic_300000004.html", + "doc_type":"api", + "p_code":"2", + "code":"26" + }, + { + "desc":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.", + "product_code":"", + "title":"Querying All Backups", + "uri":"ListBackups.html", + "doc_type":"api", + "p_code":"26", + "code":"27" + }, + { + "desc":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.", + "product_code":"", + "title":"Deleting a Backup", + "uri":"DeleteBackup.html", + "doc_type":"api", + "p_code":"26", + "code":"28" + }, + { + "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":"", + "title":"Querying a Specified Backup", + "uri":"ShowBackup.html", + "doc_type":"api", + "p_code":"26", + "code":"29" + }, + { + "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":"", + "title":"Replicating a Backup", + "uri":"CopyBackup.html", + "doc_type":"api", + "p_code":"26", + "code":"30" + }, + { + "desc":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", + "product_code":"", + "title":"Restoring a Backup", + "uri":"RestoreBackup.html", + "doc_type":"api", + "p_code":"26", + "code":"31" + }, + { + "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":"", + "title":"Protection", + "uri":"topic_300000005.html", + "doc_type":"api", + "p_code":"2", + "code":"32" + }, + { + "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":"", + "title":"Querying the Replication Capability", + "uri":"ShowReplicationCapabilities.html", + "doc_type":"api", + "p_code":"32", + "code":"33" + }, + { + "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":"", + "title":"Backup Sharing", + "uri":"topic_300000006.html", + "doc_type":"api", + "p_code":"2", + "code":"34" + }, + { + "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":"", + "title":"Adding a Share Member", + "uri":"AddMember.html", + "doc_type":"api", + "p_code":"34", + "code":"35" + }, + { + "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":"", + "title":"Obtaining the Share Member List", + "uri":"ShowMembersDetail.html", + "doc_type":"api", + "p_code":"34", + "code":"36" + }, + { + "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":"", + "title":"Updating the Share Member Status", + "uri":"UpdateMemberStatus.html", + "doc_type":"api", + "p_code":"34", + "code":"37" + }, + { + "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":"", + "title":"Deleting a Specified Share Member", + "uri":"DeleteMember.html", + "doc_type":"api", + "p_code":"34", + "code":"38" + }, + { + "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":"", + "title":"Querying Share Member Details", + "uri":"ShowMemberDetail.html", + "doc_type":"api", + "p_code":"34", + "code":"39" + }, + { + "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":"", + "title":"Tags", + "uri":"topic_300000007.html", + "doc_type":"api", + "p_code":"2", + "code":"40" + }, + { + "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":"", + "title":"Querying Vault Resources", + "uri":"ShowVaultResourceInstances.html", + "doc_type":"api", + "p_code":"40", + "code":"41" + }, + { + "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":"", + "title":"Querying Tags of a Vault Project", + "uri":"ShowVaultProjectTag.html", + "doc_type":"api", + "p_code":"40", + "code":"42" + }, + { + "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":"", + "title":"Adding a Tag to an Associated Resource", + "uri":"CreateVaultTags.html", + "doc_type":"api", + "p_code":"40", + "code":"43" + }, + { + "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":"", + "title":"Querying Tags of an Associated Resource", + "uri":"ShowVaultTag.html", + "doc_type":"api", + "p_code":"40", + "code":"44" + }, + { + "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":"", + "title":"Batch Adding or Deleting Tags of a Vault", + "uri":"BatchCreateAndDeleteVaultTags.html", + "doc_type":"api", + "p_code":"40", + "code":"45" + }, + { + "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":"", + "title":"Deleting a Tag from an Associated Resource", + "uri":"DeleteVaultTag.html", + "doc_type":"api", + "p_code":"40", "code":"46" }, { diff --git a/docs/cbr/api-ref/CopyBackup.html b/docs/cbr/api-ref/CopyBackup.html index 737ed575f..4efa0af3e 100644 --- a/docs/cbr/api-ref/CopyBackup.html +++ b/docs/cbr/api-ref/CopyBackup.html @@ -1,7 +1,7 @@

Replicating a Backup

-

Function

This API is used to replicate a backup across regions.

+

Function

This API is used to replicate a backup across regions.

URI

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

@@ -54,7 +54,8 @@
- @@ -151,87 +152,87 @@

Response Parameters

Status code: 200

-
Table 4 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

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 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

replication

+

replication

BackupReplicateRespBody object

+

BackupReplicateRespBody object

Replication response parameter

+

Replication response parameter

-
Table 6 BackupReplicateRespBody

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - @@ -286,7 +287,7 @@
diff --git a/docs/cbr/api-ref/CopyCheckpoint.html b/docs/cbr/api-ref/CopyCheckpoint.html index d77d24017..0bd1d1a02 100644 --- a/docs/cbr/api-ref/CopyCheckpoint.html +++ b/docs/cbr/api-ref/CopyCheckpoint.html @@ -1,7 +1,7 @@

Replicating a Restore Point

-

Function

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.

+

Function

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.

URI

POST /v3/{project_id}/checkpoints/replicate

@@ -45,7 +45,8 @@
- @@ -138,112 +139,112 @@

Response Parameters

Status code: 200

-
Table 6 BackupReplicateRespBody

Parameter

Type

+

Type

Description

+

Description

backup_id

+

backup_id

String

+

String

ID of the source backup used for replication

+

ID of the source backup used for replication

destination_project_id

+

destination_project_id

String

+

String

ID of the replication destination project

+

ID of the replication destination project

destination_region

+

destination_region

String

+

String

Replication destination region

+

Replication destination region

destination_vault_id

+

destination_vault_id

String

+

String

ID of the vault in the replication destination region

+

ID of the vault in the replication destination region

project_id

+

project_id

String

+

String

ID of the project where replication is performed

+

ID of the project where replication is performed

provider_id

+

provider_id

String

+

String

Resource type ID

+

Resource type ID

replication_record_id

+

replication_record_id

String

+

String

Replication record ID

+

Replication record ID

source_region

+

source_region

String

+

String

Replication source region

+

Replication source region

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 5 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

replication

+

replication

CheckpointReplicateRespBody object

+

CheckpointReplicateRespBody object

-
Table 6 CheckpointReplicateRespBody

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 CheckpointReplicateRespBody

Parameter

Type

+

Type

Description

+

Description

backups

+

backups

Array of CheckpointReplicateRespbackups objects

+

Array of CheckpointReplicateRespbackups objects

List of backups to be replicated

+

List of backups to be replicated

destination_project_id

+

destination_project_id

String

+

String

ID of the replication destination project

+

ID of the replication destination project

destination_region

+

destination_region

String

+

String

Replication destination region

+

Replication destination region

destination_vault_id

+

destination_vault_id

String

+

String

ID of the vault in the replication destination region

+

ID of the vault in the replication destination region

project_id

+

project_id

String

+

String

ID of the project where replication is performed

+

ID of the project where replication is performed

provider_id

+

provider_id

String

+

String

Backup provider ID, which specifies whether the backup object is a server or disk

+

Backup provider ID, which specifies whether the backup object is a server or disk

source_region

+

source_region

String

+

String

Replication source region

+

Replication source region

vault_id

+

vault_id

String

+

String

Vault ID

+

Vault ID

-
Table 7 CheckpointReplicateRespbackups

Parameter

+
- - - - - - - - diff --git a/docs/cbr/api-ref/CreateCheckpoint.html b/docs/cbr/api-ref/CreateCheckpoint.html index 9be84e91f..e24e70673 100644 --- a/docs/cbr/api-ref/CreateCheckpoint.html +++ b/docs/cbr/api-ref/CreateCheckpoint.html @@ -1,7 +1,7 @@

Creating a Restore Point

-

Function

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

+

Function

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

URI

POST /v3/{project_id}/checkpoints

@@ -45,7 +45,8 @@
- @@ -259,59 +260,59 @@

Response Parameters

Status code: 200

-
Table 7 CheckpointReplicateRespbackups

Parameter

Type

+

Type

Description

+

Description

backup_id

+

backup_id

String

+

String

ID of the source backup used for replication

+

ID of the source backup used for replication

replication_record_id

+

replication_record_id

String

+

String

Replication record ID

+

Replication record ID

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 8 Response body parameters

Parameter

+
- - - - -
Table 8 Response body parameters

Parameter

Type

+

Type

Description

+

Description

checkpoint

+

checkpoint

CheckpointCreate object

+

CheckpointCreate object

Restore point information

+

Restore point information

-
Table 9 CheckpointCreate

Parameter

+
- - - - - - - - - - - - - - - - - - - -
Table 9 CheckpointCreate

Parameter

Type

+

Type

Description

+

Description

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

id

+

id

String

+

String

Restore point ID

+

Restore point ID

project_id

+

project_id

String

+

String

Project ID

+

Project ID

status

+

status

String

+

String

Status

+

Status

Enumeration values:

  • available

  • deleting

    @@ -322,98 +323,98 @@

vault

+

vault

CheckpointPlanCreate object

+

CheckpointPlanCreate object

Vault information

+

Vault information

extra_info

+

extra_info

CheckpointExtraInfoResp object

+

CheckpointExtraInfoResp object

Extended information

+

Extended information

-
Table 10 CheckpointPlanCreate

Parameter

+
- - - - - - - - - - - - - -
Table 10 CheckpointPlanCreate

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Vault ID

+

Vault ID

name

+

name

String

+

String

Vault name

+

Vault name

resources

+

resources

Array of CheckpointResourceResp objects

+

Array of CheckpointResourceResp objects

Backup objects

+

Backup objects

skipped_resources

+

skipped_resources

Array of CheckpointCreateSkippedResource objects

+

Array of CheckpointCreateSkippedResource objects

Resources skipped during backup

+

Resources skipped during backup

-
Table 11 CheckpointResourceResp

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 11 CheckpointResourceResp

Parameter

Type

+

Type

Description

+

Description

extra_info

+

extra_info

String

+

String

Extra information of the resource

+

Extra information of the resource

id

+

id

String

+

String

ID of the resource to be backed up

+

ID of the resource to be backed up

name

+

name

String

+

String

Name of the resource to be backed up

+

Name of the resource to be backed up

protect_status

+

protect_status

String

+

String

Protected status

+

Protected status

Enumeration values:

  • available

  • error

    @@ -423,112 +424,112 @@

resource_size

+

resource_size

String

+

String

Allocated capacity for the associated resource, in GB

+

Allocated capacity for the associated resource, 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

String

+

String

Backup size

+

Backup size

backup_count

+

backup_count

String

+

String

Number of backups

+

Number of backups

-
Table 12 CheckpointCreateSkippedResource

Parameter

+
- - - - - - - - - - - - - - - - -
Table 12 CheckpointCreateSkippedResource

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Resource ID

+

Resource ID

type

+

type

String

+

String

Resource type

+

Resource type

name

+

name

String

+

String

Resource name

+

Resource name

code

+

code

String

+

String

For details, see Error Codes.

+

For details, see Error Codes.

reason

+

reason

String

+

String

Reason for the skipping. For example, the resource is being backed up.

+

Reason for the skipping. For example, the resource is being backed up.

-
Table 13 CheckpointExtraInfoResp

Parameter

+
- - - - - - - - - - - diff --git a/docs/cbr/api-ref/CreatePolicy.html b/docs/cbr/api-ref/CreatePolicy.html index 87e01f860..60ac75fba 100644 --- a/docs/cbr/api-ref/CreatePolicy.html +++ b/docs/cbr/api-ref/CreatePolicy.html @@ -1,561 +1,562 @@

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 13 CheckpointExtraInfoResp

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Backup name

+

Backup name

description

+

description

String

+

String

Backup description

+

Backup description

retention_duration

+

retention_duration

Integer

+

Integer

Number of days that backups can be retained

+

Number of days that backups can be retained

Table 1 Path Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID

-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

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

+

User token

+

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

-
Table 3 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

policy

+

policy

Yes

+

Yes

PolicyCreate object

+

PolicyCreate object

Request body for creating a policy

+

Request body for creating a policy

-
Table 4 PolicyCreate

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

enabled

+

enabled

No

+

No

Boolean

+

Boolean

Whether to enable the policy

-

Default: true

+

Whether to enable the policy

+

Default: true

name

+

name

Yes

+

Yes

String

+

String

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

-

Minimum: 1

-

Maximum: 64

+

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

+

Minimum: 1

+

Maximum: 64

operation_definition

+

operation_definition

Yes

+

Yes

PolicyoODCreate object

+

PolicyoODCreate object

Scheduling parameter

+

Scheduling parameter

operation_type

+

operation_type

Yes

+

Yes

String

+

String

Protection type, which can be backup or replication

+

Protection type, which can be backup or replication

trigger

+

trigger

Yes

+

Yes

PolicyTriggerReq object

+

PolicyTriggerReq object

Time rule for the policy execution

+

Time rule for the policy execution

-
Table 5 PolicyoODCreate

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

day_backups

+

day_backups

No

+

No

Integer

+

Integer

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

-

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

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

+

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

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

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

month_backups

+

month_backups

No

+

No

Integer

+

Integer

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

-

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. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently. This parameter cannot be configured if max_backups, day_backups, week_backups, month_backups, or year_backups is configured.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

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+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

+

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

week_backups

+

week_backups

No

+

No

Integer

+

Integer

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

+

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

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

-

Minimum: 0

-

Maximum: 100

+

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

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

-

Minimum: 0

-

Maximum: 100

+

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

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

+

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 retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Maximum number of 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

month_backups

+

month_backups

Integer

+

Integer

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

-

Minimum: 0

-

Maximum: 100

+

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. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Duration of retaining a backup, in days. The maximum value is 99999. 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+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

+

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

week_backups

+

week_backups

Integer

+

Integer

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

+

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

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

-

Minimum: 0

-

Maximum: 100

+

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

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" : {
    @@ -565,7 +566,7 @@
           "day_backups" : 0,
           "month_backups" : 0,
           "retention_duration_days" : 1,
    -      "timezone" : "UTC+08:00",
    +      "timezone" : "UTC+01:00",
           "week_backups" : 0,
           "year_backups" : 0
         },
    @@ -577,10 +578,35 @@
         }
       }
     }
    +
  • 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" : {
    +    "enabled" : true,
    +    "name" : "policy002",
    +    "operation_definition" : {
    +      "retention_duration_days" : 1,
    +      "day_backups" : 0,
    +      "week_backups" : 0,
    +      "month_backups" : 0,
    +      "year_backups" : 0,
    +      "timezone" : "UTC+01:00",
    +      "destination_region" : "eu-nl",
    +      "destination_project_id" : "fcf6cb26c3bf4402869792207ad3dce4"
    +    },
    +    "operation_type" : "replication",
    +    "trigger" : {
    +      "properties" : {
    +        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ]
    +      }
    +    }
    +  }
    +}
    +
-

Example Responses

Status code: 200

-

OK

-
{
+

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,
    @@ -599,35 +625,63 @@
           "day_backups" : 0,
           "month_backups" : 0,
           "week_backups" : 0,
    -      "timezone" : "UTC+08:00"
    +      "timezone" : "UTC+01:00"
         },
         "operation_type" : "backup",
         "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.
    {
    +  "policy" : {
    +    "name" : "policy002",
    +    "enabled" : true,
    +    "trigger" : {
    +      "id" : "b37cf79e-5cfa-4a84-99a3-91d60a314c46",
    +      "name" : "default",
    +      "type" : "time",
    +      "properties" : {
    +        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
    +        "start_time" : "2019-05-08T06:58:05.000+00:00"
    +      }
    +    },
    +    "operation_definition" : {
    +      "retention_duration_days" : 1,
    +      "day_backups" : 0,
    +      "week_backups" : 0,
    +      "month_backups" : 0,
    +      "year_backups" : 0,
    +      "timezone" : "UTC+01:00",
    +      "destination_region" : "eu-nl",
    +      "destination_project_id" : "fcf6cb26c3bf4402869792207ad3dce4"
    +    },
    +    "operation_type" : "replication",
    +    "id" : "e47e4916-481a-4d10-95a2-165bcfe598c5"
    +  }
    +}
    +
-

Status Codes

-
- @@ -141,7 +142,10 @@ - + + + + +

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/CreateVault.html b/docs/cbr/api-ref/CreateVault.html index 20ce669e4..39c482a26 100644 --- a/docs/cbr/api-ref/CreateVault.html +++ b/docs/cbr/api-ref/CreateVault.html @@ -1,7 +1,7 @@

Creating a Vault

-

Function

This API is used to create a vault.

+

Function

This API is used to create a vault.

URI

POST /v3/{project_id}/vaults

@@ -45,7 +45,8 @@

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.

Array of Tag objects

Tag list This list cannot be an empty list. The list can contain up to 20 keys. Keys in this list must be unique.

+

Tag list

+

This list cannot be an empty list.

+

The list can contain up to 20 keys.

+

Keys in this list must be unique.

auto_bind

@@ -162,6 +166,15 @@

Rules for automatic association

locked

+

No

+

Boolean

+

Whether the vault is locked. A locked vault cannot be unlocked.

+
@@ -445,217 +458,232 @@

Response Parameters

Status code: 200

-
Table 11 Response body parameters

Parameter

+
- - - - -
Table 11 Response body parameters

Parameter

Type

+

Type

Description

+

Description

vault

+

vault

VaultCreateResource object

+

VaultCreateResource object

Objects returned after a vault query

+

Objects returned after a vault query

-
Table 12 VaultCreateResource

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
Table 12 VaultCreateResource

Parameter

Type

+

Type

Description

+

Description

billing

+

billing

Billing object

+

Billing object

Operations information

+

Operations information

description

+

description

String

+

String

User-defined vault description

+

User-defined vault description

Minimum: 0

Maximum: 255

id

+

id

String

+

String

Vault ID

+

Vault ID

name

+

name

String

+

String

Vault name

+

Vault name

Minimum: 1

Maximum: 64

project_id

+

project_id

String

+

String

Project ID

+

Project ID

provider_id

+

provider_id

String

+

String

ID of the vault resource type

+

ID of the vault resource type

resources

+

resources

Array of ResourceResp objects

+

Array of ResourceResp objects

Vault resources

+

Vault resources

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Vault tags

+

Vault tags

auto_bind

+

auto_bind

Boolean

+

Boolean

Whether to enable automatic association. Its default value is false (not enable).

+

Whether to enable automatic association. Its default value is false (not enable).

bind_rules

+

bind_rules

VaultBindRules object

+

VaultBindRules object

Association rules

+

Association rules

user_id

+

user_id

String

+

String

User ID

+

User ID

created_at

+

created_at

String

+

String

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

+

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

auto_expand

+

auto_expand

Boolean

+

Boolean

Whether to enable auto capacity expansion for the vault.

+

Whether to enable auto capacity expansion for the vault.

+

sys_lock_source_service

+

String

+

Used to identify the SMB service. You can set the parameter to SMB or leave it blank.

+

locked

+

Boolean

+

Whether the vault is locked. A locked vault cannot be unlocked.

-
Table 13 Billing

Parameter

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

Parameter

Type

+

Type

Description

+

Description

allocated

+

allocated

Integer

+

Integer

Allocated capacity, in GB.

+

Allocated capacity, in GB.

charging_mode

+

charging_mode

String

+

String

Billing mode, which is post_paid

+

Billing mode, which is post_paid

cloud_type

+

cloud_type

String

+

String

Cloud type, which is public

+

Cloud type, which is public

consistent_level

+

consistent_level

String

+

String

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

+

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

object_type

+

object_type

String

+

String

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

+

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

order_id

+

order_id

String

+

String

Order ID

+

Order ID

product_id

+

product_id

String

+

String

Product ID

+

Product ID

protect_type

+

protect_type

String

+

String

Protection type, which can be backup or replication

+

Protection type, which can be backup or replication

size

+

size

Integer

+

Integer

Capacity, in GB

+

Capacity, in GB

Minimum: 1

Maximum: 10485760

spec_code

+

spec_code

String

+

String

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

+

Specification code

+

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

status

+

status

String

+

String

Vault status

+

Vault status

Enumeration values:

  • available

  • lock

    @@ -665,67 +693,67 @@

storage_unit

+

storage_unit

String

+

String

Name of the bucket for the vault

+

Name of the bucket for the vault

used

+

used

Integer

+

Integer

Used capacity, in MB.

+

Used capacity, in MB.

frozen_scene

+

frozen_scene

String

+

String

Scenario when an account is frozen

+

Scenario when an account is frozen

-
Table 14 ResourceResp

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 14 ResourceResp

Parameter

Type

+

Type

Description

+

Description

extra_info

+

extra_info

ResourceExtraInfo object

+

ResourceExtraInfo object

Additional information of the resource

+

Additional information of the resource

id

+

id

String

+

String

ID of the resource to be backed up

+

ID of the resource to be backed up

name

+

name

String

+

String

Name of the resource to be backed up

+

Name of the resource to be backed up

Minimum: 0

Maximum: 255

protect_status

+

protect_status

String

+

String

Protection status

+

Protection status

Enumeration values:

  • available

  • error

    @@ -735,70 +763,70 @@

size

+

size

Integer

+

Integer

Allocated capacity for the associated resources, in GB

+

Allocated capacity for the associated resources, in GB

type

+

type

String

+

String

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

+

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

backup_size

+

backup_size

Integer

+

Integer

Backup size

+

Backup size

backup_count

+

backup_count

Integer

+

Integer

Number of backups

+

Number of backups

-
Table 15 ResourceExtraInfo

Parameter

+
- - - - -
Table 15 ResourceExtraInfo

Parameter

Type

+

Type

Description

+

Description

exclude_volumes

+

exclude_volumes

Array of strings

+

Array of strings

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

+

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

-
Table 16 Tag

Parameter

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

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Key

+

Key

It can contain a maximum of 36 characters.

It cannot be an empty string.

Spaces before and after a key will be discarded.

@@ -806,11 +834,11 @@

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

value

+

value

String

+

String

Value

+

Value

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

It can contain a maximum of 43 characters.

It can be an empty string.

@@ -823,46 +851,46 @@
-
Table 17 VaultBindRules

Parameter

+
- - - - -
Table 17 VaultBindRules

Parameter

Type

+

Type

Description

+

Description

tags

+

tags

Array of BindRulesTags objects

+

Array of BindRulesTags objects

Filters automatically associated resources by tag.

+

Filters automatically associated resources by tag.

-
Table 18 BindRulesTags

Parameter

+
- - - - - - - - @@ -871,26 +899,26 @@

Status code: 400

-
Table 18 BindRulesTags

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

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

+

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

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

Table 19 Response body parameters

Parameter

+
- - - - - - - - @@ -1020,7 +1048,7 @@
diff --git a/docs/cbr/api-ref/CreateVaultTags.html b/docs/cbr/api-ref/CreateVaultTags.html index 9425895f1..cb47e8b61 100644 --- a/docs/cbr/api-ref/CreateVaultTags.html +++ b/docs/cbr/api-ref/CreateVaultTags.html @@ -1,7 +1,8 @@

Adding a Tag to an Associated Resource

-

Function

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

+

Function

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 existing tag, the tag will be added and will overwrite the existing tag.

URI

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

@@ -106,26 +107,26 @@

Response Parameters

Status code: 400

-
Table 19 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

For details, see Error Codes.

+

For details, see Error Codes.

error_msg

+

error_msg

String

+

String

Error message

+

Error message

Table 4 Response body parameters

Parameter

+
- - - - - - - - @@ -170,7 +171,7 @@
diff --git a/docs/cbr/api-ref/DeleteBackup.html b/docs/cbr/api-ref/DeleteBackup.html index fafc28b88..d663384f1 100644 --- a/docs/cbr/api-ref/DeleteBackup.html +++ b/docs/cbr/api-ref/DeleteBackup.html @@ -1,7 +1,7 @@

Deleting a Backup

-

Function

This API is used to delete a single backup.

+

Function

This API is used to delete a single backup.

URI

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

@@ -54,7 +54,8 @@
- @@ -88,7 +89,7 @@
diff --git a/docs/cbr/api-ref/DeleteMember.html b/docs/cbr/api-ref/DeleteMember.html index 4497168ea..9ebc11d44 100644 --- a/docs/cbr/api-ref/DeleteMember.html +++ b/docs/cbr/api-ref/DeleteMember.html @@ -1,7 +1,7 @@

Deleting a Specified Share Member

-

Function

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

+

Function

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

URI

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

@@ -63,7 +63,8 @@
- @@ -97,7 +98,7 @@
diff --git a/docs/cbr/api-ref/DeletePolicy.html b/docs/cbr/api-ref/DeletePolicy.html index d303a6adb..101d0f6cd 100644 --- a/docs/cbr/api-ref/DeletePolicy.html +++ b/docs/cbr/api-ref/DeletePolicy.html @@ -1,7 +1,7 @@

Deleting a Policy

-

Function

This API is used to delete a policy.

+

Function

This API is used to delete a policy.

URI

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

@@ -54,7 +54,8 @@
- @@ -88,7 +89,7 @@
diff --git a/docs/cbr/api-ref/DeleteVault.html b/docs/cbr/api-ref/DeleteVault.html index dc1cb5943..557b4da43 100644 --- a/docs/cbr/api-ref/DeleteVault.html +++ b/docs/cbr/api-ref/DeleteVault.html @@ -1,7 +1,7 @@

Deleting a Vault

-

Function

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

+

Function

Deleting a vault. Once a vault is deleted, all backups in the vault will be deleted.

URI

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

@@ -54,7 +54,8 @@
- @@ -88,7 +89,7 @@
diff --git a/docs/cbr/api-ref/DeleteVaultTag.html b/docs/cbr/api-ref/DeleteVaultTag.html index f9ab749c1..f386599c9 100644 --- a/docs/cbr/api-ref/DeleteVaultTag.html +++ b/docs/cbr/api-ref/DeleteVaultTag.html @@ -1,7 +1,7 @@

Deleting a Tag from an Associated Resource

-

Function

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

+

Function

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

URI

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

@@ -21,7 +21,8 @@
-
Table 4 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

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.

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.

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.

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.

String

The key cannot be left blank or be an empty string. The key length and character set are not verified. Keys are verified and used after the spaces before and after them are deleted. Even invalid tags at the bottom layer can be deleted.

+

The key cannot be left blank or be an empty string. The key length and character set are not verified. Keys are verified and used after the spaces before and after them are deleted.

+

Even invalid tags at the bottom layer can be deleted.

project_id

@@ -50,26 +51,26 @@

Response Parameters

Status code: 400

-
Table 2 Response body parameters

Parameter

+
- - - - - - - - @@ -106,7 +107,7 @@
diff --git a/docs/cbr/api-ref/DisassociateVaultPolicy.html b/docs/cbr/api-ref/DisassociateVaultPolicy.html index ef38e81b8..fa90279de 100644 --- a/docs/cbr/api-ref/DisassociateVaultPolicy.html +++ b/docs/cbr/api-ref/DisassociateVaultPolicy.html @@ -1,7 +1,7 @@

Removing a Policy from a Vault

-

Function

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

+

Function

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

URI

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

@@ -54,7 +54,8 @@
- @@ -86,45 +87,45 @@

Response Parameters

Status code: 200

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

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 4 Response body parameters

Parameter

+
- - - - -
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

dissociate_policy

+

dissociate_policy

VaultPolicyResp object

+

VaultPolicyResp object

Details of removing a policy from a vault

+

Details of removing a policy from a vault

-
Table 5 VaultPolicyResp

Parameter

+
- - - - - - - - @@ -167,7 +168,7 @@
diff --git a/docs/cbr/api-ref/ListBackups.html b/docs/cbr/api-ref/ListBackups.html index ebf3c943d..98d8d13a6 100644 --- a/docs/cbr/api-ref/ListBackups.html +++ b/docs/cbr/api-ref/ListBackups.html @@ -1,7 +1,7 @@

Querying All Backups

-

Function

This API is used to query all backups.

+

Function

This API is used to query all backups.

URI

GET /v3/{project_id}/backups

@@ -208,7 +208,8 @@
- - @@ -269,42 +271,42 @@

Response Parameters

Status code: 200

-
Table 5 VaultPolicyResp

Parameter

Type

+

Type

Description

+

Description

policy_id

+

policy_id

String

+

String

Configured policy ID

+

Configured policy ID

vault_id

+

vault_id

String

+

String

Vault ID for configuring the policy ID

+

Vault ID for configuring the policy ID

String

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

+

Status

+

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

Enumeration values:

  • available

  • protecting

    @@ -260,7 +261,8 @@

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 4 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

backups

+

backups

Array of BackupResp objects

+

Array of BackupResp objects

Backup list

+

Backup list

count

+

count

Integer

+

Integer

Number of backups

+

Number of backups

offset

+

offset

Integer

+

Integer

Offset where the query starts

+

Offset where the query starts

Minimum: 0

Default: 0

limit

+

limit

Integer

+

Integer

Number of records displayed on each page

+

Number of records displayed on each page

Minimum: 1

Maximum: 1000

Default: 1000

@@ -314,131 +316,131 @@
-
Table 5 BackupResp

Parameter

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

Parameter

Type

+

Type

Description

+

Description

checkpoint_id

+

checkpoint_id

String

+

String

Restore point ID

+

Restore point ID

created_at

+

created_at

String

+

String

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

+

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

description

+

description

String

+

String

Backup description

+

Backup description

expired_at

+

expired_at

String

+

String

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

+

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

extend_info

+

extend_info

BackupExtendInfo object

+

BackupExtendInfo object

Extended information

+

Extended information

id

+

id

String

+

String

Backup ID

+

Backup ID

image_type

+

image_type

String

+

String

Backup type, which is backup.

+

Backup type, which is backup.

name

+

name

String

+

String

Backup name

+

Backup name

parent_id

+

parent_id

String

+

String

Parent backup ID

+

Parent backup ID

project_id

+

project_id

String

+

String

Project ID

+

Project ID

protected_at

+

protected_at

String

+

String

Backup time

+

Backup time

resource_az

+

resource_az

String

+

String

Resource availability zone

+

Resource availability zone

resource_id

+

resource_id

String

+

String

Resource ID

+

Resource ID

resource_name

+

resource_name

String

+

String

Resource name

+

Resource name

resource_size

+

resource_size

Integer

+

Integer

Resource size, in GB

+

Resource size, in GB

resource_type

+

resource_type

String

+

String

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

+

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

status

+

status

String

+

String

Backup status

+

Backup status

Enumeration values:

  • available

  • protecting

    @@ -451,87 +453,87 @@

updated_at

+

updated_at

String

+

String

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

+

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

vault_id

+

vault_id

String

+

String

Vault ID

+

Vault ID

provider_id

+

provider_id

String

+

String

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

+

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

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

children

+

children

Array of BackupResp objects

+

Array of BackupResp objects

Backup list

+

Backup list

-
Table 6 BackupExtendInfo

Parameter

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

Parameter

Type

+

Type

Description

+

Description

auto_trigger

+

auto_trigger

Boolean

+

Boolean

Whether the backup is automatically generated

+

Whether the backup is automatically generated

bootable

+

bootable

Boolean

+

Boolean

Whether the backup is a system disk backup

+

Whether the backup is a system disk backup

incremental

+

incremental

Boolean

+

Boolean

Whether the backup is an incremental backup

+

Whether the backup is an incremental backup

snapshot_id

+

snapshot_id

String

+

String

Snapshot ID of the disk backup

+

Snapshot ID of the disk backup

support_lld

+

support_lld

Boolean

+

Boolean

Whether to allow lazyloading for fast restoration

+

Whether to allow lazyloading for fast restoration

supported_restore_mode

+

supported_restore_mode

String

+

String

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

+

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

Default: na

Enumeration values:

  • na

    @@ -540,51 +542,51 @@

os_images_data

+

os_images_data

Array of ImageData objects

+

Array of ImageData objects

ID list of images created using backups

+

ID list of images created using backups

contain_system_disk

+

contain_system_disk

Boolean

+

Boolean

Whether the VM backup data contains system disk data

+

Whether the VM backup data contains system disk data

encrypted

+

encrypted

Boolean

+

Boolean

Whether the backup is encrypted

+

Whether the backup is encrypted

system_disk

+

system_disk

Boolean

+

Boolean

Whether the disk is a system disk

+

Whether the disk is a system disk

-
Table 7 ImageData

Parameter

+
- - - - - @@ -674,7 +676,7 @@
diff --git a/docs/cbr/api-ref/ListOpLogs.html b/docs/cbr/api-ref/ListOpLogs.html index 2be0c2c9a..e890808cb 100644 --- a/docs/cbr/api-ref/ListOpLogs.html +++ b/docs/cbr/api-ref/ListOpLogs.html @@ -1,7 +1,7 @@

Querying the Task List

-

Function

This API is used to query the task list.

+

Function

This API is used to query the task list.

URI

GET /v3/{project_id}/operation-logs

@@ -176,7 +176,8 @@
- @@ -185,43 +186,43 @@

Response Parameters

Status code: 200

-
Table 7 ImageData

Parameter

Type

+

Type

Description

+

Description

image_id

+

image_id

String

+

String

Image ID

+

Image ID

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 4 Response body parameters

Parameter

+
- - - - - - - - - - - - - - @@ -230,61 +231,61 @@
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

operation_logs

+

operation_logs

Array of OperationLog objects

+

Array of OperationLog objects

Task list

+

Task list

count

+

count

Integer

+

Integer

Number of tasks

+

Number of tasks

limit

+

limit

Integer

+

Integer

Number of records displayed on each page

+

Number of records displayed on each page

Minimum: 1

Maximum: 1000

Default: 1000

offset

+

offset

Integer

+

Integer

Offset where the query starts

+

Offset where the query starts

Minimum: 0

Default: 0

-
Table 5 OperationLog

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 OperationLog

Parameter

Type

+

Type

Description

+

Description

checkpoint_id

+

checkpoint_id

String

+

String

Backup record ID

+

Backup record ID

created_at

+

created_at

String

+

String

Creation time, for example, 2020-02-23T01:00:32Z

+

Creation time, for example, 2020-02-23T01:00:32Z

ended_at

+

ended_at

String

+

String

Task end time, for example, 2020-02-23T01:00:32Z

+

Task end time, for example, 2020-02-23T01:00:32Z

error_info

+

error_info

OpErrorInfo object

+

OpErrorInfo object

Task error message

+

Task error message

extra_info

+

extra_info

OpExtraInfo object

+

OpExtraInfo object

Task extension information

+

Task extension information

id

+

id

String

+

String

Task ID

+

Task ID

operation_type

+

operation_type

String

+

String

Task type

+

Task type

Enumeration values:

  • backup

  • restore

    @@ -295,39 +296,39 @@

policy_id

+

policy_id

String

+

String

Policy ID

+

Policy ID

project_id

+

project_id

String

+

String

Project ID

+

Project ID

provider_id

+

provider_id

String

+

String

Backup provider ID, which specifies whether the backup object is a server or disk

+

Backup provider ID, which specifies whether the backup object is a server or disk

started_at

+

started_at

String

+

String

Task start time, for example, 2020-02-23T01:00:32Z

+

Task start time, for example, 2020-02-23T01:00:32Z

status

+

status

String

+

String

Task status

+

Task status

Enumeration values:

  • success

  • skipped

    @@ -338,152 +339,152 @@

updated_at

+

updated_at

String

+

String

Modification time, for example, 2020-02-23T01:00:32Z

+

Modification time, for example, 2020-02-23T01:00:32Z

vault_id

+

vault_id

String

+

String

ID of the vault with which the target resource is associated

+

ID of the vault with which the target resource is associated

vault_name

+

vault_name

String

+

String

Name of the vault with which the target resource is associated

+

Name of the vault with which the target resource is associated

-
Table 6 OpErrorInfo

Parameter

+
- - - - - - - -
Table 6 OpErrorInfo

Parameter

Type

+

Type

Description

+

Description

code

+

code

String

+

String

For details, see Error Codes.

+

For details, see Error Codes.

message

+

message

String

+

String

Error message

+

Error message

-
Table 7 OpExtraInfo

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 OpExtraInfo

Parameter

Type

+

Type

Description

+

Description

backup

+

backup

OpExtendInfoBckup object

+

OpExtendInfoBckup object

Extended parameters of backup

+

Extended parameters of backup

common

+

common

OpExtendInfoCommon object

+

OpExtendInfoCommon object

Common parameters

+

Common parameters

delete

+

delete

OpExtendInfoDelete object

+

OpExtendInfoDelete object

Extended parameters of deletion

+

Extended parameters of deletion

sync

+

sync

OpExtendInfoSync object

+

OpExtendInfoSync object

Extended parameters of synchronization

+

Extended parameters of synchronization

remove_resources

+

remove_resources

OpExtendInfoRemoveResources object

+

OpExtendInfoRemoveResources object

Extended parameters of removing resources from a vault

+

Extended parameters of removing resources from a vault

resource

+

resource

Resource object

+

Resource object

Resource information

+

Resource information

restore

+

restore

OpExtendInfoRestore object

+

OpExtendInfoRestore object

Extended parameters of restoration

+

Extended parameters of restoration

vault_delete

+

vault_delete

OpExtendInfoVaultDelete object

+

OpExtendInfoVaultDelete object

Extended parameters of deleting a vault

+

Extended parameters of deleting a vault

-
Table 8 OpExtendInfoBckup

Parameter

+
- - - - - - - - - - -
Table 8 OpExtendInfoBckup

Parameter

Type

+

Type

Description

+

Description

backup_id

+

backup_id

String

+

String

Backup ID

+

Backup ID

backup_name

+

backup_name

String

+

String

Backup name

+

Backup name

incremental

+

incremental

String

+

String

Whether incremental backup is used

+

Whether incremental backup is used

Enumeration values:

  • "true"

  • "false"

    @@ -494,254 +495,254 @@
-
Table 9 OpExtendInfoCommon

Parameter

+
- - - - - - - - - - -
Table 9 OpExtendInfoCommon

Parameter

Type

+

Type

Description

+

Description

progress

+

progress

Integer

+

Integer

Progress of the query task. The value ranges from 0 to 100.

+

Progress of the query task. The value ranges from 0 to 100.

Minimum: 0

Maximum: 100

request_id

+

request_id

String

+

String

Request ID

+

Request ID

task_id

+

task_id

String

+

String

Backup task ID

+

Backup task ID

-
Table 10 OpExtendInfoDelete

Parameter

+
- - - - - - - -
Table 10 OpExtendInfoDelete

Parameter

Type

+

Type

Description

+

Description

backup_id

+

backup_id

String

+

String

Backup ID

+

Backup ID

backup_name

+

backup_name

String

+

String

Backup name

+

Backup name

-
Table 11 OpExtendInfoSync

Parameter

+
- - - - - - - - - - -
Table 11 OpExtendInfoSync

Parameter

Type

+

Type

Description

+

Description

sync_backup_num

+

sync_backup_num

Integer

+

Integer

Number of synchronized backups

+

Number of synchronized backups

delete_backup_num

+

delete_backup_num

Integer

+

Integer

Number of deleted backups

+

Number of deleted backups

err_sync_backup_num

+

err_sync_backup_num

Integer

+

Integer

Number of backups that failed to be synchronized

+

Number of backups that failed to be synchronized

-
Table 12 OpExtendInfoRemoveResources

Parameter

+
- - - - - - - - - - -
Table 12 OpExtendInfoRemoveResources

Parameter

Type

+

Type

Description

+

Description

fail_count

+

fail_count

Integer

+

Integer

Number of resources that fail to be deleted

+

Number of resources that fail to be deleted

total_count

+

total_count

Integer

+

Integer

Number of deleted backups

+

Number of deleted backups

resources

+

resources

Array of Resource objects

+

Array of Resource objects

Resource information

+

Resource information

-
Table 13 Resource

Parameter

+
- - - - - - - - - - - - - -
Table 13 Resource

Parameter

Type

+

Type

Description

+

Description

extra_info

+

extra_info

ResourceExtraInfo object

+

ResourceExtraInfo object

Vault name

+

Vault name

id

+

id

String

+

String

ID of the vault resource type

+

ID of the vault resource type

name

+

name

String

+

String

Name of the resource to be backed up. The value consists of 0 to 255 characters.

+

Name of the resource to be backed up. The value consists of 0 to 255 characters.

Minimum: 0

Maximum: 255

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

-
Table 14 ResourceExtraInfo

Parameter

+
- - - - -
Table 14 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 15 OpExtendInfoRestore

Parameter

+
- - - - - - - - - - - - - -
Table 15 OpExtendInfoRestore

Parameter

Type

+

Type

Description

+

Description

backup_id

+

backup_id

String

+

String

Backup ID

+

Backup ID

backup_name

+

backup_name

String

+

String

Backup name

+

Backup name

target_resource_id

+

target_resource_id

String

+

String

ID of the resource to be restored

+

ID of the resource to be restored

target_resource_name

+

target_resource_name

String

+

String

Name of the resource to be restored

+

Name of the resource to be restored

-
Table 16 OpExtendInfoVaultDelete

Parameter

+
- - - - - - - - @@ -749,43 +750,43 @@

Status code: 404

-
Table 16 OpExtendInfoVaultDelete

Parameter

Type

+

Type

Description

+

Description

fail_count

+

fail_count

Integer

+

Integer

Number of resources that fail to be deleted in this task

+

Number of resources that fail to be deleted in this task

total_count

+

total_count

Integer

+

Integer

Number of backups deleted in this task

+

Number of backups deleted in this task

Table 17 Response body parameters

Parameter

+
- - - - - - - - - - - - - - @@ -794,61 +795,61 @@
Table 17 Response body parameters

Parameter

Type

+

Type

Description

+

Description

operation_logs

+

operation_logs

Array of OperationLog objects

+

Array of OperationLog objects

Task list

+

Task list

count

+

count

Integer

+

Integer

Number of tasks

+

Number of tasks

limit

+

limit

Integer

+

Integer

Number of records displayed on each page

+

Number of records displayed on each page

Minimum: 1

Maximum: 1000

Default: 1000

offset

+

offset

Integer

+

Integer

Offset where the query starts

+

Offset where the query starts

Minimum: 0

Default: 0

-
Table 18 OperationLog

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 18 OperationLog

Parameter

Type

+

Type

Description

+

Description

checkpoint_id

+

checkpoint_id

String

+

String

Backup record ID

+

Backup record ID

created_at

+

created_at

String

+

String

Creation time, for example, 2020-02-23T01:00:32Z

+

Creation time, for example, 2020-02-23T01:00:32Z

ended_at

+

ended_at

String

+

String

Task end time, for example, 2020-02-23T01:00:32Z

+

Task end time, for example, 2020-02-23T01:00:32Z

error_info

+

error_info

OpErrorInfo object

+

OpErrorInfo object

Task error message

+

Task error message

extra_info

+

extra_info

OpExtraInfo object

+

OpExtraInfo object

Task extension information

+

Task extension information

id

+

id

String

+

String

Task ID

+

Task ID

operation_type

+

operation_type

String

+

String

Task type

+

Task type

Enumeration values:

  • backup

  • restore

    @@ -859,39 +860,39 @@

policy_id

+

policy_id

String

+

String

Policy ID

+

Policy ID

project_id

+

project_id

String

+

String

Project ID

+

Project ID

provider_id

+

provider_id

String

+

String

Backup provider ID, which specifies whether the backup object is a server or disk

+

Backup provider ID, which specifies whether the backup object is a server or disk

started_at

+

started_at

String

+

String

Task start time, for example, 2020-02-23T01:00:32Z

+

Task start time, for example, 2020-02-23T01:00:32Z

status

+

status

String

+

String

Task status

+

Task status

Enumeration values:

  • success

  • skipped

    @@ -902,152 +903,152 @@

updated_at

+

updated_at

String

+

String

Modification time, for example, 2020-02-23T01:00:32Z

+

Modification time, for example, 2020-02-23T01:00:32Z

vault_id

+

vault_id

String

+

String

ID of the vault with which the target resource is associated

+

ID of the vault with which the target resource is associated

vault_name

+

vault_name

String

+

String

Name of the vault with which the target resource is associated

+

Name of the vault with which the target resource is associated

-
Table 19 OpErrorInfo

Parameter

+
- - - - - - - -
Table 19 OpErrorInfo

Parameter

Type

+

Type

Description

+

Description

code

+

code

String

+

String

For details, see Error Codes.

+

For details, see Error Codes.

message

+

message

String

+

String

Error message

+

Error message

-
Table 20 OpExtraInfo

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 20 OpExtraInfo

Parameter

Type

+

Type

Description

+

Description

backup

+

backup

OpExtendInfoBckup object

+

OpExtendInfoBckup object

Extended parameters of backup

+

Extended parameters of backup

common

+

common

OpExtendInfoCommon object

+

OpExtendInfoCommon object

Common parameters

+

Common parameters

delete

+

delete

OpExtendInfoDelete object

+

OpExtendInfoDelete object

Extended parameters of deletion

+

Extended parameters of deletion

sync

+

sync

OpExtendInfoSync object

+

OpExtendInfoSync object

Extended parameters of synchronization

+

Extended parameters of synchronization

remove_resources

+

remove_resources

OpExtendInfoRemoveResources object

+

OpExtendInfoRemoveResources object

Extended parameters of removing resources from a vault

+

Extended parameters of removing resources from a vault

resource

+

resource

Resource object

+

Resource object

Resource information

+

Resource information

restore

+

restore

OpExtendInfoRestore object

+

OpExtendInfoRestore object

Extended parameters of restoration

+

Extended parameters of restoration

vault_delete

+

vault_delete

OpExtendInfoVaultDelete object

+

OpExtendInfoVaultDelete object

Extended parameters of deleting a vault

+

Extended parameters of deleting a vault

-
Table 21 OpExtendInfoBckup

Parameter

+
- - - - - - - - - - -
Table 21 OpExtendInfoBckup

Parameter

Type

+

Type

Description

+

Description

backup_id

+

backup_id

String

+

String

Backup ID

+

Backup ID

backup_name

+

backup_name

String

+

String

Backup name

+

Backup name

incremental

+

incremental

String

+

String

Whether incremental backup is used

+

Whether incremental backup is used

Enumeration values:

  • "true"

  • "false"

    @@ -1058,254 +1059,254 @@
-
Table 22 OpExtendInfoCommon

Parameter

+
- - - - - - - - - - -
Table 22 OpExtendInfoCommon

Parameter

Type

+

Type

Description

+

Description

progress

+

progress

Integer

+

Integer

Progress of the query task. The value ranges from 0 to 100.

+

Progress of the query task. The value ranges from 0 to 100.

Minimum: 0

Maximum: 100

request_id

+

request_id

String

+

String

Request ID

+

Request ID

task_id

+

task_id

String

+

String

Backup task ID

+

Backup task ID

-
Table 23 OpExtendInfoDelete

Parameter

+
- - - - - - - -
Table 23 OpExtendInfoDelete

Parameter

Type

+

Type

Description

+

Description

backup_id

+

backup_id

String

+

String

Backup ID

+

Backup ID

backup_name

+

backup_name

String

+

String

Backup name

+

Backup name

-
Table 24 OpExtendInfoSync

Parameter

+
- - - - - - - - - - -
Table 24 OpExtendInfoSync

Parameter

Type

+

Type

Description

+

Description

sync_backup_num

+

sync_backup_num

Integer

+

Integer

Number of synchronized backups

+

Number of synchronized backups

delete_backup_num

+

delete_backup_num

Integer

+

Integer

Number of deleted backups

+

Number of deleted backups

err_sync_backup_num

+

err_sync_backup_num

Integer

+

Integer

Number of backups that failed to be synchronized

+

Number of backups that failed to be synchronized

-
Table 25 OpExtendInfoRemoveResources

Parameter

+
- - - - - - - - - - -
Table 25 OpExtendInfoRemoveResources

Parameter

Type

+

Type

Description

+

Description

fail_count

+

fail_count

Integer

+

Integer

Number of resources that fail to be deleted

+

Number of resources that fail to be deleted

total_count

+

total_count

Integer

+

Integer

Number of deleted backups

+

Number of deleted backups

resources

+

resources

Array of Resource objects

+

Array of Resource objects

Resource information

+

Resource information

-
Table 26 Resource

Parameter

+
- - - - - - - - - - - - - -
Table 26 Resource

Parameter

Type

+

Type

Description

+

Description

extra_info

+

extra_info

ResourceExtraInfo object

+

ResourceExtraInfo object

Vault name

+

Vault name

id

+

id

String

+

String

ID of the vault resource type

+

ID of the vault resource type

name

+

name

String

+

String

Name of the resource to be backed up. The value consists of 0 to 255 characters.

+

Name of the resource to be backed up. The value consists of 0 to 255 characters.

Minimum: 0

Maximum: 255

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

-
Table 27 ResourceExtraInfo

Parameter

+
- - - - -
Table 27 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 28 OpExtendInfoRestore

Parameter

+
- - - - - - - - - - - - - -
Table 28 OpExtendInfoRestore

Parameter

Type

+

Type

Description

+

Description

backup_id

+

backup_id

String

+

String

Backup ID

+

Backup ID

backup_name

+

backup_name

String

+

String

Backup name

+

Backup name

target_resource_id

+

target_resource_id

String

+

String

ID of the resource to be restored

+

ID of the resource to be restored

target_resource_name

+

target_resource_name

String

+

String

Name of the resource to be restored

+

Name of the resource to be restored

-
Table 29 OpExtendInfoVaultDelete

Parameter

+
- - - - - - - - @@ -1377,7 +1378,7 @@
diff --git a/docs/cbr/api-ref/ListPolicies.html b/docs/cbr/api-ref/ListPolicies.html index fef6f577e..c1e60d491 100644 --- a/docs/cbr/api-ref/ListPolicies.html +++ b/docs/cbr/api-ref/ListPolicies.html @@ -1,373 +1,369 @@

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 29 OpExtendInfoVaultDelete

Parameter

Type

+

Type

Description

+

Description

fail_count

+

fail_count

Integer

+

Integer

Number of resources that fail to be deleted in this task

+

Number of resources that fail to be deleted in this task

total_count

+

total_count

Integer

+

Integer

Number of backups deleted in this task

+

Number of backups deleted in this task

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

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

-

Minimum: 0

-

Maximum: 100

+

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

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

+

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 retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Maximum number of 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

month_backups

+

month_backups

Integer

+

Integer

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

-

Minimum: 0

-

Maximum: 100

+

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. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

Duration of retaining a backup, in days. The maximum value is 99999. 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+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

+

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

week_backups

+

week_backups

Integer

+

Integer

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

+

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

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

-

Minimum: 0

-

Maximum: 100

+

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" : [ ],
@@ -387,7 +383,7 @@
       "day_backups" : 0,
       "month_backups" : 0,
       "week_backups" : 0,
-      "timezone" : "UTC+08:00"
+      "timezone" : "UTC+01:00"
     },
     "operation_type" : "backup",
     "id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
@@ -395,28 +391,28 @@
   "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 7c14f3a17..df647bf0d 100644 --- a/docs/cbr/api-ref/ListVault.html +++ b/docs/cbr/api-ref/ListVault.html @@ -1,621 +1,620 @@

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

+

Boolean

+

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",
@@ -645,28 +644,28 @@
   "count" : 50
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

OK

+

OK

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/cbr/api-ref/ListVersions.html b/docs/cbr/api-ref/ListVersions.html index 0deb316e2..096d691e8 100644 --- a/docs/cbr/api-ref/ListVersions.html +++ b/docs/cbr/api-ref/ListVersions.html @@ -1,7 +1,7 @@

Querying API Versions

-

Function

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

+

Function

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

URI

GET /

@@ -9,84 +9,84 @@

Response Parameters

Status code: 300

-
Table 1 Response body parameters

Parameter

+
- - - - -
Table 1 Response body parameters

Parameter

Type

+

Type

Description

+

Description

versions

+

versions

Array of Version objects

+

Array of Version objects

List of API versions

+

List of API versions

-
Table 2 Version

Parameter

+
- - - - - - - - - - -
Table 2 Version

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

API version ID

+

API version ID

Enumeration values:

  • v3

status

+

status

String

+

String

API version status

+

API version status

Enumeration values:

  • CURRENT

links

+

links

Array of Link objects

+

Array of Link objects

URI of the API version

+

URI of the API version

-