diff --git a/docs/cbr/api-ref/ALL_META.TXT.json b/docs/cbr/api-ref/ALL_META.TXT.json index 5616e316..7d16cb03 100644 --- a/docs/cbr/api-ref/ALL_META.TXT.json +++ b/docs/cbr/api-ref/ALL_META.TXT.json @@ -21,7 +21,7 @@ }, { "uri":"topic_300000000.html", - "product_code":"cbr", + "product_code":"", "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", @@ -31,7 +31,7 @@ }, { "uri":"ListVersions.html", - "product_code":"cbr", + "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", @@ -41,7 +41,7 @@ }, { "uri":"ShowVersion.html", - "product_code":"cbr", + "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", @@ -51,7 +51,7 @@ }, { "uri":"topic_300000001.html", - "product_code":"cbr", + "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", @@ -61,7 +61,7 @@ }, { "uri":"ShowOpLog.html", - "product_code":"cbr", + "product_code":"", "code":"7", "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", @@ -71,7 +71,7 @@ }, { "uri":"ListOpLogs.html", - "product_code":"cbr", + "product_code":"", "code":"8", "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", @@ -81,7 +81,7 @@ }, { "uri":"topic_300000002.html", - "product_code":"cbr", + "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", @@ -91,7 +91,7 @@ }, { "uri":"AddMember.html", - "product_code":"cbr", + "product_code":"", "code":"10", "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", @@ -101,7 +101,7 @@ }, { "uri":"ShowMembersDetail.html", - "product_code":"cbr", + "product_code":"", "code":"11", "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", @@ -111,7 +111,7 @@ }, { "uri":"UpdateMemberStatus.html", - "product_code":"cbr", + "product_code":"", "code":"12", "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", @@ -121,7 +121,7 @@ }, { "uri":"DeleteMember.html", - "product_code":"cbr", + "product_code":"", "code":"13", "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", @@ -131,7 +131,7 @@ }, { "uri":"ShowMemberDetail.html", - "product_code":"cbr", + "product_code":"", "code":"14", "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", @@ -141,7 +141,7 @@ }, { "uri":"topic_300000003.html", - "product_code":"cbr", + "product_code":"", "code":"15", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -151,7 +151,7 @@ }, { "uri":"ShowCheckpoint.html", - "product_code":"cbr", + "product_code":"", "code":"16", "des":"This API is used to query a specified restore point based on its ID.GET /v3/{project_id}/checkpoints/{checkpoint_id}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -161,7 +161,7 @@ }, { "uri":"CreateCheckpoint.html", - "product_code":"cbr", + "product_code":"", "code":"17", "des":"This API is used to back up a vault and generate a restore point.POST /v3/{project_id}/checkpointsStatus code: 200Creating backupsStatus code: 200OKSee Error Codes.", "doc_type":"api", @@ -171,7 +171,7 @@ }, { "uri":"topic_300000004.html", - "product_code":"cbr", + "product_code":"", "code":"18", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -181,7 +181,7 @@ }, { "uri":"CreateVault.html", - "product_code":"cbr", + "product_code":"", "code":"19", "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", @@ -191,7 +191,7 @@ }, { "uri":"ShowVault.html", - "product_code":"cbr", + "product_code":"", "code":"20", "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", @@ -201,7 +201,7 @@ }, { "uri":"ListVault.html", - "product_code":"cbr", + "product_code":"", "code":"21", "des":"This API is used to query the vault list.GET /v3/{project_id}/vaultsStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -211,7 +211,7 @@ }, { "uri":"UpdateVault.html", - "product_code":"cbr", + "product_code":"", "code":"22", "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", @@ -221,7 +221,7 @@ }, { "uri":"DeleteVault.html", - "product_code":"cbr", + "product_code":"", "code":"23", "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.", "doc_type":"api", @@ -231,7 +231,7 @@ }, { "uri":"RemoveVaultResource.html", - "product_code":"cbr", + "product_code":"", "code":"24", "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", @@ -241,7 +241,7 @@ }, { "uri":"AddVaultResource.html", - "product_code":"cbr", + "product_code":"", "code":"25", "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", @@ -251,7 +251,7 @@ }, { "uri":"AssociateVaultPolicy.html", - "product_code":"cbr", + "product_code":"", "code":"26", "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", @@ -261,7 +261,7 @@ }, { "uri":"DisassociateVaultPolicy.html", - "product_code":"cbr", + "product_code":"", "code":"27", "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", @@ -271,7 +271,7 @@ }, { "uri":"topic_300000005.html", - "product_code":"cbr", + "product_code":"", "code":"28", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -281,7 +281,7 @@ }, { "uri":"ShowBackup.html", - "product_code":"cbr", + "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", @@ -291,7 +291,7 @@ }, { "uri":"ListBackups.html", - "product_code":"cbr", + "product_code":"", "code":"30", "des":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -301,7 +301,7 @@ }, { "uri":"DeleteBackup.html", - "product_code":"cbr", + "product_code":"", "code":"31", "des":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.", "doc_type":"api", @@ -311,7 +311,7 @@ }, { "uri":"RestoreBackup.html", - "product_code":"cbr", + "product_code":"", "code":"32", "des":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", "doc_type":"api", @@ -321,7 +321,7 @@ }, { "uri":"topic_300000006.html", - "product_code":"cbr", + "product_code":"", "code":"33", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -331,7 +331,7 @@ }, { "uri":"CreatePolicy.html", - "product_code":"cbr", + "product_code":"", "code":"34", "des":"This API is used to create a backup policy.POST /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -341,7 +341,7 @@ }, { "uri":"ShowPolicy.html", - "product_code":"cbr", + "product_code":"", "code":"35", "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", @@ -351,7 +351,7 @@ }, { "uri":"ListPolicies.html", - "product_code":"cbr", + "product_code":"", "code":"36", "des":"This API is used to query the policy list.GET /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", @@ -361,7 +361,7 @@ }, { "uri":"UpdatePolicy.html", - "product_code":"cbr", + "product_code":"", "code":"37", "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", @@ -371,7 +371,7 @@ }, { "uri":"DeletePolicy.html", - "product_code":"cbr", + "product_code":"", "code":"38", "des":"This API is used to delete a policy.DELETE /v3/{project_id}/policies/{policy_id}NoneNoneSee Error Codes.", "doc_type":"api", @@ -380,8 +380,8 @@ "githuburl":"" }, { - "uri":"topic_300000007.html", - "product_code":"cbr", + "uri":"topic_300000008.html", + "product_code":"", "code":"39", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -391,7 +391,7 @@ }, { "uri":"ShowVaultResourceInstances.html", - "product_code":"cbr", + "product_code":"", "code":"40", "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 ", "doc_type":"api", @@ -401,9 +401,9 @@ }, { "uri":"BatchCreateAndDeleteVaultTags.html", - "product_code":"cbr", + "product_code":"", "code":"41", - "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 10 tags. This A", + "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", "title":"Batch Adding or Deleting Tags of a Vault", @@ -411,9 +411,9 @@ }, { "uri":"CreateVaultTags.html", - "product_code":"cbr", + "product_code":"", "code":"42", - "des":"This API is used to add a tag to an associated resource. A resource can have a maximum of 10 tags. This API is idempotent. If a to-be-added tag has the same key as an exi", + "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", "title":"Adding a Tag to an Associated Resource", @@ -421,7 +421,7 @@ }, { "uri":"DeleteVaultTag.html", - "product_code":"cbr", + "product_code":"", "code":"43", "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", @@ -431,7 +431,7 @@ }, { "uri":"ShowVaultTag.html", - "product_code":"cbr", + "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 c", "doc_type":"api", @@ -441,7 +441,7 @@ }, { "uri":"ShowVaultProjectTag.html", - "product_code":"cbr", + "product_code":"", "code":"45", "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", "doc_type":"api", @@ -463,7 +463,7 @@ "uri":"cbr_04_0017.html", "product_code":"cbr", "code":"47", - "des":"This section describes fine-grained permissions management for your CBR. If your cloud account does not need individual IAM users, skip this section.By default, new IAM u", + "des":"You can use Identity and Access Management (IAM) for fine-grained permissions management of your CBR resources. If your account does not need individual IAM users, you ca", "doc_type":"api", "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", "title":"Introduction", diff --git a/docs/cbr/api-ref/AddMember.html b/docs/cbr/api-ref/AddMember.html index cb9b7606..8f024fef 100644 --- a/docs/cbr/api-ref/AddMember.html +++ b/docs/cbr/api-ref/AddMember.html @@ -87,6 +87,7 @@

Array of strings

Project IDs of the backup share members to be added

+

Array Length: 1 - 10

diff --git a/docs/cbr/api-ref/AddVaultResource.html b/docs/cbr/api-ref/AddVaultResource.html index 002d05d5..39ed3a49 100644 --- a/docs/cbr/api-ref/AddVaultResource.html +++ b/docs/cbr/api-ref/AddVaultResource.html @@ -78,6 +78,7 @@

Array of ResourceCreate objects

Resource list

+

Array Length: 1 - 256

diff --git a/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html b/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html index bd8269ce..5169ed5f 100644 --- a/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html +++ b/docs/cbr/api-ref/BatchCreateAndDeleteVaultTags.html @@ -1,7 +1,7 @@

Batch Adding or Deleting Tags of a Vault

-

Function

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

+

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

@@ -56,7 +56,7 @@

Tag list

This list cannot be an empty list.

-

The list can contain up to 10 keys.

+

The list can contain up to 20 keys.

Keys in this list must be unique.

@@ -190,7 +190,7 @@
diff --git a/docs/cbr/api-ref/CLASS.TXT.json b/docs/cbr/api-ref/CLASS.TXT.json index 21571913..f9effa56 100644 --- a/docs/cbr/api-ref/CLASS.TXT.json +++ b/docs/cbr/api-ref/CLASS.TXT.json @@ -19,7 +19,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"cbr", + "product_code":"", "title":"API Version Query", "uri":"topic_300000000.html", "doc_type":"api", @@ -28,7 +28,7 @@ }, { "desc":"This API is used to query the information of API versions.GET /NoneStatus code: 300NoneNoneSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying API Versions", "uri":"ListVersions.html", "doc_type":"api", @@ -37,7 +37,7 @@ }, { "desc":"This API is used to query the information of a specified API version.GET /{api_version}NoneStatus code: 300NoneNoneSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying a Specified API Version", "uri":"ShowVersion.html", "doc_type":"api", @@ -46,7 +46,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"cbr", + "product_code":"", "title":"Tasks", "uri":"topic_300000001.html", "doc_type":"api", @@ -55,7 +55,7 @@ }, { "desc":"This API is used to query a task by task ID.GET /v3/{project_id}/operation-logs/{operation_log_id}Status code: 200Status code: 404Status code: 200OKStatus code: 404The ta", - "product_code":"cbr", + "product_code":"", "title":"Querying a Single Task", "uri":"ShowOpLog.html", "doc_type":"api", @@ -64,7 +64,7 @@ }, { "desc":"This API is used to query the task list.GET /v3/{project_id}/operation-logsStatus code: 200Status code: 404Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying the Task List", "uri":"ListOpLogs.html", "doc_type":"api", @@ -73,7 +73,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"cbr", + "product_code":"", "title":"Backup Sharing", "uri":"topic_300000002.html", "doc_type":"api", @@ -82,7 +82,7 @@ }, { "desc":"This API is used to add a member with whom the backup can be shared. Only cloud server backups can be shared among tenants in the same region.POST /v3/{project_id}/backup", - "product_code":"cbr", + "product_code":"", "title":"Adding a Share Member", "uri":"AddMember.html", "doc_type":"api", @@ -91,7 +91,7 @@ }, { "desc":"This API is used to obtain the list of backup share members.GET /v3/{project_id}/backups/{backup_id}/membersStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Obtaining the Share Member List", "uri":"ShowMembersDetail.html", "doc_type":"api", @@ -100,7 +100,7 @@ }, { "desc":"This API is used to update the status of a backup share member.PUT /v3/{project_id}/backups/{backup_id}/members/{member_id}Status code: 200Status code: 200OKSee Error Cod", - "product_code":"cbr", + "product_code":"", "title":"Updating the Share Member Status", "uri":"UpdateMemberStatus.html", "doc_type":"api", @@ -109,7 +109,7 @@ }, { "desc":"This API is used to delete a specified backup share member.DELETE /v3/{project_id}/backups/{backup_id}/members/{member_id}NoneNoneSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Deleting a Specified Share Member", "uri":"DeleteMember.html", "doc_type":"api", @@ -118,7 +118,7 @@ }, { "desc":"This API is used to obtain the details of a backup share member.GET /v3/{project_id}/backups/{backup_id}/members/{member_id}Status code: 200Status code: 200OKSee Error Co", - "product_code":"cbr", + "product_code":"", "title":"Querying Share Member Details", "uri":"ShowMemberDetail.html", "doc_type":"api", @@ -127,7 +127,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"cbr", + "product_code":"", "title":"Restore Points", "uri":"topic_300000003.html", "doc_type":"api", @@ -136,7 +136,7 @@ }, { "desc":"This API is used to query a specified restore point based on its ID.GET /v3/{project_id}/checkpoints/{checkpoint_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying a Restore Point", "uri":"ShowCheckpoint.html", "doc_type":"api", @@ -145,7 +145,7 @@ }, { "desc":"This API is used to back up a vault and generate a restore point.POST /v3/{project_id}/checkpointsStatus code: 200Creating backupsStatus code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Creating a Restore Point", "uri":"CreateCheckpoint.html", "doc_type":"api", @@ -154,7 +154,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"cbr", + "product_code":"", "title":"Vaults", "uri":"topic_300000004.html", "doc_type":"api", @@ -163,7 +163,7 @@ }, { "desc":"This API is used to create a vault.POST /v3/{project_id}/vaultsStatus code: 200Status code: 400Creating a server backup vault, associating resources, and adding tagsPOST ", - "product_code":"cbr", + "product_code":"", "title":"Creating a Vault", "uri":"CreateVault.html", "doc_type":"api", @@ -172,7 +172,7 @@ }, { "desc":"This API is used to query a specified vault based on its ID.GET /v3/{project_id}/vaults/{vault_id}Status code: 200Status code: 404Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying a Specified Vault", "uri":"ShowVault.html", "doc_type":"api", @@ -181,7 +181,7 @@ }, { "desc":"This API is used to query the vault list.GET /v3/{project_id}/vaultsStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying the Vault List", "uri":"ListVault.html", "doc_type":"api", @@ -190,7 +190,7 @@ }, { "desc":"This API is used to modify a vault based on its ID.PUT /v3/{project_id}/vaults/{vault_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Modifying a Vault", "uri":"UpdateVault.html", "doc_type":"api", @@ -199,7 +199,7 @@ }, { "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.", - "product_code":"cbr", + "product_code":"", "title":"Deleting a Vault", "uri":"DeleteVault.html", "doc_type":"api", @@ -208,7 +208,7 @@ }, { "desc":"This API is used to dissociate resources from a vault.POST /v3/{project_id}/vaults/{vault_id}/removeresourcesStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Dissociating Resources", "uri":"RemoveVaultResource.html", "doc_type":"api", @@ -217,7 +217,7 @@ }, { "desc":"This API is used to associate resources with a vault.POST /v3/{project_id}/vaults/{vault_id}/addresourcesStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Associating Resources", "uri":"AddVaultResource.html", "doc_type":"api", @@ -226,7 +226,7 @@ }, { "desc":"This API is used to apply a policy to a vault.POST /v3/{project_id}/vaults/{vault_id}/associatepolicyStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Applying a Policy to a Vault", "uri":"AssociateVaultPolicy.html", "doc_type":"api", @@ -235,7 +235,7 @@ }, { "desc":"This API is used to remove a policy from a vault.POST /v3/{project_id}/vaults/{vault_id}/dissociatepolicyStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Removing a Policy from a Vault", "uri":"DisassociateVaultPolicy.html", "doc_type":"api", @@ -244,7 +244,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"cbr", + "product_code":"", "title":"Backups", "uri":"topic_300000005.html", "doc_type":"api", @@ -253,7 +253,7 @@ }, { "desc":"This API is used to query the backup of a specific ID.GET /v3/{project_id}/backups/{backup_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying a Specified Backup", "uri":"ShowBackup.html", "doc_type":"api", @@ -262,7 +262,7 @@ }, { "desc":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying All Backups", "uri":"ListBackups.html", "doc_type":"api", @@ -271,7 +271,7 @@ }, { "desc":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Deleting a Backup", "uri":"DeleteBackup.html", "doc_type":"api", @@ -280,7 +280,7 @@ }, { "desc":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Restoring a Backup", "uri":"RestoreBackup.html", "doc_type":"api", @@ -289,7 +289,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"cbr", + "product_code":"", "title":"Policies", "uri":"topic_300000006.html", "doc_type":"api", @@ -298,7 +298,7 @@ }, { "desc":"This API is used to create a backup policy.POST /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Creating a Policy", "uri":"CreatePolicy.html", "doc_type":"api", @@ -307,7 +307,7 @@ }, { "desc":"This API is used to query a single policy.GET /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying a Single Policy", "uri":"ShowPolicy.html", "doc_type":"api", @@ -316,7 +316,7 @@ }, { "desc":"This API is used to query the policy list.GET /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Querying the Policy List", "uri":"ListPolicies.html", "doc_type":"api", @@ -325,7 +325,7 @@ }, { "desc":"This API is used to modify a policy.PUT /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Modifying a Policy", "uri":"UpdatePolicy.html", "doc_type":"api", @@ -334,7 +334,7 @@ }, { "desc":"This API is used to delete a policy.DELETE /v3/{project_id}/policies/{policy_id}NoneNoneSee Error Codes.", - "product_code":"cbr", + "product_code":"", "title":"Deleting a Policy", "uri":"DeletePolicy.html", "doc_type":"api", @@ -343,16 +343,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":"cbr", + "product_code":"", "title":"Tags", - "uri":"topic_300000007.html", + "uri":"topic_300000008.html", "doc_type":"api", "p_code":"2", "code":"39" }, { "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 ", - "product_code":"cbr", + "product_code":"", "title":"Querying Vault Resources", "uri":"ShowVaultResourceInstances.html", "doc_type":"api", @@ -360,8 +360,8 @@ "code":"40" }, { - "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 10 tags. This A", - "product_code":"cbr", + "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", @@ -369,8 +369,8 @@ "code":"41" }, { - "desc":"This API is used to add a tag to an associated resource. A resource can have a maximum of 10 tags. This API is idempotent. If a to-be-added tag has the same key as an exi", - "product_code":"cbr", + "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", @@ -379,7 +379,7 @@ }, { "desc":"This API is used to delete a tag from an associated resource. The API is idempotent. When you delete a nonexistent tag, error code 404 will be returned. Tag keys cannot b", - "product_code":"cbr", + "product_code":"", "title":"Deleting a Tag from an Associated Resource", "uri":"DeleteVaultTag.html", "doc_type":"api", @@ -388,7 +388,7 @@ }, { "desc":"This API is used to query tags of a specified resource. TMS uses this API to query all tags of a specified resource.GET /v3/{project_id}/vault/{vault_id}/tagsNoneStatus c", - "product_code":"cbr", + "product_code":"", "title":"Querying Tags of an Associated Resource", "uri":"ShowVaultTag.html", "doc_type":"api", @@ -397,7 +397,7 @@ }, { "desc":"This API is used to query a tenant's tag set in a specific region and of a specific instance type. TMS uses this API to list tags created by a tenant to facilitate tag cr", - "product_code":"cbr", + "product_code":"", "title":"Querying Tags of a Vault Project", "uri":"ShowVaultProjectTag.html", "doc_type":"api", @@ -414,7 +414,7 @@ "code":"46" }, { - "desc":"This section describes fine-grained permissions management for your CBR. If your cloud account does not need individual IAM users, skip this section.By default, new IAM u", + "desc":"You can use Identity and Access Management (IAM) for fine-grained permissions management of your CBR resources. If your account does not need individual IAM users, you ca", "product_code":"cbr", "title":"Introduction", "uri":"cbr_04_0017.html", diff --git a/docs/cbr/api-ref/CreateCheckpoint.html b/docs/cbr/api-ref/CreateCheckpoint.html index 4c38a3dd..3b5e7136 100644 --- a/docs/cbr/api-ref/CreateCheckpoint.html +++ b/docs/cbr/api-ref/CreateCheckpoint.html @@ -175,6 +175,7 @@

Array of Resource objects

Resource details

+

Array Length: 0 - 256

diff --git a/docs/cbr/api-ref/CreatePolicy.html b/docs/cbr/api-ref/CreatePolicy.html index a3c39435..fe62e079 100644 --- a/docs/cbr/api-ref/CreatePolicy.html +++ b/docs/cbr/api-ref/CreatePolicy.html @@ -1,531 +1,529 @@

Creating a Policy

-

Function

This API is used to create a backup policy.

+

Function

This API is used to create a backup policy.

-

URI

POST /v3/{project_id}/policies

+

URI

POST /v3/{project_id}/policies

-
Table 1 Path Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID

-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

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

+

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

-
Table 3 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

policy

+

policy

Yes

+

Yes

PolicyCreate object

+

PolicyCreate object

Request body for creating a policy

+

Request body for creating a policy

-
Table 4 PolicyCreate

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

enabled

+

enabled

No

+

No

Boolean

+

Boolean

Whether to enable the policy

-

Default: true

+

Whether to enable the policy

+

Default: true

name

+

name

Yes

+

Yes

String

+

String

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

-

Minimum: 1

-

Maximum: 64

+

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

+

Minimum: 1

+

Maximum: 64

operation_definition

+

operation_definition

Yes

+

Yes

PolicyoODCreate object

+

PolicyoODCreate object

Scheduling parameter

+

Scheduling parameter

operation_type

+

operation_type

Yes

+

Yes

String

+

String

Protection type, which is backup

+

Protection type, which is backup

trigger

+

trigger

Yes

+

Yes

PolicyTriggerReq object

+

PolicyTriggerReq object

Time rule for the policy execution

+

Time rule for the policy execution

-
Table 5 PolicyoODCreate

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

day_backups

+

day_backups

No

+

No

Integer

+

Integer

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

-

Minimum: 0

-

Maximum: 100

+

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

+

Minimum: 0

+

Maximum: 100

max_backups

+

max_backups

No

+

No

Integer

+

Integer

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

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

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

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

month_backups

+

month_backups

No

+

No

Integer

+

Integer

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

-

Minimum: 0

-

Maximum: 100

+

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

+

Minimum: 0

+

Maximum: 100

retention_duration_days

+

retention_duration_days

No

+

No

Integer

+

Integer

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

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

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

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

timezone

+

timezone

No

+

No

String

+

String

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

+

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

week_backups

+

week_backups

No

+

No

Integer

+

Integer

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

+

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

year_backups

+

year_backups

No

+

No

Integer

+

Integer

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

-

Minimum: 0

-

Maximum: 100

+

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

+

Minimum: 0

+

Maximum: 100

-
Table 6 PolicyTriggerReq

Parameter

+
- - - - - - -
Table 6 PolicyTriggerReq

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

properties

+

properties

Yes

+

Yes

PolicyTriggerPropertiesReq object

+

PolicyTriggerPropertiesReq object

Scheduler attributes

+

Scheduler attributes

-
Table 7 PolicyTriggerPropertiesReq

Parameter

+
- - - - - - -
Table 7 PolicyTriggerPropertiesReq

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

pattern

+

pattern

Yes

+

Yes

Array of strings

+

Array of strings

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

+

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

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 8 Response body parameters

Parameter

+
- - - - -
Table 8 Response body parameters

Parameter

Type

+

Type

Description

+

Description

policy

+

policy

Policy object

+

Policy object

Response to the request for creating a policy

+

Response to the request for creating a policy

-
Table 9 Policy

Parameter

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

Parameter

Type

+

Type

Description

+

Description

enabled

+

enabled

Boolean

+

Boolean

Whether the policy is enabled

+

Whether the policy is enabled

id

+

id

String

+

String

Policy ID

+

Policy ID

name

+

name

String

+

String

Policy Name

+

Policy Name

operation_definition

+

operation_definition

PolicyoODCreate object

+

PolicyoODCreate object

Policy attributes

+

Policy attributes

operation_type

+

operation_type

String

+

String

Protection type, which is backup

-

Enumeration values:

-
  • backup

    -
+

Protection type, which is backup

+

Enumeration values:

+
  • backup

trigger

+

trigger

PolicyTriggerResp object

+

PolicyTriggerResp object

Time scheduling rule for the policy

+

Time scheduling rule for the policy

associated_vaults

+

associated_vaults

Array of PolicyAssociateVault objects

+

Array of PolicyAssociateVault objects

Associated vault

+

Associated vault

-
Table 10 PolicyoODCreate

Parameter

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

Parameter

Type

+

Type

Description

+

Description

day_backups

+

day_backups

Integer

+

Integer

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

-

Minimum: 0

-

Maximum: 100

+

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

+

Minimum: 0

+

Maximum: 100

max_backups

+

max_backups

Integer

+

Integer

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

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

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

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

month_backups

+

month_backups

Integer

+

Integer

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

-

Minimum: 0

-

Maximum: 100

+

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

+

Minimum: 0

+

Maximum: 100

retention_duration_days

+

retention_duration_days

Integer

+

Integer

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

-

Minimum: 1

-

Maximum: 99999

-

Default: -1

+

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

+

Minimum: 1

+

Maximum: 99999

+

Default: -1

timezone

+

timezone

String

+

String

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

+

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

week_backups

+

week_backups

Integer

+

Integer

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

+

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

year_backups

+

year_backups

Integer

+

Integer

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

-

Minimum: 0

-

Maximum: 100

+

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

+

Minimum: 0

+

Maximum: 100

-
Table 11 PolicyTriggerResp

Parameter

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

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Scheduler ID

+

Scheduler ID

name

+

name

String

+

String

Scheduler name

+

Scheduler name

properties

+

properties

PolicyTriggerPropertiesResp object

+

PolicyTriggerPropertiesResp object

Scheduler attributes

+

Scheduler attributes

type

+

type

String

+

String

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

-

Enumeration values:

-
  • time

    -
+

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

+

Enumeration values:

+
  • time
-
Table 12 PolicyTriggerPropertiesResp

Parameter

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

Parameter

Type

+

Type

Description

+

Description

pattern

+

pattern

Array of strings

+

Array of strings

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

+

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

start_time

+

start_time

String

+

String

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

+

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

-
Table 13 PolicyAssociateVault

Parameter

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

Parameter

Type

+

Type

Description

+

Description

destination_vault_id

+

destination_vault_id

String

+

String

ID of the associated remote vault

+

ID of the associated remote vault

vault_id

+

vault_id

String

+

String

Vault ID

+

Vault ID

-

Example Requests

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
+

Example Requests

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
 
 {
   "policy" : {
@@ -548,9 +546,9 @@
   }
 }
-

Example Responses

Status code: 200

-

OK

-
{
+

Example Responses

Status code: 200

+

OK

+
{
   "policy" : {
     "name" : "policy001",
     "associated_vaults" : null,
@@ -577,23 +575,23 @@
   }
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

OK

+

OK

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/cbr/api-ref/CreateVault.html b/docs/cbr/api-ref/CreateVault.html index e0085ba1..43ed7eb4 100644 --- a/docs/cbr/api-ref/CreateVault.html +++ b/docs/cbr/api-ref/CreateVault.html @@ -1,903 +1,893 @@

Creating a Vault

-

Function

This API is used to create a vault.

+

Function

This API is used to create a vault.

-

URI

POST /v3/{project_id}/vaults

+

URI

POST /v3/{project_id}/vaults

-
Table 1 Path Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID

-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

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

+

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

-
Table 3 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

vault

+

vault

Yes

+

Yes

VaultCreate object

+

VaultCreate object

Parameters for creating a vault

+

Parameters for creating a vault

-
Table 4 VaultCreate

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 VaultCreate

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

backup_policy_id

+

backup_policy_id

No

+

No

String

+

String

Backup policy ID. If the value of this parameter is null, automatic backup is not performed.

+

Backup policy ID. If the value of this parameter is null, automatic backup is not performed.

billing

+

billing

Yes

+

Yes

BillingCreate object

+

BillingCreate object

Parameter information for creation

+

Parameter information for creation

description

+

description

No

+

No

String

+

String

User-defined vault description

-

Minimum: 0

-

Maximum: 64

+

User-defined vault description

+

Minimum: 0

+

Maximum: 64

name

+

name

Yes

+

Yes

String

+

String

Vault name

-

Minimum: 1

-

Maximum: 64

+

Vault name

+

Minimum: 1

+

Maximum: 64

resources

+

resources

Yes

+

Yes

Array of ResourceCreate objects

+

Array of ResourceCreate objects

Associated resources. Set this parameter to [] if no resources are associated when creating a vault.

+

Associated resources. Set this parameter to [] if no resources are associated when creating a vault.

+

Array Length: 0 - 255

tags

+

tags

No

+

No

Array of Tag objects

+

Array of Tag objects

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

+

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

auto_bind

+

auto_bind

No

+

No

Boolean

+

Boolean

Whether automatic association is supported

+

Whether automatic association is supported

bind_rules

+

bind_rules

No

+

No

VaultBindRules object

+

VaultBindRules object

Rules for automatic association

+

Rules for automatic association

-
Table 5 BillingCreate

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 BillingCreate

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

cloud_type

+

cloud_type

No

+

No

String

+

String

Cloud type, which is public

+

Cloud type, which is public

consistent_level

+

consistent_level

Yes

+

Yes

String

+

String

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

+

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

object_type

+

object_type

Yes

+

Yes

String

+

String

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

+

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

protect_type

+

protect_type

Yes

+

Yes

String

+

String

Protection type, which is backup

+

Protection type, which is backup

size

+

size

Yes

+

Yes

Integer

+

Integer

Capacity, in GB

-

Minimum: 10

-

Maximum: 10485760

+

Capacity, in GB

+

Minimum: 10

+

Maximum: 10485760

charging_mode

+

charging_mode

No

+

No

String

+

String

Billing mode, which is post_paid

-

Default: post_paid

+

Billing mode, which is post_paid

+

Default: post_paid

is_auto_renew

+

is_auto_renew

No

+

No

Boolean

+

Boolean

Whether to automatically renew the subscription after expiration. By default, it is not renewed.

-

Default: false

+

Whether to automatically renew the subscription after expiration. By default, it is not renewed.

+

Default: false

is_auto_pay

+

is_auto_pay

No

+

No

Boolean

+

Boolean

Whether the fee is automatically deducted from the customer's account balance after an order is submitted. The non-automatic payment mode is used by default.

-

Default: false

+

Whether the fee is automatically deducted from the customer's account balance after an order is submitted. The non-automatic payment mode is used by default.

+

Default: false

console_url

+

console_url

No

+

No

String

+

String

Redirection URL

-

Minimum: 1

-

Maximum: 255

+

Redirection URL

+

Minimum: 1

+

Maximum: 255

-
Table 6 ResourceCreate

Parameter

+
- - - - - - - - - - - - - - - - - - -
Table 6 ResourceCreate

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

extra_info

+

extra_info

No

+

No

ResourceExtraInfo object

+

ResourceExtraInfo object

Additional information of the resource

+

Additional information of the resource

id

+

id

Yes

+

Yes

String

+

String

ID of the resource to be backed up

+

ID of the resource to be backed up

type

+

type

Yes

+

Yes

String

+

String

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

+

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

name

+

name

No

+

No

String

+

String

Resource name

-

Minimum: 0

-

Maximum: 255

+

Resource name

+

Minimum: 0

+

Maximum: 255

-
Table 7 ResourceExtraInfo

Parameter

+
- - - - - - -
Table 7 ResourceExtraInfo

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

exclude_volumes

+

exclude_volumes

No

+

No

Array of strings

+

Array of strings

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

+

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

-
Table 8 Tag

Parameter

+
- - - - - - - - - - -
Table 8 Tag

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

key

+

key

Yes

+

Yes

String

+

String

Key

-

It can contain a maximum of 36 characters.

-

It cannot be an empty string.

-

Spaces before and after a key will be discarded.

-

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

-

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

+

Key

+

It can contain a maximum of 36 characters.

+

It cannot be an empty string.

+

Spaces before and after a key will be discarded.

+

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

+

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

value

+

value

No

+

No

String

+

String

Value

-

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

-

It can contain a maximum of 43 characters.

-

It can be an empty string.

-

Spaces before and after a value will be discarded.

-

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

-

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

+

Value

+

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

+

It can contain a maximum of 43 characters.

+

It can be an empty string.

+

Spaces before and after a value will be discarded.

+

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

+

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

-
Table 9 VaultBindRules

Parameter

+
- - - - - - -
Table 9 VaultBindRules

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

tags

+

tags

No

+

No

Array of BindRulesTags objects

+

Array of BindRulesTags objects

Filters automatically associated resources by tag.

+

Filters automatically associated resources by tag.

-
Table 10 BindRulesTags

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

key

+

key

Yes

+

Yes

String

+

String

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

-

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

+

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

+

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

value

+

value

No

+

No

String

+

String

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

-

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

+

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

+

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

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 11 Response body parameters

Parameter

+
- - - - -
Table 11 Response body parameters

Parameter

Type

+

Type

Description

+

Description

vault

+

vault

VaultCreateResource object

+

VaultCreateResource object

Objects returned after a vault query

+

Objects returned after a vault query

-
Table 12 VaultCreateResource

Parameter

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

Parameter

Type

+

Type

Description

+

Description

billing

+

billing

Billing object

+

Billing object

Operations information

+

Operations information

description

+

description

String

+

String

User-defined vault description

-

Minimum: 0

-

Maximum: 255

+

User-defined vault description

+

Minimum: 0

+

Maximum: 255

id

+

id

String

+

String

Vault ID

+

Vault ID

name

+

name

String

+

String

Vault name

-

Minimum: 1

-

Maximum: 64

+

Vault name

+

Minimum: 1

+

Maximum: 64

project_id

+

project_id

String

+

String

Project ID

+

Project ID

provider_id

+

provider_id

String

+

String

ID of the vault resource type

+

ID of the vault resource type

resources

+

resources

Array of ResourceResp objects

+

Array of ResourceResp objects

Vault resources

+

Vault resources

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Vault tags

+

Vault tags

auto_bind

+

auto_bind

Boolean

+

Boolean

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

+

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

bind_rules

+

bind_rules

VaultBindRules object

+

VaultBindRules object

Association rules

+

Association rules

user_id

+

user_id

String

+

String

User ID

+

User ID

created_at

+

created_at

String

+

String

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

+

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

auto_expand

+

auto_expand

Boolean

+

Boolean

Whether to enable auto capacity expansion for the vault.

+

Whether to enable auto capacity expansion for the vault.

-
Table 13 Billing

Parameter

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

Parameter

Type

+

Type

Description

+

Description

allocated

+

allocated

Integer

+

Integer

Allocated capacity, in GB.

+

Allocated capacity, in GB.

charging_mode

+

charging_mode

String

+

String

Billing mode, which is post_paid

+

Billing mode, which is post_paid

cloud_type

+

cloud_type

String

+

String

Cloud type, which is public

+

Cloud type, which is public

consistent_level

+

consistent_level

String

+

String

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

+

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

object_type

+

object_type

String

+

String

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

+

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

order_id

+

order_id

String

+

String

Order ID

+

Order ID

product_id

+

product_id

String

+

String

Product ID

+

Product ID

protect_type

+

protect_type

String

+

String

Protection type, which is backup

+

Protection type, which is backup

size

+

size

Integer

+

Integer

Capacity, in GB

-

Minimum: 1

-

Maximum: 10485760

+

Capacity, in GB

+

Minimum: 1

+

Maximum: 10485760

spec_code

+

spec_code

String

+

String

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

+

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

status

+

status

String

+

String

Vault status

-

Enumeration values:

-
  • available

    -
  • lock

    -
  • frozen

    -
  • deleting

    -
  • error

    -
+

Vault status

+

Enumeration values:

+
  • available
  • lock
  • frozen
  • deleting
  • error

storage_unit

+

storage_unit

String

+

String

Name of the bucket for the vault

+

Name of the bucket for the vault

used

+

used

Integer

+

Integer

Used capacity, in MB.

+

Used capacity, in MB.

frozen_scene

+

frozen_scene

String

+

String

Scenario when an account is frozen

+

Scenario when an account is frozen

-
Table 14 ResourceResp

Parameter

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

Parameter

Type

+

Type

Description

+

Description

extra_info

+

extra_info

ResourceExtraInfo object

+

ResourceExtraInfo object

Additional information of the resource

+

Additional information of the resource

id

+

id

String

+

String

ID of the resource to be backed up

+

ID of the resource to be backed up

name

+

name

String

+

String

Name of the resource to be backed up

-

Minimum: 0

-

Maximum: 255

+

Name of the resource to be backed up

+

Minimum: 0

+

Maximum: 255

protect_status

+

protect_status

String

+

String

Protection status

-

Enumeration values:

-
  • available

    -
  • error

    -
  • protecting

    -
  • restoring

    -
  • removing

    -
+

Protection status

+

Enumeration values:

+
  • available
  • error
  • protecting
  • restoring
  • removing

size

+

size

Integer

+

Integer

Allocated capacity for the associated resources, in GB

+

Allocated capacity for the associated resources, in GB

type

+

type

String

+

String

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

+

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

backup_size

+

backup_size

Integer

+

Integer

Backup size

+

Backup size

backup_count

+

backup_count

Integer

+

Integer

Number of backups

+

Number of backups

-
Table 15 ResourceExtraInfo

Parameter

+
- - - - -
Table 15 ResourceExtraInfo

Parameter

Type

+

Type

Description

+

Description

exclude_volumes

+

exclude_volumes

Array of strings

+

Array of strings

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

+

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

-
Table 16 Tag

Parameter

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

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Key

-

It can contain a maximum of 36 characters.

-

It cannot be an empty string.

-

Spaces before and after a key will be discarded.

-

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

-

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

+

Key

+

It can contain a maximum of 36 characters.

+

It cannot be an empty string.

+

Spaces before and after a key will be discarded.

+

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

+

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

value

+

value

String

+

String

Value

-

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

-

It can contain a maximum of 43 characters.

-

It can be an empty string.

-

Spaces before and after a value will be discarded.

-

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

-

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

+

Value

+

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

+

It can contain a maximum of 43 characters.

+

It can be an empty string.

+

Spaces before and after a value will be discarded.

+

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

+

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

-
Table 17 VaultBindRules

Parameter

+
- - - - -
Table 17 VaultBindRules

Parameter

Type

+

Type

Description

+

Description

tags

+

tags

Array of BindRulesTags objects

+

Array of BindRulesTags objects

Filters automatically associated resources by tag.

+

Filters automatically associated resources by tag.

-
Table 18 BindRulesTags

Parameter

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

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

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

-

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

+

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

+

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

value

+

value

String

+

String

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

-

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

+

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

+

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

-

Status code: 400

+

Status code: 400

-
Table 19 Response body parameters

Parameter

+
- - - - - - - -
Table 19 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

For details, see Error Codes.

+

For details, see Error Codes.

error_msg

+

error_msg

String

+

String

Error message

+

Error message

-

Example Requests

  • Creating a server backup vault, associating resources, and adding tags

    -
    POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
    +

    Example Requests

    • Creating a server backup vault, associating resources, and adding tags
      POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
       
       {
         "vault" : {
      @@ -929,8 +919,7 @@
           "enterprise_project_id" : "0"
         }
       }
      -
    • Creating a disk backup vault (with mandatory parameters only)

      -
       POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
      +
    • Creating a disk backup vault (with mandatory parameters only)
       POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
       
       {
         "vault" : {
      @@ -949,9 +938,9 @@
       }
    -

    Example Responses

    Status code: 200

    -

    OK

    -
    {
    +

    Example Responses

    Status code: 200

    +

    OK

    +
    {
       "vault" : {
         "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
         "description" : "vault_description",
    @@ -996,28 +985,28 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    OK

    +

    OK

    400

    +

    400

    Bad Request

    +

    Bad Request

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cbr/api-ref/CreateVaultTags.html b/docs/cbr/api-ref/CreateVaultTags.html index 996534da..22f5bba7 100644 --- a/docs/cbr/api-ref/CreateVaultTags.html +++ b/docs/cbr/api-ref/CreateVaultTags.html @@ -1,7 +1,7 @@

    Adding a Tag to an Associated Resource

    -

    Function

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

    +

    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

    @@ -170,7 +170,7 @@
    diff --git a/docs/cbr/api-ref/DeleteVaultTag.html b/docs/cbr/api-ref/DeleteVaultTag.html index 9a16ca75..033a42a8 100644 --- a/docs/cbr/api-ref/DeleteVaultTag.html +++ b/docs/cbr/api-ref/DeleteVaultTag.html @@ -106,7 +106,7 @@
    diff --git a/docs/cbr/api-ref/ListBackups.html b/docs/cbr/api-ref/ListBackups.html index ce4a1ecb..56038683 100644 --- a/docs/cbr/api-ref/ListBackups.html +++ b/docs/cbr/api-ref/ListBackups.html @@ -1,576 +1,601 @@

    Querying All Backups

    -

    Function

    This API is used to query all backups.

    +

    Function

    This API is used to query all backups.

    -

    URI

    GET /v3/{project_id}/backups

    +

    URI

    GET /v3/{project_id}/backups

    -
    Table 1 Path Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID

    +

    Project ID

    -
    Table 2 Query Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    checkpoint_id

    +

    checkpoint_id

    No

    +

    No

    String

    +

    String

    Restore point ID

    +

    Restore point ID

    dec

    +

    dec

    No

    +

    No

    Boolean

    +

    Boolean

    Dedicated cloud

    +

    Dedicated cloud

    end_time

    +

    end_time

    No

    +

    No

    String

    +

    String

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

    +

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

    image_type

    +

    image_type

    No

    +

    No

    String

    +

    String

    Backup type, which is backup.

    +

    Backup type, which is backup.

    limit

    +

    limit

    No

    +

    No

    Integer

    +

    Integer

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

    +

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

    marker

    +

    marker

    No

    +

    No

    String

    +

    String

    ID of the last record displayed on the previous page

    +

    ID of the last record displayed on the previous page

    member_status

    +

    member_status

    No

    +

    No

    String

    +

    String

    Backup sharing status

    -

    Enumeration values:

    -
    • pending
    • accepted
    • rejected
    +

    Backup sharing status

    +

    Enumeration values:

    +
    • pending

      +
    • accepted

      +
    • rejected

      +

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Backup name

    +

    Backup name

    offset

    +

    offset

    No

    +

    No

    Integer

    +

    Integer

    Offset value. The value must be a positive integer.

    +

    Offset value. The value must be a positive integer.

    own_type

    +

    own_type

    No

    +

    No

    String

    +

    String

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

    -

    Default: private

    -

    Enumeration values:

    -
    • all_granted
    • private
    • shared
    +

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

    +

    Default: private

    +

    Enumeration values:

    +
    • all_granted

      +
    • private

      +
    • shared

      +

    parent_id

    +

    parent_id

    No

    +

    No

    String

    +

    String

    Parent backup ID

    +

    Parent backup ID

    resource_az

    +

    resource_az

    No

    +

    No

    String

    +

    String

    AZ-based filtering is supported.

    +

    AZ-based filtering is supported.

    resource_id

    +

    resource_id

    No

    +

    No

    String

    +

    String

    Resource ID

    +

    Resource ID

    resource_name

    +

    resource_name

    No

    +

    No

    String

    +

    String

    Resource name

    +

    Resource name

    resource_type

    +

    resource_type

    No

    +

    No

    String

    +

    String

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

    +

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

    sort

    +

    sort

    No

    +

    No

    String

    +

    String

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

    +

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

    start_time

    +

    start_time

    No

    +

    No

    String

    +

    String

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

    +

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

    status

    +

    status

    No

    +

    No

    String

    +

    String

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

    -

    Enumeration values:

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

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

    +

    Enumeration values:

    +
    • available

      +
    • protecting

      +
    • deleting

      +
    • restoring

      +
    • error

      +
    • waiting_protect

      +
    • waiting_delete

      +
    • waiting_restore

      +

    used_percent

    +

    used_percent

    No

    +

    No

    String

    +

    String

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

    +

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

    vault_id

    +

    vault_id

    No

    +

    No

    String

    +

    String

    Vault ID

    +

    Vault ID

    -

    Request Parameters

    -
    Table 3 Request header parameters

    Parameter

    +

    Request Parameters

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

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

    +

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

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 4 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    backups

    +

    backups

    Array of BackupResp objects

    +

    Array of BackupResp objects

    Backup list

    +

    Backup list

    count

    +

    count

    Integer

    +

    Integer

    Number of backups

    +

    Number of backups

    offset

    +

    offset

    Integer

    +

    Integer

    Offset where the query starts

    -

    Minimum: 0

    -

    Default: 0

    +

    Offset where the query starts

    +

    Minimum: 0

    +

    Default: 0

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page

    -

    Minimum: 1

    -

    Maximum: 1000

    -

    Default: 1000

    +

    Number of records displayed on each page

    +

    Minimum: 1

    +

    Maximum: 1000

    +

    Default: 1000

    -
    Table 5 BackupResp

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    checkpoint_id

    +

    checkpoint_id

    String

    +

    String

    Restore point ID

    +

    Restore point ID

    created_at

    +

    created_at

    String

    +

    String

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

    +

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

    description

    +

    description

    String

    +

    String

    Backup description

    +

    Backup description

    expired_at

    +

    expired_at

    String

    +

    String

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

    +

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

    extend_info

    +

    extend_info

    BackupExtendInfo object

    +

    BackupExtendInfo object

    Extended information

    +

    Extended information

    id

    +

    id

    String

    +

    String

    Backup ID

    +

    Backup ID

    image_type

    +

    image_type

    String

    +

    String

    Backup type, which is backup.

    +

    Backup type, which is backup.

    name

    +

    name

    String

    +

    String

    Backup name

    +

    Backup name

    parent_id

    +

    parent_id

    String

    +

    String

    Parent backup ID

    +

    Parent backup ID

    project_id

    +

    project_id

    String

    +

    String

    Project ID

    +

    Project ID

    protected_at

    +

    protected_at

    String

    +

    String

    Backup time

    +

    Backup time

    resource_az

    +

    resource_az

    String

    +

    String

    Resource availability zone

    +

    Resource availability zone

    resource_id

    +

    resource_id

    String

    +

    String

    Resource ID

    +

    Resource ID

    resource_name

    +

    resource_name

    String

    +

    String

    Resource name

    +

    Resource name

    resource_size

    +

    resource_size

    Integer

    +

    Integer

    Resource size, in GB

    +

    Resource size, in GB

    resource_type

    +

    resource_type

    String

    +

    String

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

    +

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

    status

    +

    status

    String

    +

    String

    Backup status

    -

    Enumeration values:

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

    Backup status

    +

    Enumeration values:

    +
    • available

      +
    • protecting

      +
    • deleting

      +
    • restoring

      +
    • error

      +
    • waiting_protect

      +
    • waiting_delete

      +
    • waiting_restore

      +

    updated_at

    +

    updated_at

    String

    +

    String

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

    +

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

    vault_id

    +

    vault_id

    String

    +

    String

    Vault ID

    +

    Vault ID

    provider_id

    +

    provider_id

    String

    +

    String

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

    -

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

    +

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

    +

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

    children

    +

    children

    Array of BackupResp objects

    +

    Array of BackupResp objects

    Backup list

    +

    Backup list

    -
    Table 6 BackupExtendInfo

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    auto_trigger

    +

    auto_trigger

    Boolean

    +

    Boolean

    Whether the backup is automatically generated

    +

    Whether the backup is automatically generated

    bootable

    +

    bootable

    Boolean

    +

    Boolean

    Whether the backup is a system disk backup

    +

    Whether the backup is a system disk backup

    incremental

    +

    incremental

    Boolean

    +

    Boolean

    Whether the backup is an incremental backup

    +

    Whether the backup is an incremental backup

    snapshot_id

    +

    snapshot_id

    String

    +

    String

    Snapshot ID of the disk backup

    +

    Snapshot ID of the disk backup

    support_lld

    +

    support_lld

    Boolean

    +

    Boolean

    Whether to allow lazyloading for fast restoration

    +

    Whether to allow lazyloading for fast restoration

    supported_restore_mode

    +

    supported_restore_mode

    String

    +

    String

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

    -

    Default: na

    -

    Enumeration values:

    -
    • na
    • backup
    • snapshot
    +

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

    +

    Default: na

    +

    Enumeration values:

    +
    • na

      +
    • backup

      +
    • snapshot

      +

    os_images_data

    +

    os_images_data

    Array of ImageData objects

    +

    Array of ImageData objects

    ID list of images created using backups

    +

    ID list of images created using backups

    contain_system_disk

    +

    contain_system_disk

    Boolean

    +

    Boolean

    Whether the VM backup data contains system disk data

    +

    Whether the VM backup data contains system disk data

    encrypted

    +

    encrypted

    Boolean

    +

    Boolean

    Whether the backup is encrypted

    +

    Whether the backup is encrypted

    system_disk

    +

    system_disk

    Boolean

    +

    Boolean

    Whether the disk is a system disk

    +

    Whether the disk is a system disk

    -
    Table 7 ImageData

    Parameter

    +
    - - - - -
    Table 7 ImageData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    image_id

    +

    image_id

    String

    +

    String

    Image ID

    +

    Image ID

    -

    Example Requests

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

    Example Requests

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

    Example Responses

    Status code: 200

    -

    OK

    -
    {
    +

    Example Responses

    Status code: 200

    +

    OK

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

    Status Codes

    -
    - @@ -793,7 +793,7 @@

    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/ListOpLogs.html b/docs/cbr/api-ref/ListOpLogs.html index a725424b..57ae3e7b 100644 --- a/docs/cbr/api-ref/ListOpLogs.html +++ b/docs/cbr/api-ref/ListOpLogs.html @@ -758,7 +758,7 @@

    operation_logs

    Array of OperationLog objects

    +

    Array of OperationLog objects

    Task list

    -
    Table 18 OperationLog

    Parameter

    +
    @@ -824,14 +824,14 @@ - - @@ -925,7 +925,7 @@
    Table 18 OperationLog

    Parameter

    Type

    error_info

    OpErrorInfo object

    +

    OpErrorInfo object

    Task error message

    extra_info

    OpExtraInfo object

    +

    OpExtraInfo object

    Task extension information

    -
    Table 19 OpErrorInfo

    Parameter

    +
    @@ -951,7 +951,7 @@
    Table 19 OpErrorInfo

    Parameter

    Type

    -
    Table 20 OpExtraInfo

    Parameter

    +
    @@ -961,56 +961,56 @@ - - - - - - - - @@ -1019,7 +1019,7 @@
    Table 20 OpExtraInfo

    Parameter

    Type

    backup

    OpExtendInfoBckup object

    +

    OpExtendInfoBckup object

    Extended parameters of backup

    common

    OpExtendInfoCommon object

    +

    OpExtendInfoCommon object

    Common parameters

    delete

    OpExtendInfoDelete object

    +

    OpExtendInfoDelete object

    Extended parameters of deletion

    sync

    OpExtendInfoSync object

    +

    OpExtendInfoSync object

    Extended parameters of synchronization

    remove_resources

    OpExtendInfoRemoveResources object

    +

    OpExtendInfoRemoveResources object

    Extended parameters of removing resources from a vault

    resource

    Resource object

    +

    Resource object

    Resource information

    restore

    OpExtendInfoRestore object

    +

    OpExtendInfoRestore object

    Extended parameters of restoration

    vault_delete

    OpExtendInfoVaultDelete object

    +

    OpExtendInfoVaultDelete object

    Extended parameters of deleting a vault

    -
    Table 21 OpExtendInfoBckup

    Parameter

    +
    @@ -1056,7 +1056,7 @@
    Table 21 OpExtendInfoBckup

    Parameter

    Type

    -
    Table 22 OpExtendInfoCommon

    Parameter

    +
    @@ -1091,7 +1091,7 @@
    Table 22 OpExtendInfoCommon

    Parameter

    Type

    -
    Table 23 OpExtendInfoDelete

    Parameter

    +
    @@ -1117,7 +1117,7 @@
    Table 23 OpExtendInfoDelete

    Parameter

    Type

    -
    Table 24 OpExtendInfoSync

    Parameter

    +
    @@ -1150,7 +1150,7 @@
    Table 24 OpExtendInfoSync

    Parameter

    Type

    -
    Table 25 OpExtendInfoRemoveResources

    Parameter

    +
    @@ -1174,7 +1174,7 @@ - @@ -1183,7 +1183,7 @@
    Table 25 OpExtendInfoRemoveResources

    Parameter

    Type

    resources

    Array of Resource objects

    +

    Array of Resource objects

    Resource information

    -
    Table 26 Resource

    Parameter

    +
    @@ -1193,7 +1193,7 @@ - @@ -1225,7 +1225,7 @@
    Table 26 Resource

    Parameter

    Type

    extra_info

    ResourceExtraInfo object

    +

    ResourceExtraInfo object

    Vault name

    -
    Table 27 ResourceExtraInfo

    Parameter

    +
    @@ -1244,7 +1244,7 @@
    Table 27 ResourceExtraInfo

    Parameter

    Type

    -
    Table 28 OpExtendInfoRestore

    Parameter

    +
    @@ -1284,7 +1284,7 @@
    Table 28 OpExtendInfoRestore

    Parameter

    Type

    -
    Table 29 OpExtendInfoVaultDelete

    Parameter

    +
    diff --git a/docs/cbr/api-ref/ListPolicies.html b/docs/cbr/api-ref/ListPolicies.html index b52e7fca..493e17f2 100644 --- a/docs/cbr/api-ref/ListPolicies.html +++ b/docs/cbr/api-ref/ListPolicies.html @@ -1,358 +1,353 @@

    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

    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 is backup

    -

    Enumeration values:

    -
    • backup

      -
    • replication

      -
    +

    Policy type, which is backup

    +

    Enumeration values: backup

    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 is backup

    -

    Enumeration values:

    -
    • backup

      -
    +

    Protection type, which is backup

    +

    Enumeration values:

    +
    • backup

    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

    +

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

    +

    Minimum: 0

    +

    Maximum: 100

    max_backups

    +

    max_backups

    Integer

    +

    Integer

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

    -

    Minimum: 1

    -

    Maximum: 99999

    -

    Default: -1

    +

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

    +

    Minimum: 1

    +

    Maximum: 99999

    +

    Default: -1

    month_backups

    +

    month_backups

    Integer

    +

    Integer

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

    -

    Minimum: 0

    -

    Maximum: 100

    +

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

    +

    Minimum: 0

    +

    Maximum: 100

    retention_duration_days

    +

    retention_duration_days

    Integer

    +

    Integer

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

    -

    Minimum: 1

    -

    Maximum: 99999

    -

    Default: -1

    +

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

    +

    Minimum: 1

    +

    Maximum: 99999

    +

    Default: -1

    timezone

    +

    timezone

    String

    +

    String

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

    +

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

    week_backups

    +

    week_backups

    Integer

    +

    Integer

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

    +

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

    year_backups

    +

    year_backups

    Integer

    +

    Integer

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

    -

    Minimum: 0

    -

    Maximum: 100

    +

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

    +

    Minimum: 0

    +

    Maximum: 100

    -
    Table 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" : [ ],
    @@ -380,23 +375,23 @@
       "count" : 10
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    OK

    +

    OK

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cbr/api-ref/ShowMembersDetail.html b/docs/cbr/api-ref/ShowMembersDetail.html index be6a9f72..6210e221 100644 --- a/docs/cbr/api-ref/ShowMembersDetail.html +++ b/docs/cbr/api-ref/ShowMembersDetail.html @@ -1,255 +1,258 @@

    Obtaining the Share Member List

    -

    Function

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

    +

    Function

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

    -

    URI

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

    +

    URI

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

    -
    Table 1 Path Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    backup_id

    +

    backup_id

    Yes

    +

    Yes

    String

    +

    String

    Backup ID

    +

    Backup ID

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID

    +

    Project ID

    -
    Table 2 Query Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    dest_project_id

    +

    dest_project_id

    No

    +

    No

    String

    +

    String

    ID of the project with which the backup is shared

    +

    ID of the project with which the backup is shared

    image_id

    +

    image_id

    No

    +

    No

    String

    +

    String

    ID of the image created from the accepted backup

    +

    ID of the image created from the accepted backup

    limit

    +

    limit

    No

    +

    No

    Integer

    +

    Integer

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

    +

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

    marker

    +

    marker

    No

    +

    No

    String

    +

    String

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

    +

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

    offset

    +

    offset

    No

    +

    No

    Integer

    +

    Integer

    Offset value, which is a positive integer.

    +

    Offset value, which is a positive integer.

    sort

    +

    sort

    No

    +

    No

    String

    +

    String

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

    +

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

    status

    +

    status

    No

    +

    No

    String

    +

    String

    Status of a shared backup

    +

    Status of a shared backup

    vault_id

    +

    vault_id

    No

    +

    No

    String

    +

    String

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

    +

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

    -

    Request Parameters

    -
    Table 3 Request header parameters

    Parameter

    +

    Request Parameters

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

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

    +

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

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 4 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    members

    +

    members

    Array of Member objects

    +

    Array of Member objects

    Response parameters of adding a backup share member

    +

    Response parameters of adding a backup share member

    count

    +

    count

    Integer

    +

    Integer

    Number of share members that the backup is shared to

    +

    Number of share members that the backup is shared to

    -
    Table 5 Member

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 Member

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    status

    +

    status

    String

    +

    String

    Backup sharing status

    -

    Enumeration values:

    -
    • pending
    • accepted
    • rejected
    +

    Backup sharing status

    +

    Enumeration values:

    +
    • pending

      +
    • accepted

      +
    • rejected

      +

    created_at

    +

    created_at

    String

    +

    String

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

    +

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

    updated_at

    +

    updated_at

    String

    +

    String

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

    +

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

    backup_id

    +

    backup_id

    String

    +

    String

    Backup ID

    +

    Backup ID

    image_id

    +

    image_id

    String

    +

    String

    ID of the image created by using the accepted shared backup

    +

    ID of the image created by using the accepted shared backup

    dest_project_id

    +

    dest_project_id

    String

    +

    String

    ID of the project with which the backup is shared

    +

    ID of the project with which the backup is shared

    vault_id

    +

    vault_id

    String

    +

    String

    ID of the vault where the shared backup is stored

    +

    ID of the vault where the shared backup is stored

    id

    +

    id

    String

    +

    String

    ID of the shared record

    +

    ID of the shared record

    -

    Example Requests

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

    Example Requests

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

    Example Responses

    Status code: 200

    -

    OK

    -
    {
    +

    Example Responses

    Status code: 200

    +

    OK

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

    Status Codes

    -
    - @@ -508,7 +508,7 @@

    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/ShowVault.html b/docs/cbr/api-ref/ShowVault.html index 14857d8e..070d17dc 100644 --- a/docs/cbr/api-ref/ShowVault.html +++ b/docs/cbr/api-ref/ShowVault.html @@ -499,7 +499,7 @@

    vault

    Vault object

    +

    Vault object

    Objects returned after the query by a vault

    -
    Table 12 Vault

    Parameter

    +
    @@ -518,7 +518,7 @@ - @@ -564,14 +564,14 @@ - - @@ -585,7 +585,7 @@ - @@ -615,7 +615,7 @@
    Table 12 Vault

    Parameter

    Type

    billing

    Billing object

    +

    Billing object

    Operation info

    resources

    Array of ResourceResp objects

    +

    Array of ResourceResp objects

    Vault resources

    tags

    Array of Tag objects

    +

    Array of Tag objects

    Vault tags

    bind_rules

    VaultBindRules object

    +

    VaultBindRules object

    Association rule

    -
    Table 13 Billing

    Parameter

    +
    @@ -734,7 +734,7 @@
    Table 13 Billing

    Parameter

    Type

    -
    Table 14 ResourceResp

    Parameter

    +
    @@ -744,7 +744,7 @@ - @@ -811,7 +811,7 @@
    Table 14 ResourceResp

    Parameter

    Type

    extra_info

    ResourceExtraInfo object

    +

    ResourceExtraInfo object

    Additional information of the resource

    -
    Table 15 ResourceExtraInfo

    Parameter

    +
    @@ -830,7 +830,7 @@
    Table 15 ResourceExtraInfo

    Parameter

    Type

    -
    Table 16 Tag

    Parameter

    +
    @@ -867,7 +867,7 @@
    Table 16 Tag

    Parameter

    Type

    -
    Table 17 VaultBindRules

    Parameter

    +
    @@ -877,7 +877,7 @@ - @@ -886,7 +886,7 @@
    Table 17 VaultBindRules

    Parameter

    Type

    tags

    Array of BindRulesTags objects

    +

    Array of BindRulesTags objects

    Filters automatically associated resources by tag.

    -
    Table 18 BindRulesTags

    Parameter

    +
    diff --git a/docs/cbr/api-ref/ShowVaultProjectTag.html b/docs/cbr/api-ref/ShowVaultProjectTag.html index 0c19d6ef..805dbeee 100644 --- a/docs/cbr/api-ref/ShowVaultProjectTag.html +++ b/docs/cbr/api-ref/ShowVaultProjectTag.html @@ -150,7 +150,7 @@
    diff --git a/docs/cbr/api-ref/ShowVaultResourceInstances.html b/docs/cbr/api-ref/ShowVaultResourceInstances.html index a97a47e1..0ccc4306 100644 --- a/docs/cbr/api-ref/ShowVaultResourceInstances.html +++ b/docs/cbr/api-ref/ShowVaultResourceInstances.html @@ -54,12 +54,13 @@ - - - - - @@ -792,7 +793,7 @@
    diff --git a/docs/cbr/api-ref/ShowVaultTag.html b/docs/cbr/api-ref/ShowVaultTag.html index 08d68460..efac9528 100644 --- a/docs/cbr/api-ref/ShowVaultTag.html +++ b/docs/cbr/api-ref/ShowVaultTag.html @@ -167,7 +167,7 @@
    diff --git a/docs/cbr/api-ref/cbr_04_0015.html b/docs/cbr/api-ref/cbr_04_0015.html index e4de2eb8..f01ec709 100644 --- a/docs/cbr/api-ref/cbr_04_0015.html +++ b/docs/cbr/api-ref/cbr_04_0015.html @@ -19,7 +19,7 @@ - diff --git a/docs/cbr/api-ref/cbr_04_0017.html b/docs/cbr/api-ref/cbr_04_0017.html index 241baaf3..243c11d5 100644 --- a/docs/cbr/api-ref/cbr_04_0017.html +++ b/docs/cbr/api-ref/cbr_04_0017.html @@ -1,18 +1,18 @@

    Introduction

    -

    This section describes fine-grained permissions management for your CBR. If your cloud account does not need individual IAM users, skip this section.

    -

    By default, new IAM users do not have permissions assigned. You need to add the users to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.

    -

    You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.

    -

    Policy-based authorization is useful if you want to allow or deny the access to an API.

    +

    You can use Identity and Access Management (IAM) for fine-grained permissions management of your CBR resources. If your account does not need individual IAM users, you can skip this section.

    +

    New IAM users do not have any permissions assigned by default. You need to first add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups and can perform specified operations on cloud services based on the permissions they have been assigned.

    +

    You can grant users permissions using roles and policies. Roles are provided by IAM to define service-based permissions that match user's job responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.

    +

    If you want to allow or deny the access to an API, use policy-based authorization.

    -

    An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the ecs:servers:list action.

    -

    Supported Actions

    CBR provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. The following are common concepts related to policies:

    -
    • Permissions: Statements in a policy that allow or deny certain operations.
    • APIs: REST APIs that can be called by a user who has been granted specific permissions.
    • Actions: Specific operations that are allowed or denied.
    • Related actions: Actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the related actions.
    • IAM: Type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM.
    • The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.

      +

      Each account has all the permissions required to call all APIs, but IAM users must be granted the required permissions. The required permissions are determined by the actions supported by the API. Only users with the policies allowing for those actions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the ecs:servers:list action.

      +

      Supported Actions

      CBR provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:

      +
      • Permissions: statements in a policy that allow or deny certain operations
      • APIs: REST APIs that can be called by a user who has been granted specific permissions
      • Actions: specific operations that are allowed or denied
      • Dependencies: actions which a specific action depends on. When allowing an action for a user, you also need to allow any existing action dependencies for that user.
      • IAM projects: the authorization scope of a custom policy
      +

      The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.

      -
    -

    CBR supports the following actions that can be defined in custom policies:

    -
    • [Example] Vault includes actions supported by CBR vault APIs, such as APIs for creating, modifying, and deleting a vault, querying the vault list, as well as adding and removing resources.
    • [Example] Backup Sharing includes actions supported by CBR backup sharing APIs, such as APIs for adding share members, obtaining the share member list, and updating the share member status.
    +

    CBR supports the following actions in custom policies:

    +
    • [Example] Vault actions (Vault), including all of the actions supported by CBR vault APIs, such as the APIs for creating, modifying, and deleting a vault, querying the vault list, as well as adding and removing resources.
    • [Example] Backup sharing actions (Backup Sharing), including actions supported by CBR backup sharing APIs, such as APIs for adding share members, obtaining the share member list, and updating the share member status.
    diff --git a/docs/cbr/api-ref/cbr_04_0025.html b/docs/cbr/api-ref/cbr_04_0025.html index dd95d363..6c5dbe25 100644 --- a/docs/cbr/api-ref/cbr_04_0025.html +++ b/docs/cbr/api-ref/cbr_04_0025.html @@ -8,7 +8,13 @@
    - + + +
    Table 18 BindRulesTags

    Parameter

    Type

    Array of TagsReq objects

    List of included tags. Backups with these tags will be filtered.

    +

    List of included tags

    This list cannot be an empty list.

    -

    The list can contain up to 10 keys.

    +

    The list can contain up to 20 keys.

    Keys in this list must be unique.

    -

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

    -

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

    +

    Values in this list are in an AND relationship.

    +

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

    +

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

    tags_any

    @@ -68,12 +69,12 @@

    Array of TagsReq objects

    List of tags. Backups with any tags in this list will be filtered.

    +

    List of any included tags

    This list cannot be an empty list.

    -

    The list can contain up to 10 keys.

    +

    The list can contain up to 20 keys.

    Keys in this list must be unique.

    -

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

    -

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

    +

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

    +

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

    not_tags

    @@ -82,12 +83,12 @@

    Array of TagsReq objects

    List of excluded tags. Backups without these tags will be filtered.

    +

    List of excluded tags

    This list cannot be an empty list.

    -

    The list can contain up to 10 keys.

    +

    The list can contain up to 20 keys.

    Keys in this list must be unique.

    -

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

    -

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

    +

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

    +

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

    not_tags_any

    @@ -96,12 +97,12 @@

    Array of TagsReq objects

    List of tags. Backups without any tags in this list will be filtered.

    +

    List of any excluded tags

    This list cannot be an empty list.

    -

    The list can contain up to 10 keys.

    +

    The list can contain up to 20 keys.

    Keys in this list must be unique.

    -

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

    -

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

    +

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

    +

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

    limit

    @@ -200,14 +201,14 @@

    Array of strings

    List of values

    -

    The list can contain up to 10 values.

    +

    Lists the values

    +

    The list can contain up to 20 values.

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

    Values in this list must be unique.

    Values in this list are in an OR relationship.

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

    -

    If this list is left blank, it indicates that all values are included.

    -

    The asterisk (*) is a reserved character in the system. If the value starts with *, it indicates that fuzzy match is performed based on the value following *. The value cannot contain only asterisks.

    +

    An empty value list means any values.

    +

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

    2023-03-21

    +

    2023-08-11

    +

    Updated the following content:

    +
    • Modified the maximum number of tags that can be added to a vault.
    +

    2023-03-21

    Updated the following content:

    • Modified the issue that response parameters in the table are inconsistent with those in the example response in section "Creating a Vault."
    • Modified the rules defined by bind_rules for vault APIs.
    • Modified parameter restrictions in section "Querying Vault Resources."
    • Modified the vault's minimum capacity in section "Creating a Vault."
    • Modified the description of api_version in section "Querying a Specified API Version."
    diff --git a/docs/cbr/api-ref/topic_300000007.html b/docs/cbr/api-ref/topic_300000008.html similarity index 90% rename from docs/cbr/api-ref/topic_300000007.html rename to docs/cbr/api-ref/topic_300000008.html index 66a20ad1..d0d4ef44 100644 --- a/docs/cbr/api-ref/topic_300000007.html +++ b/docs/cbr/api-ref/topic_300000008.html @@ -1,7 +1,7 @@ - +

    Tags

    -

    +