doc-exports/docs/cbr/api-ref/CLASS.TXT.json
Wei, Hongmin 8682f10aa4 CBR API second version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-12-13 08:11:44 +00:00

443 lines
16 KiB
JSON

[
{
"desc":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ",
"product_code":"cbr",
"title":"API Usage Guidelines",
"uri":"cbr_04_0001.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"CBR APIs",
"uri":"cbr_04_0015.html",
"doc_type":"api",
"p_code":"",
"code":"2"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"API Version Query",
"uri":"topic_300000000.html",
"doc_type":"api",
"p_code":"2",
"code":"3"
},
{
"desc":"This API is used to query the information of API versions.GET /NoneStatus code: 300NoneNoneSee Error Codes.",
"product_code":"cbr",
"title":"Querying API Versions",
"uri":"ListVersions.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
"desc":"This API is used to query the information of a specified API version.GET /{api_version}NoneStatus code: 300NoneNoneSee Error Codes.",
"product_code":"cbr",
"title":"Querying a Specified API Version",
"uri":"ShowVersion.html",
"doc_type":"api",
"p_code":"3",
"code":"5"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"Tasks",
"uri":"topic_300000001.html",
"doc_type":"api",
"p_code":"2",
"code":"6"
},
{
"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",
"title":"Querying a Single Task",
"uri":"ShowOpLog.html",
"doc_type":"api",
"p_code":"6",
"code":"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",
"title":"Querying the Task List",
"uri":"ListOpLogs.html",
"doc_type":"api",
"p_code":"6",
"code":"8"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"Backup Sharing",
"uri":"topic_300000002.html",
"doc_type":"api",
"p_code":"2",
"code":"9"
},
{
"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",
"title":"Adding a Share Member",
"uri":"AddMember.html",
"doc_type":"api",
"p_code":"9",
"code":"10"
},
{
"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",
"title":"Obtaining the Share Member List",
"uri":"ShowMembersDetail.html",
"doc_type":"api",
"p_code":"9",
"code":"11"
},
{
"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",
"title":"Updating the Share Member Status",
"uri":"UpdateMemberStatus.html",
"doc_type":"api",
"p_code":"9",
"code":"12"
},
{
"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",
"title":"Deleting a Specified Share Member",
"uri":"DeleteMember.html",
"doc_type":"api",
"p_code":"9",
"code":"13"
},
{
"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",
"title":"Querying Share Member Details",
"uri":"ShowMemberDetail.html",
"doc_type":"api",
"p_code":"9",
"code":"14"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"Restore Points",
"uri":"topic_300000003.html",
"doc_type":"api",
"p_code":"2",
"code":"15"
},
{
"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",
"title":"Querying a Restore Point",
"uri":"ShowCheckpoint.html",
"doc_type":"api",
"p_code":"15",
"code":"16"
},
{
"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",
"title":"Creating a Restore Point",
"uri":"CreateCheckpoint.html",
"doc_type":"api",
"p_code":"15",
"code":"17"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"Vaults",
"uri":"topic_300000004.html",
"doc_type":"api",
"p_code":"2",
"code":"18"
},
{
"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",
"title":"Creating a Vault",
"uri":"CreateVault.html",
"doc_type":"api",
"p_code":"18",
"code":"19"
},
{
"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",
"title":"Querying a Specified Vault",
"uri":"ShowVault.html",
"doc_type":"api",
"p_code":"18",
"code":"20"
},
{
"desc":"This API is used to query the vault list.GET /v3/{project_id}/vaultsStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"cbr",
"title":"Querying the Vault List",
"uri":"ListVault.html",
"doc_type":"api",
"p_code":"18",
"code":"21"
},
{
"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",
"title":"Modifying a Vault",
"uri":"UpdateVault.html",
"doc_type":"api",
"p_code":"18",
"code":"22"
},
{
"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",
"title":"Deleting a Vault",
"uri":"DeleteVault.html",
"doc_type":"api",
"p_code":"18",
"code":"23"
},
{
"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",
"title":"Dissociating Resources",
"uri":"RemoveVaultResource.html",
"doc_type":"api",
"p_code":"18",
"code":"24"
},
{
"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",
"title":"Associating Resources",
"uri":"AddVaultResource.html",
"doc_type":"api",
"p_code":"18",
"code":"25"
},
{
"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",
"title":"Applying a Policy to a Vault",
"uri":"AssociateVaultPolicy.html",
"doc_type":"api",
"p_code":"18",
"code":"26"
},
{
"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",
"title":"Removing a Policy from a Vault",
"uri":"DisassociateVaultPolicy.html",
"doc_type":"api",
"p_code":"18",
"code":"27"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"Backups",
"uri":"topic_300000005.html",
"doc_type":"api",
"p_code":"2",
"code":"28"
},
{
"desc":"This API is used to query the backup of a specific ID.GET /v3/{project_id}/backups/{backup_id}Status code: 200Status code: 200OKSee Error Codes.",
"product_code":"cbr",
"title":"Querying a Specified Backup",
"uri":"ShowBackup.html",
"doc_type":"api",
"p_code":"28",
"code":"29"
},
{
"desc":"This API is used to query all backups.GET /v3/{project_id}/backupsStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"cbr",
"title":"Querying All Backups",
"uri":"ListBackups.html",
"doc_type":"api",
"p_code":"28",
"code":"30"
},
{
"desc":"This API is used to delete a single backup.DELETE /v3/{project_id}/backups/{backup_id}NoneNoneSee Error Codes.",
"product_code":"cbr",
"title":"Deleting a Backup",
"uri":"DeleteBackup.html",
"doc_type":"api",
"p_code":"28",
"code":"31"
},
{
"desc":"This API is used to restore backup data.POST /v3/{project_id}/backups/{backup_id}/restoreNoneNoneSee Error Codes.",
"product_code":"cbr",
"title":"Restoring a Backup",
"uri":"RestoreBackup.html",
"doc_type":"api",
"p_code":"28",
"code":"32"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"Policies",
"uri":"topic_300000006.html",
"doc_type":"api",
"p_code":"2",
"code":"33"
},
{
"desc":"This API is used to create a backup policy.POST /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"cbr",
"title":"Creating a Policy",
"uri":"CreatePolicy.html",
"doc_type":"api",
"p_code":"33",
"code":"34"
},
{
"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",
"title":"Querying a Single Policy",
"uri":"ShowPolicy.html",
"doc_type":"api",
"p_code":"33",
"code":"35"
},
{
"desc":"This API is used to query the policy list.GET /v3/{project_id}/policiesStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"cbr",
"title":"Querying the Policy List",
"uri":"ListPolicies.html",
"doc_type":"api",
"p_code":"33",
"code":"36"
},
{
"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",
"title":"Modifying a Policy",
"uri":"UpdatePolicy.html",
"doc_type":"api",
"p_code":"33",
"code":"37"
},
{
"desc":"This API is used to delete a policy.DELETE /v3/{project_id}/policies/{policy_id}NoneNoneSee Error Codes.",
"product_code":"cbr",
"title":"Deleting a Policy",
"uri":"DeletePolicy.html",
"doc_type":"api",
"p_code":"33",
"code":"38"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"Tags",
"uri":"topic_300000007.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",
"title":"Querying Vault Resources",
"uri":"ShowVaultResourceInstances.html",
"doc_type":"api",
"p_code":"39",
"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",
"title":"Batch Adding or Deleting Tags of a Vault",
"uri":"BatchCreateAndDeleteVaultTags.html",
"doc_type":"api",
"p_code":"39",
"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",
"title":"Adding a Tag to an Associated Resource",
"uri":"CreateVaultTags.html",
"doc_type":"api",
"p_code":"39",
"code":"42"
},
{
"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",
"title":"Deleting a Tag from an Associated Resource",
"uri":"DeleteVaultTag.html",
"doc_type":"api",
"p_code":"39",
"code":"43"
},
{
"desc":"This API is used to query tags of a specified resource. TMS uses this API to query all tags of a specified resource.GET /v3/{project_id}/vault/{vault_id}/tagsNoneStatus c",
"product_code":"cbr",
"title":"Querying Tags of an Associated Resource",
"uri":"ShowVaultTag.html",
"doc_type":"api",
"p_code":"39",
"code":"44"
},
{
"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",
"title":"Querying Tags of a Vault Project",
"uri":"ShowVaultProjectTag.html",
"doc_type":"api",
"p_code":"39",
"code":"45"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"Appendix",
"uri":"cbr_04_0019.html",
"doc_type":"api",
"p_code":"",
"code":"46"
},
{
"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",
"product_code":"cbr",
"title":"Status Codes",
"uri":"cbr_04_0020.html",
"doc_type":"api",
"p_code":"46",
"code":"47"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"cbr",
"title":"Error Codes",
"uri":"ErrorCode.html",
"doc_type":"api",
"p_code":"46",
"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.",
"product_code":"cbr",
"title":"Change History",
"uri":"cbr_04_0025.html",
"doc_type":"api",
"p_code":"",
"code":"49"
}
]