doc-exports/docs/csbs/api-ref/CLASS.TXT.json
Wei, Hongmin 8ce662c4dc CSBS API initial version
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-24 21:06:50 +00:00

353 lines
14 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":"csbs",
"title":"API Usage Guidelines",
"uri":"en-us_topic_0061309751.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":"csbs",
"title":"API Description",
"uri":"en-us_topic_0059304034.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":"csbs",
"title":"Resource Management",
"uri":"en-us_topic_0059304218.html",
"doc_type":"api",
"p_code":"2",
"code":"3"
},
{
"desc":"This API is used to create a backup for a specified resource.URI formatPOST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/{resource_id}/actionPOST ",
"product_code":"csbs",
"title":"Creating a Backup for a Resource",
"uri":"en-us_topic_0059304219.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
"desc":"This API is used to query whether a resource can be backed up.URI formatPOST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/actionPOST https://{endp",
"product_code":"csbs",
"title":"Querying the Backup Capability of a Resource",
"uri":"en-us_topic_0059304220.html",
"doc_type":"api",
"p_code":"3",
"code":"5"
},
{
"desc":"This API is used to check whether a target resource can be restored.URI formatPOST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/actionPOST https:/",
"product_code":"csbs",
"title":"Querying the Restoration Capability of a Resource",
"uri":"en-us_topic_0059304221.html",
"doc_type":"api",
"p_code":"3",
"code":"6"
},
{
"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":"csbs",
"title":"Backup Policy Management",
"uri":"en-us_topic_0059304222.html",
"doc_type":"api",
"p_code":"2",
"code":"7"
},
{
"desc":"This API is used to create a backup policy to back up servers periodically.URI formatPOST https://{endpoint}/v1/{project_id}/policiesPOST https://{endpoint}/v1/{project_i",
"product_code":"csbs",
"title":"Creating a Backup Policy",
"uri":"en-us_topic_0059304223.html",
"doc_type":"api",
"p_code":"7",
"code":"8"
},
{
"desc":"This API is used to delete a backup policy by ID.URI formatDELETE https://{endpoint}/v1/{project_id}/policies/{policy_id}DELETE https://{endpoint}/v1/{project_id}/policie",
"product_code":"csbs",
"title":"Deleting a Backup Policy",
"uri":"en-us_topic_0059304224.html",
"doc_type":"api",
"p_code":"7",
"code":"9"
},
{
"desc":"This API is used to update a backup policy by ID.URI formatPUT https://{endpoint}/v1/{project_id}/policies/{policy_id}PUT https://{endpoint}/v1/{project_id}/policies/{pol",
"product_code":"csbs",
"title":"Updating a Backup Policy",
"uri":"en-us_topic_0059304225.html",
"doc_type":"api",
"p_code":"7",
"code":"10"
},
{
"desc":"This API is used to query a backup policy by ID.URI formatGET https://{endpoint}/v1/{project_id}/policies/{policy_id}GET https://{endpoint}/v1/{project_id}/policies/{poli",
"product_code":"csbs",
"title":"Querying a Backup Policy",
"uri":"en-us_topic_0059304226.html",
"doc_type":"api",
"p_code":"7",
"code":"11"
},
{
"desc":"This API is used to query the backup policy list. Filtering parameters are supported.URI formatGET https://{endpoint}/v1/{project_id}/policiesGET https://{endpoint}/v1/{p",
"product_code":"csbs",
"title":"Querying the Backup Policy List",
"uri":"en-us_topic_0059304227.html",
"doc_type":"api",
"p_code":"7",
"code":"12"
},
{
"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":"csbs",
"title":"Backup Management",
"uri":"en-us_topic_0059304229.html",
"doc_type":"api",
"p_code":"2",
"code":"13"
},
{
"desc":"This API is used to manually execute a backup policy and create a backup task.URI formatPOST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpointsPOST ht",
"product_code":"csbs",
"title":"Executing a Backup Policy",
"uri":"en-us_topic_0059304230.html",
"doc_type":"api",
"p_code":"13",
"code":"14"
},
{
"desc":"This API is used to query the number of backups. Filtering parameters are supported.URI formatGET https://{endpoint}/v1/{project_id}/checkpoint_items/countGET https://{en",
"product_code":"csbs",
"title":"Querying the Number of Backups",
"uri":"en-us_topic_0059304233.html",
"doc_type":"api",
"p_code":"13",
"code":"15"
},
{
"desc":"This API is used to query a single backup by ID.URI formatGET https://{endpoint}/v1/{project_id}/checkpoint_items/{checkpoint_item_id}GET https://{endpoint}/v1/{project_i",
"product_code":"csbs",
"title":"Querying a Single Backup",
"uri":"en-us_topic_0059304234.html",
"doc_type":"api",
"p_code":"13",
"code":"16"
},
{
"desc":"This API is used to query all backups. Filtering parameters are supported.URI formatGET https://{endpoint}/v1/{project_id}/checkpoint_itemsGET https://{endpoint}/v1/{proj",
"product_code":"csbs",
"title":"Querying All Backups",
"uri":"en-us_topic_0059304235.html",
"doc_type":"api",
"p_code":"13",
"code":"17"
},
{
"desc":"This API is used to delete a backup.The deletion operation is asynchronous. Tasks will be queued depending on the background task execution status. Therefore, the deletio",
"product_code":"csbs",
"title":"Deleting a Backup",
"uri":"en-us_topic_0059304232.html",
"doc_type":"api",
"p_code":"13",
"code":"18"
},
{
"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":"csbs",
"title":"Restoration Management",
"uri":"en-us_topic_0059304236.html",
"doc_type":"api",
"p_code":"2",
"code":"19"
},
{
"desc":"This API is used to perform backup-based restoration.URI formatPOST https://{endpoint}/v1/{project_id}/restoresPOST https://{endpoint}/v1/{project_id}/restoresParameter d",
"product_code":"csbs",
"title":"Creating a Restoration Task",
"uri":"en-us_topic_0059304237.html",
"doc_type":"api",
"p_code":"19",
"code":"20"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"csbs",
"title":"Quota Management",
"uri":"en-us_topic_0059304238.html",
"doc_type":"api",
"p_code":"2",
"code":"21"
},
{
"desc":"This API is used to query tenant quotas.URI formatGET https://{endpoint}/v1/{project_id}/quotasGET https://{endpoint}/v1/{project_id}/quotasParameter descriptionParameter",
"product_code":"csbs",
"title":"Querying Quotas",
"uri":"en-us_topic_0059304243.html",
"doc_type":"api",
"p_code":"21",
"code":"22"
},
{
"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":"csbs",
"title":"Tag Management",
"uri":"en-us_topic_0098466174.html",
"doc_type":"api",
"p_code":"2",
"code":"23"
},
{
"desc":"This API is used to filter resources by tag.Tag Management Service (TMS) uses this API to filter and list resources of each service by tag. These services must have the q",
"product_code":"csbs",
"title":"Querying Backup Resources by Tag",
"uri":"en-us_topic_0098635086.html",
"doc_type":"api",
"p_code":"23",
"code":"24"
},
{
"desc":"This API is used to add or remove tags of a specific resource in batches.TMS may use this API to manage service resource tags.A resource can have up to 10 tags.The API is",
"product_code":"csbs",
"title":"Batch Adding or Removing Tags of a Backup Resource",
"uri":"en-us_topic_0098635087.html",
"doc_type":"api",
"p_code":"23",
"code":"25"
},
{
"desc":"A resource can have up to 10 tags.The API is idempotent.If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one",
"product_code":"csbs",
"title":"Adding a Tag to a Backup Resource",
"uri":"en-us_topic_0098635088.html",
"doc_type":"api",
"p_code":"23",
"code":"26"
},
{
"desc":"The API is idempotent.When you delete a nonexistent tag, error code 404 will be returned. Tag keys cannot be empty or be empty character strings.URI formatDELETE https://",
"product_code":"csbs",
"title":"Removing a Tag from a Backup Resource",
"uri":"en-us_topic_0098635089.html",
"doc_type":"api",
"p_code":"23",
"code":"27"
},
{
"desc":"This API is used to query tags of a specific resource.TMS uses this API to query all tags of a specific resource.URI formatGET https://{endpoint}/v1/{project_id}/csbs_bac",
"product_code":"csbs",
"title":"Querying Tags of a Backup Resource",
"uri":"en-us_topic_0098635090.html",
"doc_type":"api",
"p_code":"23",
"code":"28"
},
{
"desc":"This API is used to query a tenant's tag set in a specific region and of a specific resource type.TMS uses this API to list tags created by a tenant to facilitate tag cre",
"product_code":"csbs",
"title":"Querying Backup Tags of a Project",
"uri":"en-us_topic_0098635091.html",
"doc_type":"api",
"p_code":"23",
"code":"29"
},
{
"desc":"This API is used to filter backup policies by tag.TMS uses this API to filter and list resources of each service by tag. These services must have the query capabilities.U",
"product_code":"csbs",
"title":"Querying Backup Policies by Tag",
"uri":"en-us_topic_0098635092.html",
"doc_type":"api",
"p_code":"23",
"code":"30"
},
{
"desc":"This API is used to add or remove tags of a specific resource in batches.TMS may use this API to manage service resource tags.A resource can have up to 10 tags.The API is",
"product_code":"csbs",
"title":"Batch Adding or Removing Tags of a Backup Policy",
"uri":"en-us_topic_0098635093.html",
"doc_type":"api",
"p_code":"23",
"code":"31"
},
{
"desc":"A resource can have up to 10 tags.The API is idempotent.If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one",
"product_code":"csbs",
"title":"Adding a Tag to a Backup Policy",
"uri":"en-us_topic_0098635094.html",
"doc_type":"api",
"p_code":"23",
"code":"32"
},
{
"desc":"The API is idempotent.When you delete a nonexistent tag, error code 404 will be returned. Tag keys cannot be empty or be empty character strings.URI formatDELETE https://",
"product_code":"csbs",
"title":"Removing a Tag from a Backup Policy",
"uri":"en-us_topic_0098635095.html",
"doc_type":"api",
"p_code":"23",
"code":"33"
},
{
"desc":"This API is used to query tags of a specific resource.TMS uses this API to query all tags of a specific resource.URI formatGET https://{endpoint}/v1/{project_id}/csbs_bac",
"product_code":"csbs",
"title":"Querying Tags of a Backup Policy",
"uri":"en-us_topic_0098635096.html",
"doc_type":"api",
"p_code":"23",
"code":"34"
},
{
"desc":"This API is used to query a tenant's tag set in a specific region and of a specific resource type.TMS uses this API to list tags created by a tenant to facilitate tag cre",
"product_code":"csbs",
"title":"Querying Backup Policy Tags of a Project",
"uri":"en-us_topic_0098635097.html",
"doc_type":"api",
"p_code":"23",
"code":"35"
},
{
"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":"csbs",
"title":"Appendixes",
"uri":"en-us_topic_0071888296.html",
"doc_type":"api",
"p_code":"",
"code":"36"
},
{
"desc":"NormalStatus CodeDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.202",
"product_code":"csbs",
"title":"Status Codes",
"uri":"en-us_topic_0134484533.html",
"doc_type":"api",
"p_code":"36",
"code":"37"
},
{
"desc":"An example response error is returned as follows:Table 1 describes the error codes.Karbor native APIs:http://developer.openstack.org/api-ref/data-protection-orchestration",
"product_code":"csbs",
"title":"Error Codes",
"uri":"en-us_topic_0071888297.html",
"doc_type":"api",
"p_code":"36",
"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":"csbs",
"title":"Change History",
"uri":"en-us_topic_0071888298.html",
"doc_type":"api",
"p_code":"",
"code":"39"
}
]