diff --git a/docs/cbr/api-ref/ALL_META.TXT.json b/docs/cbr/api-ref/ALL_META.TXT.json index 7d16cb03..5edad1c8 100644 --- a/docs/cbr/api-ref/ALL_META.TXT.json +++ b/docs/cbr/api-ref/ALL_META.TXT.json @@ -270,9 +270,19 @@ "githuburl":"" }, { - "uri":"topic_300000005.html", + "uri":"MigrateVaultResource.html", "product_code":"", "code":"28", + "des":"This API is used to associate resources with another vault and migrate the resource backups to that destination vault.POST /v3/{project_id}/vaults/{vault_id}/migrateresou", + "doc_type":"api", + "kw":"Migrating Resources,Vaults,API Reference", + "title":"Migrating Resources", + "githuburl":"" + }, + { + "uri":"topic_300000005.html", + "product_code":"", + "code":"29", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Backups", @@ -282,7 +292,7 @@ { "uri":"ShowBackup.html", "product_code":"", - "code":"29", + "code":"30", "des":"This API is used to query the backup of a specific ID.GET /v3/{project_id}/backups/{backup_id}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Querying a Specified Backup,Backups,API Reference", @@ -292,7 +302,7 @@ { "uri":"ListBackups.html", "product_code":"", - "code":"30", + "code":"31", "des":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Querying All Backups,Backups,API Reference", @@ -302,7 +312,7 @@ { "uri":"DeleteBackup.html", "product_code":"", - "code":"31", + "code":"32", "des":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.", "doc_type":"api", "kw":"Deleting a Backup,Backups,API Reference", @@ -312,7 +322,7 @@ { "uri":"RestoreBackup.html", "product_code":"", - "code":"32", + "code":"33", "des":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", "doc_type":"api", "kw":"Restoring a Backup,Backups,API Reference", @@ -322,7 +332,7 @@ { "uri":"topic_300000006.html", "product_code":"", - "code":"33", + "code":"34", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Policies", @@ -332,7 +342,7 @@ { "uri":"CreatePolicy.html", "product_code":"", - "code":"34", + "code":"35", "des":"This API is used to create a backup policy.POST /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Creating a Policy,Policies,API Reference", @@ -342,7 +352,7 @@ { "uri":"ShowPolicy.html", "product_code":"", - "code":"35", + "code":"36", "des":"This API is used to query a single policy.GET /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Querying a Single Policy,Policies,API Reference", @@ -352,7 +362,7 @@ { "uri":"ListPolicies.html", "product_code":"", - "code":"36", + "code":"37", "des":"This API is used to query the policy list.GET /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Querying the Policy List,Policies,API Reference", @@ -362,7 +372,7 @@ { "uri":"UpdatePolicy.html", "product_code":"", - "code":"37", + "code":"38", "des":"This API is used to modify a policy.PUT /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Modifying a Policy,Policies,API Reference", @@ -372,7 +382,7 @@ { "uri":"DeletePolicy.html", "product_code":"", - "code":"38", + "code":"39", "des":"This API is used to delete a policy.DELETE /v3/{project_id}/policies/{policy_id}NoneNoneSee Error Codes.", "doc_type":"api", "kw":"Deleting a Policy,Policies,API Reference", @@ -382,7 +392,7 @@ { "uri":"topic_300000008.html", "product_code":"", - "code":"39", + "code":"40", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Tags", @@ -392,7 +402,7 @@ { "uri":"ShowVaultResourceInstances.html", "product_code":"", - "code":"40", + "code":"41", "des":"This API is used to filter resources by tag. Tag Management Service (TMS) uses this API to filter and list resources of each service by tag. These services must have the ", "doc_type":"api", "kw":"Querying Vault Resources,Tags,API Reference", @@ -402,7 +412,7 @@ { "uri":"BatchCreateAndDeleteVaultTags.html", "product_code":"", - "code":"41", + "code":"42", "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", @@ -412,7 +422,7 @@ { "uri":"CreateVaultTags.html", "product_code":"", - "code":"42", + "code":"43", "des":"This API is used to add a tag to an associated resource. A resource can have a maximum of 20 tags. This API is idempotent. If a to-be-added tag has the same key as an exi", "doc_type":"api", "kw":"Adding a Tag to an Associated Resource,Tags,API Reference", @@ -422,7 +432,7 @@ { "uri":"DeleteVaultTag.html", "product_code":"", - "code":"43", + "code":"44", "des":"This API is used to delete a tag from an associated resource. The API is idempotent. When you delete a nonexistent tag, error code 404 will be returned. Tag keys cannot b", "doc_type":"api", "kw":"Deleting a Tag from an Associated Resource,Tags,API Reference", @@ -432,7 +442,7 @@ { "uri":"ShowVaultTag.html", "product_code":"", - "code":"44", + "code":"45", "des":"This API is used to query tags of a specified resource. TMS uses this API to query all tags of a specified resource.GET /v3/{project_id}/vault/{vault_id}/tagsNoneStatus c", "doc_type":"api", "kw":"Querying Tags of an Associated Resource,Tags,API Reference", @@ -442,7 +452,7 @@ { "uri":"ShowVaultProjectTag.html", "product_code":"", - "code":"45", + "code":"46", "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", "kw":"Querying Tags of a Vault Project,Tags,API Reference", @@ -452,7 +462,7 @@ { "uri":"cbr_04_0016.html", "product_code":"cbr", - "code":"46", + "code":"47", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Permissions Policies and Supported Actions", @@ -462,7 +472,7 @@ { "uri":"cbr_04_0017.html", "product_code":"cbr", - "code":"47", + "code":"48", "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", @@ -472,7 +482,7 @@ { "uri":"cbr_04_0018.html", "product_code":"cbr", - "code":"48", + "code":"49", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Category of CBR Actions,Permissions Policies and Supported Actions,API Reference", @@ -482,7 +492,7 @@ { "uri":"cbr_04_0019.html", "product_code":"cbr", - "code":"49", + "code":"50", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendix", @@ -492,7 +502,7 @@ { "uri":"cbr_04_0020.html", "product_code":"cbr", - "code":"50", + "code":"51", "des":"NormalStatus CodeDescription200 OKSpecifies the normal response code for the GET and PUT operations.201 CreatedSpecifies the normal response code for the POST operation.2", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", @@ -502,7 +512,7 @@ { "uri":"ErrorCode.html", "product_code":"cbr", - "code":"51", + "code":"52", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Error Codes,Appendix,API Reference", @@ -512,7 +522,7 @@ { "uri":"cbr_04_0025.html", "product_code":"cbr", - "code":"52", + "code":"53", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/cbr/api-ref/CLASS.TXT.json b/docs/cbr/api-ref/CLASS.TXT.json index f9effa56..7c96de4a 100644 --- a/docs/cbr/api-ref/CLASS.TXT.json +++ b/docs/cbr/api-ref/CLASS.TXT.json @@ -242,6 +242,15 @@ "p_code":"18", "code":"27" }, + { + "desc":"This API is used to associate resources with another vault and migrate the resource backups to that destination vault.POST /v3/{project_id}/vaults/{vault_id}/migrateresou", + "product_code":"", + "title":"Migrating Resources", + "uri":"MigrateVaultResource.html", + "doc_type":"api", + "p_code":"18", + "code":"28" + }, { "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":"", @@ -249,7 +258,7 @@ "uri":"topic_300000005.html", "doc_type":"api", "p_code":"2", - "code":"28" + "code":"29" }, { "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.", @@ -257,8 +266,8 @@ "title":"Querying a Specified Backup", "uri":"ShowBackup.html", "doc_type":"api", - "p_code":"28", - "code":"29" + "p_code":"29", + "code":"30" }, { "desc":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.", @@ -266,8 +275,8 @@ "title":"Querying All Backups", "uri":"ListBackups.html", "doc_type":"api", - "p_code":"28", - "code":"30" + "p_code":"29", + "code":"31" }, { "desc":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.", @@ -275,8 +284,8 @@ "title":"Deleting a Backup", "uri":"DeleteBackup.html", "doc_type":"api", - "p_code":"28", - "code":"31" + "p_code":"29", + "code":"32" }, { "desc":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.", @@ -284,8 +293,8 @@ "title":"Restoring a Backup", "uri":"RestoreBackup.html", "doc_type":"api", - "p_code":"28", - "code":"32" + "p_code":"29", + "code":"33" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -294,7 +303,7 @@ "uri":"topic_300000006.html", "doc_type":"api", "p_code":"2", - "code":"33" + "code":"34" }, { "desc":"This API is used to create a backup policy.POST /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", @@ -302,8 +311,8 @@ "title":"Creating a Policy", "uri":"CreatePolicy.html", "doc_type":"api", - "p_code":"33", - "code":"34" + "p_code":"34", + "code":"35" }, { "desc":"This API is used to query a single policy.GET /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", @@ -311,8 +320,8 @@ "title":"Querying a Single Policy", "uri":"ShowPolicy.html", "doc_type":"api", - "p_code":"33", - "code":"35" + "p_code":"34", + "code":"36" }, { "desc":"This API is used to query the policy list.GET /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.", @@ -320,8 +329,8 @@ "title":"Querying the Policy List", "uri":"ListPolicies.html", "doc_type":"api", - "p_code":"33", - "code":"36" + "p_code":"34", + "code":"37" }, { "desc":"This API is used to modify a policy.PUT /v3/{project_id}/policies/{policy_id}Status code: 200Status code: 200OKSee Error Codes.", @@ -329,8 +338,8 @@ "title":"Modifying a Policy", "uri":"UpdatePolicy.html", "doc_type":"api", - "p_code":"33", - "code":"37" + "p_code":"34", + "code":"38" }, { "desc":"This API is used to delete a policy.DELETE /v3/{project_id}/policies/{policy_id}NoneNoneSee Error Codes.", @@ -338,8 +347,8 @@ "title":"Deleting a Policy", "uri":"DeletePolicy.html", "doc_type":"api", - "p_code":"33", - "code":"38" + "p_code":"34", + "code":"39" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -348,7 +357,7 @@ "uri":"topic_300000008.html", "doc_type":"api", "p_code":"2", - "code":"39" + "code":"40" }, { "desc":"This API is used to filter resources by tag. Tag Management Service (TMS) uses this API to filter and list resources of each service by tag. These services must have the ", @@ -356,8 +365,8 @@ "title":"Querying Vault Resources", "uri":"ShowVaultResourceInstances.html", "doc_type":"api", - "p_code":"39", - "code":"40" + "p_code":"40", + "code":"41" }, { "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", @@ -365,8 +374,8 @@ "title":"Batch Adding or Deleting Tags of a Vault", "uri":"BatchCreateAndDeleteVaultTags.html", "doc_type":"api", - "p_code":"39", - "code":"41" + "p_code":"40", + "code":"42" }, { "desc":"This API is used to add a tag to an associated resource. A resource can have a maximum of 20 tags. This API is idempotent. If a to-be-added tag has the same key as an exi", @@ -374,8 +383,8 @@ "title":"Adding a Tag to an Associated Resource", "uri":"CreateVaultTags.html", "doc_type":"api", - "p_code":"39", - "code":"42" + "p_code":"40", + "code":"43" }, { "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", @@ -383,8 +392,8 @@ "title":"Deleting a Tag from an Associated Resource", "uri":"DeleteVaultTag.html", "doc_type":"api", - "p_code":"39", - "code":"43" + "p_code":"40", + "code":"44" }, { "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", @@ -392,8 +401,8 @@ "title":"Querying Tags of an Associated Resource", "uri":"ShowVaultTag.html", "doc_type":"api", - "p_code":"39", - "code":"44" + "p_code":"40", + "code":"45" }, { "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", @@ -401,8 +410,8 @@ "title":"Querying Tags of a Vault Project", "uri":"ShowVaultProjectTag.html", "doc_type":"api", - "p_code":"39", - "code":"45" + "p_code":"40", + "code":"46" }, { "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.", @@ -411,7 +420,7 @@ "uri":"cbr_04_0016.html", "doc_type":"api", "p_code":"", - "code":"46" + "code":"47" }, { "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", @@ -419,8 +428,8 @@ "title":"Introduction", "uri":"cbr_04_0017.html", "doc_type":"api", - "p_code":"46", - "code":"47" + "p_code":"47", + "code":"48" }, { "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.", @@ -428,8 +437,8 @@ "title":"Category of CBR Actions", "uri":"cbr_04_0018.html", "doc_type":"api", - "p_code":"46", - "code":"48" + "p_code":"47", + "code":"49" }, { "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.", @@ -438,7 +447,7 @@ "uri":"cbr_04_0019.html", "doc_type":"api", "p_code":"", - "code":"49" + "code":"50" }, { "desc":"NormalStatus CodeDescription200 OKSpecifies the normal response code for the GET and PUT operations.201 CreatedSpecifies the normal response code for the POST operation.2", @@ -446,8 +455,8 @@ "title":"Status Codes", "uri":"cbr_04_0020.html", "doc_type":"api", - "p_code":"49", - "code":"50" + "p_code":"50", + "code":"51" }, { "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.", @@ -455,8 +464,8 @@ "title":"Error Codes", "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"49", - "code":"51" + "p_code":"50", + "code":"52" }, { "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.", @@ -465,6 +474,6 @@ "uri":"cbr_04_0025.html", "doc_type":"api", "p_code":"", - "code":"52" + "code":"53" } ] \ No newline at end of file diff --git a/docs/cbr/api-ref/MigrateVaultResource.html b/docs/cbr/api-ref/MigrateVaultResource.html new file mode 100644 index 00000000..f0a6f8e2 --- /dev/null +++ b/docs/cbr/api-ref/MigrateVaultResource.html @@ -0,0 +1,154 @@ + + +

Migrating Resources

+

Function

This API is used to associate resources with another vault and migrate the resource backups to that destination vault.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

vault_id

+

Yes

+

String

+

Vault ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

destination_vault_id

+

Yes

+

String

+

Destination vault

+

resource_ids

+

Yes

+

Array of strings

+

ID of the resource to be migrated

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

migrated_resources

+

Array of strings

+

List of migrated resources

+
+
+
+

Example Requests

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/migrateresources
+
+{
+  "resource_ids" : [ "abcdde3f-e0e3-403a-b690-fc259dd70008" ],
+  "destination_vault_id" : "fe578a6c-d1a8-4790-bd52-5954af4d446c"
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "migrated_resources" : [ "fe578a6c-d1a8-4790-bd52-5954af4d446c" ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Vaults
+
+
+ diff --git a/docs/cbr/api-ref/cbr_04_0025.html b/docs/cbr/api-ref/cbr_04_0025.html index 6c5dbe25..f8015a48 100644 --- a/docs/cbr/api-ref/cbr_04_0025.html +++ b/docs/cbr/api-ref/cbr_04_0025.html @@ -8,7 +8,13 @@ -

2023-08-11

+

2023-09-14

+ +

Updated the following content:

+ + + +

2023-08-11

Updated the following content:

diff --git a/docs/cbr/api-ref/topic_300000004.html b/docs/cbr/api-ref/topic_300000004.html index 68bad076..d89a0535 100644 --- a/docs/cbr/api-ref/topic_300000004.html +++ b/docs/cbr/api-ref/topic_300000004.html @@ -23,6 +23,8 @@
  • Removing a Policy from a Vault
    • +
  • Migrating Resources
    +