From 8ce662c4dcf85d3f4b9defa7e0fc091f3804871f Mon Sep 17 00:00:00 2001 From: "Wei, Hongmin" Date: Mon, 24 Oct 2022 21:06:50 +0000 Subject: [PATCH] CSBS API initial version Reviewed-by: gtema Co-authored-by: Wei, Hongmin Co-committed-by: Wei, Hongmin --- docs/csbs/api-ref/ALL_META.TXT.json | 392 +++++++ docs/csbs/api-ref/CLASS.TXT.json | 353 ++++++ docs/csbs/api-ref/PARAMETERS.txt | 3 + docs/csbs/api-ref/en-us_topic_0059304034.html | 21 + docs/csbs/api-ref/en-us_topic_0059304218.html | 19 + docs/csbs/api-ref/en-us_topic_0059304219.html | 447 +++++++ docs/csbs/api-ref/en-us_topic_0059304220.html | 251 ++++ docs/csbs/api-ref/en-us_topic_0059304221.html | 331 ++++++ docs/csbs/api-ref/en-us_topic_0059304222.html | 23 + docs/csbs/api-ref/en-us_topic_0059304223.html | 1044 +++++++++++++++++ docs/csbs/api-ref/en-us_topic_0059304224.html | 116 ++ docs/csbs/api-ref/en-us_topic_0059304225.html | 879 ++++++++++++++ docs/csbs/api-ref/en-us_topic_0059304226.html | 553 +++++++++ docs/csbs/api-ref/en-us_topic_0059304227.html | 616 ++++++++++ docs/csbs/api-ref/en-us_topic_0059304229.html | 23 + docs/csbs/api-ref/en-us_topic_0059304230.html | 381 ++++++ docs/csbs/api-ref/en-us_topic_0059304232.html | 155 +++ docs/csbs/api-ref/en-us_topic_0059304233.html | 261 +++++ docs/csbs/api-ref/en-us_topic_0059304234.html | 731 ++++++++++++ docs/csbs/api-ref/en-us_topic_0059304235.html | 887 ++++++++++++++ docs/csbs/api-ref/en-us_topic_0059304236.html | 15 + docs/csbs/api-ref/en-us_topic_0059304237.html | 499 ++++++++ docs/csbs/api-ref/en-us_topic_0059304238.html | 15 + docs/csbs/api-ref/en-us_topic_0059304243.html | 199 ++++ docs/csbs/api-ref/en-us_topic_0061309751.html | 8 + docs/csbs/api-ref/en-us_topic_0071888296.html | 13 + docs/csbs/api-ref/en-us_topic_0071888297.html | 606 ++++++++++ docs/csbs/api-ref/en-us_topic_0071888298.html | 127 ++ docs/csbs/api-ref/en-us_topic_0098466174.html | 37 + docs/csbs/api-ref/en-us_topic_0098635086.html | 1021 ++++++++++++++++ docs/csbs/api-ref/en-us_topic_0098635087.html | 262 +++++ docs/csbs/api-ref/en-us_topic_0098635088.html | 210 ++++ docs/csbs/api-ref/en-us_topic_0098635089.html | 152 +++ docs/csbs/api-ref/en-us_topic_0098635090.html | 206 ++++ docs/csbs/api-ref/en-us_topic_0098635091.html | 203 ++++ docs/csbs/api-ref/en-us_topic_0098635092.html | 523 +++++++++ docs/csbs/api-ref/en-us_topic_0098635093.html | 260 ++++ docs/csbs/api-ref/en-us_topic_0098635094.html | 211 ++++ docs/csbs/api-ref/en-us_topic_0098635095.html | 153 +++ docs/csbs/api-ref/en-us_topic_0098635096.html | 206 ++++ docs/csbs/api-ref/en-us_topic_0098635097.html | 203 ++++ docs/csbs/api-ref/en-us_topic_0134484533.html | 121 ++ .../public_sys-resources/ExpandCollapse.js | 1 + .../public_sys-resources/avgCompile.js | 1 + .../caution_3.0-en-us.png | Bin 0 -> 2752 bytes .../public_sys-resources/commonltr.css | 1 + .../public_sys-resources/commonltr_print.css | 1 + .../public_sys-resources/commonrtl.css | 2 + .../public_sys-resources/danger_3.0-en-us.png | Bin 0 -> 2771 bytes .../api-ref/public_sys-resources/delta.gif | Bin 0 -> 836 bytes .../api-ref/public_sys-resources/deltaend.gif | Bin 0 -> 834 bytes .../public_sys-resources/icon-arrowdn.gif | Bin 0 -> 68 bytes .../public_sys-resources/icon-arrowrt.gif | Bin 0 -> 70 bytes .../public_sys-resources/icon-caution.gif | Bin 0 -> 1086 bytes .../public_sys-resources/icon-danger.gif | Bin 0 -> 1086 bytes .../public_sys-resources/icon-huawei.gif | Bin 0 -> 2767 bytes .../public_sys-resources/icon-note.gif | Bin 0 -> 983 bytes .../public_sys-resources/icon-notice.gif | Bin 0 -> 962 bytes .../api-ref/public_sys-resources/icon-tip.gif | Bin 0 -> 879 bytes .../public_sys-resources/icon-warning.gif | Bin 0 -> 1086 bytes .../public_sys-resources/note_3.0-en-us.png | Bin 0 -> 1080 bytes .../public_sys-resources/notice_3.0-en-us.png | Bin 0 -> 1672 bytes .../api-ref/public_sys-resources/popup.js | 1 + .../warning_3.0-en-us.png | Bin 0 -> 3164 bytes 64 files changed, 12743 insertions(+) create mode 100644 docs/csbs/api-ref/ALL_META.TXT.json create mode 100644 docs/csbs/api-ref/CLASS.TXT.json create mode 100644 docs/csbs/api-ref/PARAMETERS.txt create mode 100644 docs/csbs/api-ref/en-us_topic_0059304034.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304218.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304219.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304220.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304221.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304222.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304223.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304224.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304225.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304226.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304227.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304229.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304230.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304232.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304233.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304234.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304235.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304236.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304237.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304238.html create mode 100644 docs/csbs/api-ref/en-us_topic_0059304243.html create mode 100644 docs/csbs/api-ref/en-us_topic_0061309751.html create mode 100644 docs/csbs/api-ref/en-us_topic_0071888296.html create mode 100644 docs/csbs/api-ref/en-us_topic_0071888297.html create mode 100644 docs/csbs/api-ref/en-us_topic_0071888298.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098466174.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635086.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635087.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635088.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635089.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635090.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635091.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635092.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635093.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635094.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635095.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635096.html create mode 100644 docs/csbs/api-ref/en-us_topic_0098635097.html create mode 100644 docs/csbs/api-ref/en-us_topic_0134484533.html create mode 100644 docs/csbs/api-ref/public_sys-resources/ExpandCollapse.js create mode 100644 docs/csbs/api-ref/public_sys-resources/avgCompile.js create mode 100644 docs/csbs/api-ref/public_sys-resources/caution_3.0-en-us.png create mode 100644 docs/csbs/api-ref/public_sys-resources/commonltr.css create mode 100644 docs/csbs/api-ref/public_sys-resources/commonltr_print.css create mode 100644 docs/csbs/api-ref/public_sys-resources/commonrtl.css create mode 100644 docs/csbs/api-ref/public_sys-resources/danger_3.0-en-us.png create mode 100644 docs/csbs/api-ref/public_sys-resources/delta.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/deltaend.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/icon-arrowdn.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/icon-arrowrt.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/icon-caution.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/icon-danger.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/icon-huawei.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/icon-note.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/icon-notice.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/icon-tip.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/icon-warning.gif create mode 100644 docs/csbs/api-ref/public_sys-resources/note_3.0-en-us.png create mode 100644 docs/csbs/api-ref/public_sys-resources/notice_3.0-en-us.png create mode 100644 docs/csbs/api-ref/public_sys-resources/popup.js create mode 100644 docs/csbs/api-ref/public_sys-resources/warning_3.0-en-us.png diff --git a/docs/csbs/api-ref/ALL_META.TXT.json b/docs/csbs/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..ea56fc8f4 --- /dev/null +++ b/docs/csbs/api-ref/ALL_META.TXT.json @@ -0,0 +1,392 @@ +[ + { + "uri":"en-us_topic_0061309751.html", + "product_code":"csbs", + "code":"1", + "des":"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 ", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304034.html", + "product_code":"csbs", + "code":"2", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API Description", + "title":"API Description", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304218.html", + "product_code":"csbs", + "code":"3", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource Management", + "title":"Resource Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304219.html", + "product_code":"csbs", + "code":"4", + "des":"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 ", + "doc_type":"api", + "kw":"Creating a Backup for a Resource,Resource Management,API Reference", + "title":"Creating a Backup for a Resource", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304220.html", + "product_code":"csbs", + "code":"5", + "des":"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", + "doc_type":"api", + "kw":"Querying the Backup Capability of a Resource,Resource Management,API Reference", + "title":"Querying the Backup Capability of a Resource", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304221.html", + "product_code":"csbs", + "code":"6", + "des":"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:/", + "doc_type":"api", + "kw":"Querying the Restoration Capability of a Resource,Resource Management,API Reference", + "title":"Querying the Restoration Capability of a Resource", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304222.html", + "product_code":"csbs", + "code":"7", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Backup Policy Management", + "title":"Backup Policy Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304223.html", + "product_code":"csbs", + "code":"8", + "des":"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", + "doc_type":"api", + "kw":"Creating a Backup Policy,Backup Policy Management,API Reference", + "title":"Creating a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304224.html", + "product_code":"csbs", + "code":"9", + "des":"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", + "doc_type":"api", + "kw":"Deleting a Backup Policy,Backup Policy Management,API Reference", + "title":"Deleting a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304225.html", + "product_code":"csbs", + "code":"10", + "des":"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", + "doc_type":"api", + "kw":"Updating a Backup Policy,Backup Policy Management,API Reference", + "title":"Updating a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304226.html", + "product_code":"csbs", + "code":"11", + "des":"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", + "doc_type":"api", + "kw":"Querying a Backup Policy,Backup Policy Management,API Reference", + "title":"Querying a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304227.html", + "product_code":"csbs", + "code":"12", + "des":"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", + "doc_type":"api", + "kw":"Querying the Backup Policy List,Backup Policy Management,API Reference", + "title":"Querying the Backup Policy List", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304229.html", + "product_code":"csbs", + "code":"13", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Backup Management", + "title":"Backup Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304230.html", + "product_code":"csbs", + "code":"14", + "des":"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", + "doc_type":"api", + "kw":"Executing a Backup Policy,Backup Management,API Reference", + "title":"Executing a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304233.html", + "product_code":"csbs", + "code":"15", + "des":"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", + "doc_type":"api", + "kw":"Querying the Number of Backups,Backup Management,API Reference", + "title":"Querying the Number of Backups", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304234.html", + "product_code":"csbs", + "code":"16", + "des":"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", + "doc_type":"api", + "kw":"Querying a Single Backup,Backup Management,API Reference", + "title":"Querying a Single Backup", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304235.html", + "product_code":"csbs", + "code":"17", + "des":"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", + "doc_type":"api", + "kw":"Querying All Backups,Backup Management,API Reference", + "title":"Querying All Backups", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304232.html", + "product_code":"csbs", + "code":"18", + "des":"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", + "doc_type":"api", + "kw":"Deleting a Backup,Backup Management,API Reference", + "title":"Deleting a Backup", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304236.html", + "product_code":"csbs", + "code":"19", + "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":"Restoration Management", + "title":"Restoration Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304237.html", + "product_code":"csbs", + "code":"20", + "des":"This API is used to perform backup-based restoration.URI formatPOST https://{endpoint}/v1/{project_id}/restoresPOST https://{endpoint}/v1/{project_id}/restoresParameter d", + "doc_type":"api", + "kw":"Creating a Restoration Task,Restoration Management,API Reference", + "title":"Creating a Restoration Task", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304238.html", + "product_code":"csbs", + "code":"21", + "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":"Quota Management", + "title":"Quota Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0059304243.html", + "product_code":"csbs", + "code":"22", + "des":"This API is used to query tenant quotas.URI formatGET https://{endpoint}/v1/{project_id}/quotasGET https://{endpoint}/v1/{project_id}/quotasParameter descriptionParameter", + "doc_type":"api", + "kw":"Querying Quotas,Quota Management,API Reference", + "title":"Querying Quotas", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098466174.html", + "product_code":"csbs", + "code":"23", + "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":"Tag Management", + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635086.html", + "product_code":"csbs", + "code":"24", + "des":"This API is used to filter resources by tag.Tag Management Service (TMS) uses this API to filter and list resources of each service by tag. These services must have the q", + "doc_type":"api", + "kw":"Querying Backup Resources by Tag,Tag Management,API Reference", + "title":"Querying Backup Resources by Tag", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635087.html", + "product_code":"csbs", + "code":"25", + "des":"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", + "doc_type":"api", + "kw":"Batch Adding or Removing Tags of a Backup Resource,Tag Management,API Reference", + "title":"Batch Adding or Removing Tags of a Backup Resource", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635088.html", + "product_code":"csbs", + "code":"26", + "des":"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", + "doc_type":"api", + "kw":"Adding a Tag to a Backup Resource,Tag Management,API Reference", + "title":"Adding a Tag to a Backup Resource", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635089.html", + "product_code":"csbs", + "code":"27", + "des":"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://", + "doc_type":"api", + "kw":"Removing a Tag from a Backup Resource,Tag Management,API Reference", + "title":"Removing a Tag from a Backup Resource", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635090.html", + "product_code":"csbs", + "code":"28", + "des":"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", + "doc_type":"api", + "kw":"Querying Tags of a Backup Resource,Tag Management,API Reference", + "title":"Querying Tags of a Backup Resource", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635091.html", + "product_code":"csbs", + "code":"29", + "des":"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", + "doc_type":"api", + "kw":"Querying Backup Tags of a Project,Tag Management,API Reference", + "title":"Querying Backup Tags of a Project", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635092.html", + "product_code":"csbs", + "code":"30", + "des":"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", + "doc_type":"api", + "kw":"Querying Backup Policies by Tag,Tag Management,API Reference", + "title":"Querying Backup Policies by Tag", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635093.html", + "product_code":"csbs", + "code":"31", + "des":"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", + "doc_type":"api", + "kw":"Batch Adding or Removing Tags of a Backup Policy,Tag Management,API Reference", + "title":"Batch Adding or Removing Tags of a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635094.html", + "product_code":"csbs", + "code":"32", + "des":"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", + "doc_type":"api", + "kw":"Adding a Tag to a Backup Policy,Tag Management,API Reference", + "title":"Adding a Tag to a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635095.html", + "product_code":"csbs", + "code":"33", + "des":"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://", + "doc_type":"api", + "kw":"Removing a Tag from a Backup Policy,Tag Management,API Reference", + "title":"Removing a Tag from a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635096.html", + "product_code":"csbs", + "code":"34", + "des":"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", + "doc_type":"api", + "kw":"Querying Tags of a Backup Policy,Tag Management,API Reference", + "title":"Querying Tags of a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098635097.html", + "product_code":"csbs", + "code":"35", + "des":"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", + "doc_type":"api", + "kw":"Querying Backup Policy Tags of a Project,Tag Management,API Reference", + "title":"Querying Backup Policy Tags of a Project", + "githuburl":"" + }, + { + "uri":"en-us_topic_0071888296.html", + "product_code":"csbs", + "code":"36", + "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":"Appendixes", + "title":"Appendixes", + "githuburl":"" + }, + { + "uri":"en-us_topic_0134484533.html", + "product_code":"csbs", + "code":"37", + "des":"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", + "doc_type":"api", + "kw":"Status Codes,Appendixes,API Reference", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"en-us_topic_0071888297.html", + "product_code":"csbs", + "code":"38", + "des":"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", + "doc_type":"api", + "kw":"Error Codes,Appendixes,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"en-us_topic_0071888298.html", + "product_code":"csbs", + "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", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/csbs/api-ref/CLASS.TXT.json b/docs/csbs/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..340b38613 --- /dev/null +++ b/docs/csbs/api-ref/CLASS.TXT.json @@ -0,0 +1,353 @@ +[ + { + "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" + } +] \ No newline at end of file diff --git a/docs/csbs/api-ref/PARAMETERS.txt b/docs/csbs/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/csbs/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/csbs/api-ref/en-us_topic_0059304034.html b/docs/csbs/api-ref/en-us_topic_0059304034.html new file mode 100644 index 000000000..4785df950 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304034.html @@ -0,0 +1,21 @@ + + +

API Description

+
+
+ +
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304218.html b/docs/csbs/api-ref/en-us_topic_0059304218.html new file mode 100644 index 000000000..d51895c26 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304218.html @@ -0,0 +1,19 @@ + + +

Resource Management

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304219.html b/docs/csbs/api-ref/en-us_topic_0059304219.html new file mode 100644 index 000000000..9f0d51932 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304219.html @@ -0,0 +1,447 @@ + + +

Creating a Backup for a Resource

+

Function

This API is used to create a backup for a specified resource.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/{resource_id}/action

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    provider_id

    +

    Yes

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    resource_id

    +

    Yes

    +

    String

    +

    ID of a backup server. For details about how to obtain the server ID, see the Elastic Cloud Server API Reference.

    +
    +
    +

    Backup provider IDs mentioned in this document are all fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    protect

    +

    Yes

    +

    protect_param

    +

    Backup parameters

    +

    For details, see Table 3.

    +
    +
    +
  • Parameter description of field protect_param +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Parameter description of field protect_param

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    backup_name

    +

    No

    +

    String

    +

    Backup name. The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    description

    +

    No

    +

    String

    +

    Backup description. The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    incremental

    +

    No

    +

    Boolean

    +

    Backup type. Value True indicates incremental backup and value False indicates full backup. For the initial backup, full backup is always adopted, in spite of which value is set.

    +

    resource_type

    +

    No

    +

    String

    +

    Entity object type of the backup object

    +

    The current value is OS::Nova::Server indicating that the backup object is an ECS. If this parameter is not passed, the backup object type defaults to OS::Nova::Server.

    +

    tags

    +

    No

    +

    List<resource_tag>

    +

    Tag list

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 keys.

    +

    Keys in this list must be unique.

    +

    extra_info

    +

    No

    +

    Dict

    +

    Additional information about the backup object

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field resource_tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

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

    +

    value

    +

    Yes

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

    Spaces before and after a tag value will be deprecated.

    +

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

    +
    +
    +
+
+
  • Example request
    POST 
+https://{endpoint}/v1/b942cc8342734d15bcb246babb1953cf/providers/fc4d5750-22e7-4798-8a46-f48f62c4c1da/resources/9506416d-db6c-406e-8bca-c0f43793d914/action
+{
+    "protect" : {
+    "backup_name" : "backup",
+    "description" : "backup des",
+    "extra_info" : {
+    }
+    
+  }
+}
    +
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 5 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    checkpoint

    +

    protect_resp

    +

    Backup response

    +

    For details, see Table 6.

    +
    +
    +
  • Parameter description of field protect_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6 Parameter description of field protect_resp

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Backup status

    +

    Value range: waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting, and deleted

    +

    created_at

    +

    String

    +

    Creation time, for example, 2017-04-18T01:21:52.701973

    +

    id

    +

    String

    +

    Backup record ID

    +

    resource_graph

    +

    String

    +

    Resource diagram, which displays the inclusion relationship between backups and sub-backups

    +

    project_id

    +

    String

    +

    Project ID

    +

    protection_plan

    +

    plan_resp

    +

    Backup plan information

    +

    For details, see Table 7.

    +

    extra_info

    +

    String

    +

    Additional information

    +
    +
    +
  • Parameter description of field plan_resp +
    + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field plan_resp

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Backup policy ID

    +

    name

    +

    String

    +

    Backup policy name

    +

    resources

    +

    List<resource>

    +

    Backup object list

    +

    For details, see Table 8.

    +
    +
    +
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 8 Parameter description of field resource

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Backup object ID

    +

    type

    +

    String

    +

    Entity object type of the backup object. The value is fixed at OS::Nova::Server, indicating that the object type is ECS.

    +

    name

    +

    String

    +

    Backup object name

    +

    extra_info

    +

    Dict

    +

    Additional information about the backup object

    +
    +
    +
  • Example response
    {
+  "checkpoint" : {
+    "status" : "protecting",
+    "created_at" : "2017-04-18T01:21:52.701973",
+    "id" : "4468f4b8-7c78-4222-a2ca-346b5d557dd2",
+    "resource_graph" : null,
+    "project_id" : "b942cc8342734d15bcb246babb1953cf",
+    "extra_info" : null,
+    "protection_plan" : {
+      "id" : "fake_04f8ea0f-2000-4389-a5ce-93a3e20d0faf",
+      "resources" : [ {
+        "type" : "OS::Nova::Server",
+        "id" : "9506416d-db6c-406e-8bca-c0f43793d914",
+        "name" : "resource_9506416d-db6c-406e-8bca-c0f43793d914",
+        "extra_info" : {
+    }
+      } ],
+      "name" : "server protect plan for 9506416d-db6c-406e-8bca-c0f43793d914"
+    }
+  }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304220.html b/docs/csbs/api-ref/en-us_topic_0059304220.html new file mode 100644 index 000000000..10ea8d7e2 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304220.html @@ -0,0 +1,251 @@ + + +

Querying the Backup Capability of a Resource

+

Function

This API is used to query whether a resource can be backed up.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/action

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    provider_id

    +

    Yes

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    check_protectable

    +

    Yes

    +

    List<protectable_param>

    +

    Query parameter list

    +

    For details, see Table 3.

    +
    +
    +
  • Parameter description of field protectable_param +
    + + + + + + + + + + + + + + + + +
    Table 3 Parameter description of field protectable_param

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    resource_id

    +

    Yes

    +

    String

    +

    ID of the resource (server or disk) to be checked

    +

    For details about how to obtain the server ID, see the Elastic Cloud Server API Reference. For details about how to obtain the disk ID, see the Elastic Volume Service API Reference.

    +

    resource_type

    +

    Yes

    +

    String

    +

    Type of the resource to be checked, for example, OS::Nova::Server for an ECS

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/action
+{
+  "check_protectable" : [ {
+    "resource_id" : "6507cb66-90dc-4a12-a573-c9f3398f899d",
+    "resource_type" : "OS::Nova::Server"
+  } ]
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 4 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    protectable

    +

    List<check_resp>

    +

    Check result list

    +

    For details, see Table 5.

    +
    +
    +
  • Parameter description of field check_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field check_resp

    Parameter

    +

    Type

    +

    Description

    +

    result

    +

    Boolean

    +

    Whether the resource can be backed up

    +

    true: yes

    +

    false: no

    +

    resource_type

    +

    String

    +

    Resource type

    +

    Possible values are OS::Nova::Server (ECS) and OS::Ironic::BareMetalServer (BMS).

    +

    error_code

    +

    String

    +

    Error code. If an error occurs, a value is returned.

    +

    error_msg

    +

    String

    +

    Error message, which will be returned if the VM is associated with a backup policy. If an error occurs, a value is returned.

    +

    resource_id

    +

    String

    +

    Resource ID

    +
    +
    +
  • Example response
    {
+  "protectable" : [ {
+    "resource_id" : "6507cb66-90dc-4a12-a573-c9f3398f899d",
+    "resource_type" : "OS::Nova::Server",
+    "result" : true
+  } ]
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304221.html b/docs/csbs/api-ref/en-us_topic_0059304221.html new file mode 100644 index 000000000..0f82d3608 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304221.html @@ -0,0 +1,331 @@ + + +

Querying the Restoration Capability of a Resource

+

Function

This API is used to check whether a target resource can be restored.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/action

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    provider_id

    +

    Yes

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    check_restorable

    +

    Yes

    +

    List<restorable_param>

    +

    Query parameter list

    +

    For details, see Table 3.

    +
    +
    +
  • Parameter description of field restorable_param +
    + + + + + + + + + + + + + + + + +
    Table 3 Parameter description of field restorable_param

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    checkpoint_item_id

    +

    Yes

    +

    String

    +

    ID of the backup used to restore data

    +

    target

    +

    Yes

    +

    restorable_target

    +

    Restoration target

    +

    For details, see Table 4.

    +
    +
    +
  • Parameter description of field restorable_target +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field restorable_target

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    resource_id

    +

    Yes

    +

    String

    +

    ID of the resource to which the backup is restored

    +

    resource_type

    +

    Yes

    +

    String

    +

    Type of the target to which the backup is restored, for example, OS::Nova::Server for an ECS

    +

    volumes

    +

    Yes

    +

    List<restore_volume_mapping>

    +

    Disk mapping list for restoring an ECS. Enter the mapping between disks and backups based on the actual situation.

    +

    For details, see Table 5.

    +
    +
    +
  • Parameter description of field restore_volume_mapping +
    + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field restore_volume_mapping

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    backup_id

    +

    Yes

    +

    String

    +

    Disk backup ID. Use the API in Querying a Single Backup to obtain the disk backup ID.

    +

    volume_id

    +

    Yes

    +

    String

    +

    ID of the destination disk for the restoration

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/action
+{
+  "check_restorable" : [ {
+    "checkpoint_item_id" : "8986ce68-3da7-4d29-9cc2-1921e9504975",
+    "target" : {
+      "resource_type" : "OS::Nova::Server",
+      "resource_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
+      "volumes" : [ {
+        "backup_id" : "7ea119a8-d25b-43a7-8d1b-88e12788513a",
+        "volume_id" : "45baf976-c20a-4894-a7c3-c94b7376bf55"
+      } ]
+    }
+  } ]
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 6 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    restorable

    +

    List<check_resp>

    +

    Response parameter list

    +

    For details, see Table 7.

    +
    +
    +
  • Parameter description of field check_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field check_resp

    Parameter

    +

    Type

    +

    Description

    +

    result

    +

    Boolean

    +

    Whether the resource can be restored

    +

    resource_type

    +

    String

    +

    Resource type

    +

    error_code

    +

    String

    +

    Error code

    +

    error_msg

    +

    String

    +

    Error reason

    +

    resource_id

    +

    String

    +

    Resource ID

    +
    +
    +
  • Example response
    {
+  "restorable" : [ {
+    "resource_id" : "6507cb66-90dc-4a12-a573-c9f3398f899d",
+    "resource_type" : "OS::Nova::Server",
+    "result" : true,
+    "error_msg" : "",
+    "error_code" : ""
+  } ]
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304222.html b/docs/csbs/api-ref/en-us_topic_0059304222.html new file mode 100644 index 000000000..e5fced62c --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304222.html @@ -0,0 +1,23 @@ + + +

Backup Policy Management

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304223.html b/docs/csbs/api-ref/en-us_topic_0059304223.html new file mode 100644 index 000000000..c3b0e887f --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304223.html @@ -0,0 +1,1044 @@ + + +

Creating a Backup Policy

+

Function

This API is used to create a backup policy to back up servers periodically.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/policies

    +
  • Parameter description +
    + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    policy

    +

    Yes

    +

    policy_create

    +

    Creation parameters

    +

    For details, see Table 3.

    +
    +
    +
  • Parameter description of field policy_create +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Parameter description of field policy_create

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    description

    +

    No

    +

    String

    +

    Backup policy description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    name

    +

    Yes

    +

    String

    +

    Backup policy name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    parameters

    +

    Yes

    +

    policy_param

    +

    Backup parameters

    +

    For details, see Table 4.

    +

    provider_id

    +

    Yes

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    resources

    +

    Yes

    +

    List<resource>

    +

    Backup object list. The list can be blank.

    +

    For details, see Table 5.

    +

    scheduled_operations

    +

    Yes

    +

    List<scheduled_operation_create>

    +

    Scheduling period

    +

    For details, see Table 6.

    +

    tags

    +

    No

    +

    List<resource_tag>

    +

    Tag list

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 keys.

    +

    Keys in this list must be unique.

    +
    +
    +
  • Parameter description of field policy_param +
    + + + + + + + + + + + +
    Table 4 Parameter description of field policy_param

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    common

    +

    No

    +

    common_param

    +

    General backup policy parameters, which are blank by default

    +
    +
    +
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field resource

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    id

    +

    Yes

    +

    String

    +

    Backup object ID

    +

    type

    +

    Yes

    +

    String

    +

    Entity object type of backup objects

    +

    The value is fixed at OS::Nova::Server (ECSs).

    +

    name

    +

    Yes

    +

    String

    +

    Backup object name

    +

    extra_info

    +

    No

    +

    Dict

    +

    Additional information about the backup object

    +
    +
    +
  • Parameter description of field scheduled_operation_create +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6 Parameter description of field scheduled_operation_create

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    description

    +

    No

    +

    String

    +

    Scheduling period description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    enabled

    +

    Yes

    +

    Boolean

    +

    Whether the backup policy is enabled

    +

    If it is set to true, automatic scheduling is enabled. If it is set to false, automatic scheduling is disabled but you can execute the policy manually.

    +

    name

    +

    No

    +

    String

    +

    Scheduling period name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    operation_type

    +

    Yes

    +

    String

    +

    Operation type

    +

    Enumeration values: backup

    +

    operation_definition

    +

    Yes

    +

    operation_definition

    +

    Scheduling period parameters

    +

    For details, see Table 7.

    +

    trigger

    +

    Yes

    +

    trigger

    +

    Scheduling policy

    +
    +
    +
  • Parameter description of field operation_definition +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field operation_definition

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    max_backups

    +

    No

    +

    Integer

    +

    Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit.

    +

    retention_duration_days

    +

    No

    +

    Integer

    +

    Duration of retaining a backup, in days. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by retention duration.

    +

    permanent

    +

    No

    +

    Boolean

    +

    Whether backups are permanently retained. false: no. true: yes

    +

    plan_id

    +

    No

    +

    String

    +

    Backup policy ID

    +

    provider_id

    +

    No

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    day_backups

    +

    No

    +

    Integer

    +

    Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. If this parameter is configured, timezone is mandatory.

    +

    week_backups

    +

    No

    +

    Integer

    +

    Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. If this parameter is configured, timezone is mandatory.

    +

    month_backups

    +

    No

    +

    Integer

    +

    Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. If this parameter is configured, timezone is mandatory.

    +

    year_backups

    +

    No

    +

    Integer

    +

    Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. If this parameter is configured, timezone is mandatory.

    +

    timezone

    +

    No

    +

    String

    +

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

    +
    +
    +
    • If permanent is set to true, backups will be retained permanently, despite the settings of max_backups and retention_duration_days.
    • If permanent is set to false, settings of max_backups and retention_duration_days are effective.
    • If none of permanent, max_backups, and retention_duration_days is set, backups will be retained permanently.
    +
    +
  • Parameter description of field trigger +
    + + + + + + + + + + + +
    Table 8 Parameter description of field trigger

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    properties

    +

    Yes

    +

    trigger_properties

    +

    Scheduler properties

    +

    For details, see Table 9.

    +
    +
    +
  • Parameter description of field trigger_properties +
    + + + + + + + + + + + +
    Table 9 Parameter description of field trigger_properties

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    pattern

    +

    Yes

    +

    String

    +

    Scheduling policy of the scheduler. The value consists of a maximum of 10,240 characters. The scheduling policy complies with iCalendar RFC 2445, but it supports only four parameters, which are FREQ, BYDAY, BYHOUR, and BYMINUTE. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, or 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.

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + + + + +
    Table 10 Parameter description of field resource_tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

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

    +

    value

    +

    Yes

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

    Spaces before and after a tag value will be deprecated.

    +

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

    +
    +
    +
+
+
  • Example request
    POST https://{endpoint}/v1/{project_id}/policies
+{
+  "policy" : {
+    "name" : "my-plan",
+    "description" : "My plan",
+    "provider_id" : "fc4d5750-22e7-4798-8a46-f48f62c4c1da",
+    "parameters" : {
+      "common" : {
+      }
+    },
+    "scheduled_operations" : [ {
+      "name" : "my-backup-policy",
+      "description" : "My backup policy",
+      "enabled" : true,
+      "operation_definition" : {
+        "max_backups" : 20
+      },
+      "trigger" : {
+        "properties" : {
+          "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
+        }
+      },
+      "operation_type" : "backup"
+    }
+     
+    ],
+    "resources" : [ {
+      "id" : "45baf976-c20a-4894-a7c3-c94b7376bf55",
+      "type" : "OS::Nova::Server",
+      "name" : "resource1",
+    }, {
+      "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
+      "type" : "OS::Nova::Server",
+      "name" : "resource2"
+    } ]
+  }
+}
    +
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 11 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    policy

    +

    policy_resp

    +

    For details, see Table 12.

    +
    +
    +
  • Parameter description of field policy_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 12 Parameter description of field policy_resp

    Parameter

    +

    Type

    +

    Description

    +

    created_at

    +

    String

    +

    Creation time, for example, 2017-04-18T01:21:52.701973

    +

    description

    +

    String

    +

    Backup policy description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    id

    +

    String

    +

    Backup policy ID

    +

    name

    +

    String

    +

    Backup policy name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    parameters

    +

    policy_param

    +

    Parameters of a backup policy

    +

    For details, see Table 13.

    +

    project_id

    +

    String

    +

    Project ID

    +

    provider_id

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    resources

    +

    List<resource>

    +

    Backup object list

    +

    For details, see Table 14.

    +

    scheduled_operations

    +

    List<scheduled_operation_resp>

    +

    Scheduling period list

    +

    For details, see Table 15.

    +

    status

    +

    String

    +

    Backup policy status

    +

    disabled: indicates that the backup policy is unavailable.

    +

    enabled: indicates that the backup policy is available.

    +

    tags

    +

    List<resource_tag>

    +

    Tag list

    +

    Keys in the tag list must be unique.

    +
    +
    +
  • Parameter description of field policy_param +
    + + + + + + + + + +
    Table 13 Parameter description of field policy_param

    Parameter

    +

    Type

    +

    Description

    +

    common

    +

    common_param

    +

    Common parameters of a backup policy

    +
    +
    +
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 14 Parameter description of field resource

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Backup object ID

    +

    type

    +

    String

    +

    Entity object type of backup objects

    +

    The value is fixed at OS::Nova::Server (ECSs).

    +

    name

    +

    String

    +

    Backup object name

    +

    extra_info

    +

    Dict

    +

    Additional information about the backup object

    +
    +
    +
  • Parameter description of field scheduled_operation_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 15 Parameter description of field scheduled_operation_resp

    Parameter

    +

    Type

    +

    Description

    +

    description

    +

    String

    +

    Scheduling period description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    enabled

    +

    Boolean

    +

    Whether the scheduling period is enabled

    +

    The default value is true. If it is set to false, automatic scheduling is disabled but manual scheduling is supported.

    +

    name

    +

    String

    +

    Scheduling period name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    operation_type

    +

    String

    +

    Operation type

    +

    Enumeration values: backup

    +

    operation_definition

    +

    operation_definition

    +

    Scheduling period parameters

    +

    For details, see Table 16.

    +

    trigger

    +

    trigger_resp

    +

    Scheduling policy

    +

    id

    +

    String

    +

    Scheduling period ID

    +

    trigger_id

    +

    String

    +

    Scheduler ID

    +
    +
    +
  • Parameter description of field operation_definition +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 16 Parameter description of field operation_definition

    Parameter

    +

    Type

    +

    Description

    +

    max_backups

    +

    String

    +

    Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit.

    +

    retention_duration_days

    +

    String

    +

    Duration of retaining a backup, in days. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by retention duration.

    +

    permanent

    +

    String

    +

    Whether backups are permanently retained

    +

    plan_id

    +

    String

    +

    Backup policy ID

    +

    provider_id

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +
    +
    +
    • If permanent is set to true, backups will be retained permanently, despite the settings of max_backups and retention_duration_days.
    • If permanent is set to false, settings of max_backups and retention_duration_days are effective.
    • If none of permanent, max_backups, and retention_duration_days is set, backups will be retained permanently.
    +
    +
  • Parameter description of field trigger_resp +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 17 Parameter description of field trigger_resp

    Parameter

    +

    Type

    +

    Description

    +

    properties

    +

    trigger_properties_resp

    +

    Scheduler properties

    +

    For details, see Parameter description of field trigger_properties_resp.

    +

    id

    +

    String

    +

    Scheduler ID

    +

    name

    +

    String

    +

    Scheduler name

    +

    type

    +

    String

    +

    Scheduling type. The value is fixed at time.

    +
    +
    +
  • Parameter description of field trigger_properties_resp +
    + + + + + + + + + + + + + + + + + +
    Table 18 Parameter description of field trigger_properties_resp

    Parameter

    +

    Type

    +

    Description

    +

    pattern

    +

    String

    +

    Scheduling policy of the scheduler

    +

    The value consists of a maximum of 10,240 characters. The scheduling policy complies with iCalendar RFC 2445, but it supports only four parameters, which are FREQ, BYDAY, BYHOUR, and BYMINUTE. FREQ can be set to WEEKLY and DAILY, BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week), BYHOUR ranges from 0 hours to 23 hours, and BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day.

    +

    start_time

    +

    String

    +

    Scheduler start time, for example, 2017-04-18T01:21:52

    +

    format

    +

    String

    +

    Scheduler type

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + +
    Table 19 Parameter description of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    value

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response
    {
+  "policy" : {
+    "created_at" : "2017-03-07T09:27:40.928000",
+    "description" : "My plan",
+    "id" : "f766c171-9336-479a-8b30-b83cabf6381e",
+    "name" : "my-plan",
+    "parameters" : {
+      "common" : {
+      }
+    },
+    "project_id" : "tenant",
+    "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec",
+    "resources" : [ {
+      "id" : "45baf976-c20a-4894-a7c3-c94b7376bf55",
+      "name" : "resource1",
+      "type" : "OS::Nova::Server",
+      "extra_info" : {
+    }
+    }, {
+      "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
+      "name" : "resource2",
+      "type" : "OS::Nova::Server"
+    } ],
+    "scheduled_operations" : [ {
+      "description" : "My backup policy",
+      "enabled" : true,
+      "id" : "9303a23d-e433-48e7-b88a-5ee6442e434e",
+      "name" : "my-backup-policy",
+      "operation_definition" : {
+        "max_backups" : "20",
+        "plan_id" : "f766c171-9336-479a-8b30-b83cabf6381e",
+        "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec"
+      },
+      "operation_type" : "backup",
+      "trigger" : {
+        "id" : "8178846b-766d-4fe6-941f-b38c76b6f3b9",
+        "name" : "default",
+        "properties" : {
+          "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
+          "start_time" : "2017-03-07 09:27:41",
+          "format" : "ical"
+        },
+        "type" : "time"
+      },
+      "trigger_id" : "8178846b-766d-4fe6-941f-b38c76b6f3b9"
+    }
+,
+   ],
+    "status" : "suspended"
+  }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policy Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304224.html b/docs/csbs/api-ref/en-us_topic_0059304224.html new file mode 100644 index 000000000..6a589e95f --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304224.html @@ -0,0 +1,116 @@ + + +

Deleting a Backup Policy

+

Function

This API is used to delete a backup policy by ID.

+
+

URI

  • URI format

    DELETE https://{endpoint}/v1/{project_id}/policies/{policy_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    String

    +

    Backup policy ID

    +
    +
    +
+
+

Request

  • Parameter description
+

None

+
  • Example request
    DELETE https://{endpoint}/v1/{project_id}/policies/{policy_id}
    +
+
+

Response

  • Parameter description

    None

    +
+
  • Example response

    None

    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policy Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304225.html b/docs/csbs/api-ref/en-us_topic_0059304225.html new file mode 100644 index 000000000..75eed611d --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304225.html @@ -0,0 +1,879 @@ + + +

Updating a Backup Policy

+

Function

This API is used to update a backup policy by ID.

+
+

URI

  • URI format

    PUT https://{endpoint}/v1/{project_id}/policies/{policy_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    String

    +

    Backup policy ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    policy

    +

    Yes

    +

    policy_update

    +

    For details, see Table 3.

    +
    +
    +
  • Parameter description of field policy_update +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Parameter description of field policy_update

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    description

    +

    No

    +

    String

    +

    Backup policy description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    name

    +

    No

    +

    String

    +

    Backup policy name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    resources

    +

    No

    +

    List<resource>

    +

    Backup objects

    +

    For details, see Table 4.

    +

    scheduled_operations

    +

    No

    +

    List<scheduled_operation_update>

    +

    Scheduling period. A backup policy has only one backup period.

    +

    For details, see Table 5.

    +
    +
    +
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field resource

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    id

    +

    Yes

    +

    String

    +

    Backup object ID

    +

    type

    +

    Yes

    +

    String

    +

    Entity object type of backup objects

    +

    The value is fixed at OS::Nova::Server (ECSs).

    +

    name

    +

    Yes

    +

    String

    +

    Backup object name

    +

    extra_info

    +

    No

    +

    Dict

    +

    Additional information about the backup object

    +
    +
    +
  • Parameter description of field scheduled_operation_update +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field scheduled_operation_update

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    description

    +

    No

    +

    String

    +

    Scheduling period description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    enabled

    +

    No

    +

    Boolean

    +

    Whether the backup policy is enabled

    +

    The default value is true. If it is set to false, automatic scheduling is disabled but manual scheduling is supported.

    +

    name

    +

    No

    +

    String

    +

    Scheduling period name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    operation_definition

    +

    No

    +

    operation_definition

    +

    Scheduling period parameter

    +

    For details, see Table 6.

    +

    trigger

    +

    No

    +

    trigger

    +

    Scheduling policy

    +

    id

    +

    Yes

    +

    String

    +

    Scheduling period ID

    +
    +
    +
  • Parameter description of field operation_definition +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6 Parameter description of field operation_definition

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    max_backups

    +

    No

    +

    Integer

    +

    Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit.

    +

    retention_duration_days

    +

    No

    +

    Integer

    +

    Duration of retaining a backup, in days. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by retention duration.

    +

    permanent

    +

    No

    +

    Boolean

    +

    Whether backups are permanently retained

    +

    plan_id

    +

    No

    +

    String

    +

    Backup policy ID

    +

    provider_id

    +

    No

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    day_backups

    +

    No

    +

    Integer

    +

    Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. If this parameter is configured, timezone is mandatory.

    +

    week_backups

    +

    No

    +

    Integer

    +

    Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. If this parameter is configured, timezone is mandatory.

    +

    month_backups

    +

    No

    +

    Integer

    +

    Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. If this parameter is configured, timezone is mandatory.

    +

    year_backups

    +

    No

    +

    Integer

    +

    Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. If this parameter is configured, timezone is mandatory.

    +

    timezone

    +

    No

    +

    String

    +

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

    +
    +
    +
    • If permanent is set to true, backups will be retained permanently, despite the settings of max_backups and retention_duration_days.
    • If permanent is set to false, settings of max_backups and retention_duration_days are effective.
    • If none of permanent, max_backups, and retention_duration_days is set, backups will be retained permanently.
    +
    +
  • Parameter description of field trigger +
    + + + + + + + + + + + +
    Table 7 Parameter description of field trigger

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    properties

    +

    Yes

    +

    trigger_properties

    +

    Scheduler properties

    +

    For details, see Table 8.

    +
    +
    +
  • Parameter description of field trigger_properties +
    + + + + + + + + + + + +
    Table 8 Parameter description of field trigger_properties

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    pattern

    +

    Yes

    +

    String

    +

    Scheduling policy of the scheduler

    +

    The value consists of a maximum of 10,240 characters. The scheduling policy complies with iCalendar RFC 2445, but it supports only four parameters, which are FREQ, BYDAY, BYHOUR, and BYMINUTE. FREQ can be set to WEEKLY and DAILY, BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week), BYHOUR ranges from 0 hours to 23 hours, and BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day.

    +
    +
    +
  • Example request
    PUT https://{endpoint}/v1/{project_id}/policies/{policy_id}
+{
+  "policy" : {
+    "name" : "my-plan",
+    "parameters" : {
+      "common" : {
+      }
+    },
+    "scheduled_operations" : [ {
+      "id" : "fed3c8f1-7b6e-4e24-b1ad-473838bad569",
+      "name" : "my-backup-policy",
+      "description" : "My backup policy ",
+      "enabled" : true,
+      "operation_definition" : {
+        "retention_duration_days" : -1,
+        "max_backups" : 20
+      },
+      "trigger" : {
+        "properties" : {
+          "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
+        }
+     }
+ }
+    ]
+  }
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 9 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    policy

    +

    policy_resp

    +

    For details, see Table 10.

    +
    +
    +
  • Parameter description of field policy_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 10 Parameter description of field policy_resp

    Parameter

    +

    Type

    +

    Description

    +

    created_at

    +

    String

    +

    Creation time, for example, 2017-04-18T01:21:52.701973

    +

    description

    +

    String

    +

    Backup policy description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    id

    +

    String

    +

    Backup policy ID

    +

    name

    +

    String

    +

    Backup policy name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    parameters

    +

    policy_param

    +

    Parameters of a backup policy

    +

    For details, see Table 11.

    +

    project_id

    +

    String

    +

    Project ID

    +

    provider_id

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    resources

    +

    List<resource>

    +

    Backup object list

    +

    For details, see Table 12.

    +

    scheduled_operations

    +

    List<scheduled_operation_resp>

    +

    Scheduling period list

    +

    For details, see Table 13.

    +

    status

    +

    String

    +

    Backup policy status

    +
    • disabled: indicates that the backup policy is unavailable.
    • enabled: indicates that the backup policy is available.
    +
    +
    +
  • Parameter description of field policy_param +
    + + + + + + + + + +
    Table 11 Parameter description of field policy_param

    Parameter

    +

    Type

    +

    Description

    +

    common

    +

    common_param

    +

    General backup policy parameters, which are blank by default

    +
    +
    +
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 12 Parameter description of field resource

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Backup object ID

    +

    type

    +

    String

    +

    Entity object type of backup objects

    +

    The value is fixed at OS::Nova::Server (ECSs).

    +

    name

    +

    String

    +

    Backup object name

    +

    extra_info

    +

    Dict

    +

    Additional information about the backup object

    +
    +
    +
  • Parameter description of field scheduled_operation_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 13 Parameter description of field scheduled_operation_resp

    Parameter

    +

    Type

    +

    Description

    +

    description

    +

    String

    +

    Scheduling period description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    enabled

    +

    Boolean

    +

    Whether the scheduling period is enabled

    +

    The default value is true. If it is set to false, automatic scheduling is disabled but manual scheduling is supported.

    +

    name

    +

    String

    +

    Scheduling period name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    operation_type

    +

    String

    +

    Operation type

    +

    Enum:[ backup]

    +

    operation_definition

    +

    operation_definition

    +

    Scheduling period parameters

    +

    For details, see Table 14.

    +

    trigger

    +

    trigger_resp

    +

    Scheduling policy

    +

    For details, see Table 15.

    +

    id

    +

    String

    +

    Scheduling period ID

    +
    +
    +
  • Parameter description of field operation_definition +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 14 Parameter description of field operation_definition

    Parameter

    +

    Type

    +

    Description

    +

    max_backups

    +

    String

    +

    Maximum number of backups that can be automatically created for a backup object.

    +

    The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit.

    +

    retention_duration_days

    +

    String

    +

    Duration of retaining a backup, in days.

    +

    The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by retention duration.

    +

    permanent

    +

    String

    +

    Whether backups are permanently retained

    +

    plan_id

    +

    String

    +

    Backup policy ID

    +

    provider_id

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +
    +
    +
  • Parameter description of field trigger_resp +
    + + + + + + + + + +
    Table 15 Parameter description of field trigger_resp

    Parameter

    +

    Type

    +

    Description

    +

    properties

    +

    trigger_properties_resp

    +

    Scheduler properties

    +

    For details, see Table 16.

    +
    +
    +
  • Parameter description of field trigger_properties_resp +
    + + + + + + + + + + + + + + + + + +
    Table 16 Parameter description of field trigger_properties_resp

    Parameter

    +

    Type

    +

    Description

    +

    pattern

    +

    String

    +

    Scheduling policy of the scheduler

    +

    The value consists of a maximum of 10,240 characters. The scheduling policy complies with iCalendar RFC 2445, but it supports only four parameters, which are FREQ, BYDAY, BYHOUR, and BYMINUTE. FREQ can be set to WEEKLY and DAILY, BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week), BYHOUR ranges from 0 hours to 23 hours, and BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day.

    +

    start_time

    +

    String

    +

    Start time of the scheduler

    +

    format

    +

    String

    +

    Scheduler type

    +

    The value is fixed at ical (Internet calendar).

    +
    +
    +
  • Example response
    {
+  "policy" : {
+    "status" : "disabled",
+    "provider_id" : "fc4d5750-22e7-4798-8a46-f48f62c4c1da",
+    "description" : "",
+    "parameters" : {
+      "common" : {
+      }
+    },
+    "scheduled_operations" : [ {
+      "description" : "My backup policy ",
+      "enabled" : true,
+      "trigger" : {
+        "properties" : {
+          "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
+          "start_time" : "2017-04-09 14:31:25",
+          "format" : "ical"
+        }
+      },
+      "operation_definition" : {
+        "provider_id" : "fc4d5750-22e7-4798-8a46-f48f62c4c1da",
+        "plan_id" : "17e2b861-3a35-434d-afbb-073d5cd5af08",
+        "max_backups" : "20",
+        "retention_duration_days" : "-1",
+        "permanent" : "False",
+        
+      },
+      "operation_type" : "backup",
+      "id" : "fed3c8f1-7b6e-4e24-b1ad-473838bad569",
+      "name" : "my-backup-policy"
+    }
+,
+          "format" : "ical"
+   ],
+    "id" : "17e2b861-3a35-434d-afbb-073d5cd5af08",
+    "name" : "my-plan",
+    "parameters" : {
+      "common" : {
+      }
+    },
+    "created_at" : "2017-04-09T14:31:25.504569",
+    "project_id" : "0c89d4e457c3401a89c65420fd45f3a2",
+    "resources" : [ {
+      "type" : "OS::Nova::Server",
+      "id" : "8421f405-1334-4206-b71c-b3f64d39abc4",
+      "name" : "wqeq3",
+      "extra_info" : {
+    }
+    } ]
+  }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policy Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304226.html b/docs/csbs/api-ref/en-us_topic_0059304226.html new file mode 100644 index 000000000..17d98aab2 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304226.html @@ -0,0 +1,553 @@ + + +

Querying a Backup Policy

+

Function

This API is used to query a backup policy by ID.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/policies/{policy_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    String

    +

    Backup policy ID

    +
    +
    +
+
+

Request

  • Parameter description
+

None

+
  • Example request
    GET https://{endpoint}/v1/{project_id}/policies/{policy_id}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    policy

    +

    policy_resp

    +

    Query response

    +
    +
    +
  • Parameter description of field policy_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Parameter description of field policy_resp

    Parameter

    +

    Type

    +

    Description

    +

    created_at

    +

    String

    +

    Creation time, for example, 2017-04-18T01:21:52.701973

    +

    description

    +

    String

    +

    Backup policy description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    id

    +

    String

    +

    Backup policy ID

    +

    name

    +

    String

    +

    Backup policy name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    parameters

    +

    policy_param

    +

    Parameters of a backup policy

    +

    project_id

    +

    String

    +

    Project ID

    +

    provider_id

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    resources

    +

    List<resource>

    +

    Backup object list

    +

    scheduled_operations

    +

    List<scheduled_operation_resp>

    +

    Scheduling period list

    +

    status

    +

    String

    +

    Backup policy status

    +

    tags

    +

    List<resource_tag>

    +

    Tag list

    +

    Keys in the tag list must be unique.

    +
    +
    +
  • Parameter description of field policy_param +
    + + + + + + + + + +
    Table 4 Parameter description of field policy_param

    Parameter

    +

    Type

    +

    Description

    +

    common

    +

    common_param

    +

    General backup policy parameters, which are blank by default

    +
    +
    +
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field resource

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Backup object ID

    +

    type

    +

    String

    +

    Entity object type of backup objects

    +

    The value is fixed at OS::Nova::Server (ECSs).

    +

    name

    +

    String

    +

    Backup object name

    +

    extra_info

    +

    Dict

    +

    Additional information about the backup object

    +
    +
    +
  • Parameter description of field scheduled_operation_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6 Parameter description of field scheduled_operation_resp

    Parameter

    +

    Type

    +

    Description

    +

    description

    +

    String

    +

    Scheduling period description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    enabled

    +

    Boolean

    +

    Whether the scheduling period is enabled

    +

    The default value is true. If it is set to false, automatic scheduling is disabled but manual scheduling is supported.

    +

    name

    +

    String

    +

    Scheduling period name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    operation_type

    +

    String

    +

    Operation type

    +

    Enumeration values: backup

    +

    operation_definition

    +

    operation_definition

    +

    Scheduling period parameters

    +

    trigger

    +

    trigger_resp

    +

    Scheduling policy

    +

    id

    +

    String

    +

    Scheduling period ID

    +
    +
    +
  • Parameter description of field operation_definition +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field operation_definition

    Parameter

    +

    Type

    +

    Description

    +

    max_backups

    +

    Integer

    +

    Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit.

    +

    retention_duration_days

    +

    Integer

    +

    Duration of retaining a backup, in days. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by retention duration.

    +

    permanent

    +

    Boolean

    +

    Whether backups are permanently retained

    +

    plan_id

    +

    String

    +

    Backup policy ID

    +

    provider_id

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +
    +
    +
  • Parameter description of field trigger_resp +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 8 Parameter description of field trigger_resp

    Parameter

    +

    Type

    +

    Description

    +

    properties

    +

    trigger_properties_resp

    +

    Scheduler properties

    +

    id

    +

    String

    +

    Scheduler ID

    +

    name

    +

    String

    +

    Scheduler name

    +

    type

    +

    String

    +

    Scheduling type

    +
    +
    +
  • Parameter description of field trigger_properties_resp +
    + + + + + + + + + + + + + + + + + +
    Table 9 Parameter description of field trigger_properties_resp

    Parameter

    +

    Type

    +

    Description

    +

    pattern

    +

    String

    +

    Scheduling policy of the scheduler

    +

    The value consists of a maximum of 10,240 characters. The scheduling policy complies with iCalendar RFC 2445, but it supports only four parameters, which are FREQ, BYDAY, BYHOUR, and BYMINUTE. FREQ can be set to WEEKLY and DAILY, BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week), BYHOUR ranges from 0 hours to 23 hours, and BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day.

    +

    start_time

    +

    String

    +

    Scheduler start time, for example, 2017-04-18T01:21:52.701973

    +

    format

    +

    String

    +

    Scheduler type

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + +
    Table 10 Parameter description of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    value

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response
    {
+  "policy" : {
+    "created_at" : "2017-03-07T09:31:08.265000",
+    "description" : "My plan",
+    "id" : "27b11f3f-578d-4464-89d1-7c6d5894f753",
+    "name" : "my-plan",
+    "parameters" : {
+      "common" : {
+      }
+    },
+    "project_id" : "tenant",
+    "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec",
+    "resources" : [ {
+      "id" : "45baf976-c20a-4894-a7c3-c94b7376bf55",
+      "name" : "resource1",
+      "type" : "OS::Nova::Server",
+      "extra_info" : {
+    }
+    }, {
+      "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
+      "name" : "resource2",
+      "type" : "OS::Nova::Server", 
+      "extra_info" : {
+    }
+    } ],
+    "scheduled_operations" : [ {
+      "description" : "My backup policy",
+      "enabled" : true,
+      "id" : "3b2fdf8c-2cc2-4887-9605-a8443922f6f2",
+      "name" : "my-backup-policy",
+      "operation_definition" : {
+        "max_backups" : "20",
+        "plan_id" : "27b11f3f-578d-4464-89d1-7c6d5894f753",
+        "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec"
+      },
+      "operation_type" : "backup",
+      "trigger" : {
+        "id" : "f1246246-ec6a-4e9a-917e-d050dc2808c9",
+        "name" : "default",
+        "properties" : {
+          "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
+          "start_time" : "2017-03-07 09:31:08",
+          "format": "ical"
+        },
+        "type" : "time"
+      },
+      "trigger_id" : "f1246246-ec6a-4e9a-917e-d050dc2808c9"
+    } ],
+    "status" : "disabled"
+  }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policy Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304227.html b/docs/csbs/api-ref/en-us_topic_0059304227.html new file mode 100644 index 000000000..39c590f41 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304227.html @@ -0,0 +1,616 @@ + + +

Querying the Backup Policy List

+

Function

This API is used to query the backup policy list. Filtering parameters are supported.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/policies

    +
  • Parameter description +
    + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    limit

    +

    No

    +

    Integer

    +

    Number of resources displayed per page. The value must be a positive integer. The value defaults to 1000.

    +

    marker

    +

    No

    +

    String

    +

    ID of the last record displayed on the previous page when pagination query is applied

    +

    sort

    +

    No

    +

    String

    +

    The value of sort is 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, backup policies are sorted in descending order by time. The value of sort contains a maximum of 255 characters.

    +

    name

    +

    No

    +

    String

    +

    Exact matching based on field name

    +

    all_tenants

    +

    No

    +

    Boolean

    +

    Whether backup policies of all tenants can be queried

    +

    This parameter is only available for administrators.

    +

    offset

    +

    No

    +

    Integer

    +

    Offset value, which is a positive integer.

    +
    +
    +
  • Parameter description
+

None

+
  • Example request
    Querying all backup policies:
+GET https://{endpoint}/v1/{project_id}/policies
+Querying backup policies with certain conditions:
+GET https://{endpoint}/v1/{project_id}/policies?sort=created_at%3Aasc&limit=3&offset=3
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    policies

    +

    List<policy_resp>

    +

    For details, see the policy_resp field description.

    +
    +
    +
  • Parameter description of field policy_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field policy_resp

    Parameter

    +

    Type

    +

    Description

    +

    created_at

    +

    String

    +

    Creation time, for example, 2017-04-18T01:21:52.701973

    +

    description

    +

    String

    +

    Backup policy description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    id

    +

    String

    +

    Backup policy ID

    +

    name

    +

    String

    +

    Backup policy name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    parameters

    +

    policy_param

    +

    Parameters of a backup policy

    +

    project_id

    +

    String

    +

    Project ID

    +

    provider_id

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    resources

    +

    List<resource>

    +

    Backup object list

    +

    scheduled_operations

    +

    List<scheduled_operation_resp>

    +

    Scheduling period list

    +

    status

    +

    String

    +

    Backup policy status

    +

    tags

    +

    List<resource_tag>

    +

    Tag list

    +

    Keys in the tag list must be unique.

    +
    +
    +
  • Parameter description of field policy_param +
    + + + + + + + + + +
    Table 5 Parameter description of field policy_param

    Parameter

    +

    Type

    +

    Description

    +

    common

    +

    common_param

    +

    General backup policy parameters, which are blank by default

    +
    +
    +
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 6 Parameter description of field resource

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Backup object ID

    +

    type

    +

    String

    +

    Entity object type of backup objects

    +

    The value is fixed at OS::Nova::Server (ECSs).

    +

    name

    +

    String

    +

    Backup object name

    +

    extra_info

    +

    Dict

    +

    Additional information about the backup object

    +
    +
    +
  • Parameter description of field scheduled_operation_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field scheduled_operation_resp

    Parameter

    +

    Type

    +

    Description

    +

    description

    +

    String

    +

    Scheduling period description

    +

    The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<).

    +

    enabled

    +

    Boolean

    +

    Whether the scheduling period is enabled

    +

    The default value is true. If it is set to false, automatic scheduling is disabled but manual scheduling is supported.

    +

    name

    +

    String

    +

    Scheduling period name

    +

    The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

    +

    operation_type

    +

    String

    +

    Operation type

    +

    Enumeration values: backup

    +

    operation_definition

    +

    operation_definition

    +

    Scheduling period parameters

    +

    trigger

    +

    trigger_resp

    +

    Scheduling policy

    +

    id

    +

    String

    +

    Scheduling period ID

    +
    +
    +
  • Parameter description of field operation_definition +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 8 Parameter description of field operation_definition

    Parameter

    +

    Type

    +

    Description

    +

    max_backups

    +

    Integer

    +

    Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit.

    +

    retention_duration_days

    +

    Integer

    +

    Duration of retaining a backup, in days. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by retention duration.

    +

    permanent

    +

    Boolean

    +

    Whether backups are permanently retained

    +

    plan_id

    +

    String

    +

    Backup policy ID

    +

    provider_id

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +
    +
    +
  • Parameter description of field trigger_resp +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 9 Parameter description of field trigger_resp

    Parameter

    +

    Type

    +

    Description

    +

    properties

    +

    trigger_properties_resp

    +

    Scheduler properties

    +

    id

    +

    String

    +

    Scheduler ID

    +

    name

    +

    String

    +

    Scheduler name

    +

    type

    +

    String

    +

    Scheduling type

    +
    +
    +
  • Parameter description of field trigger_properties_resp +
    + + + + + + + + + + + + + + + + + +
    Table 10 Parameter description of field trigger_properties_resp

    Parameter

    +

    Type

    +

    Description

    +

    pattern

    +

    String

    +

    Scheduling policy of the scheduler

    +

    The value consists of a maximum of 10,240 characters. The scheduling policy complies with iCalendar RFC 2445, but it supports only four parameters, which are FREQ, BYDAY, BYHOUR, and BYMINUTE. FREQ can be set to WEEKLY and DAILY, BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week), BYHOUR ranges from 0 hours to 23 hours, and BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day.

    +

    start_time

    +

    String

    +

    Start time of the scheduler, for example, 2017-03-07 09:31:08

    +

    format

    +

    String

    +

    Scheduler type

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + +
    Table 11 Parameter description of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    value

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response
    {
+  "policies" : [ {
+    "created_at" : "2017-03-07T09:31:08.265000",
+    "description" : "My plan",
+    "id" : "27b11f3f-578d-4464-89d1-7c6d5894f753",
+    "name" : "my-plan",
+    "parameters" : {
+      "common" : {
+      }
+    },
+    "project_id" : "tenant",
+    "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec",
+    "resources" : [ {
+      "id" : "45baf976-c20a-4894-a7c3-c94b7376bf55",
+      "name" : "resource1",
+      "type" : "OS::Nova::Server",
+      "extra_info" : {
+    }
+    }, {
+      "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
+      "name" : "resource2",
+      "type" : "OS::Nova::Server",
+      "extra_info" : {
+    }
+    } ],
+    "scheduled_operations" : [ {
+      "description" : "My backup policy",
+      "enabled" : true,
+      "id" : "3b2fdf8c-2cc2-4887-9605-a8443922f6f2",
+      "name" : "my-backup-policy",
+      "operation_definition" : {
+        "max_backups" : "20",
+        "plan_id" : "27b11f3f-578d-4464-89d1-7c6d5894f753",
+        "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec"
+      },
+      "operation_type" : "backup",
+      "trigger" : {
+        "id" : "f1246246-ec6a-4e9a-917e-d050dc2808c9",
+        "name" : "default",
+        "properties" : {
+          "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
+          "start_time" : "2017-03-07 09:31:08",
+          "format": "ical"
+        },
+        "type" : "time"
+      },
+      "trigger_id" : "f1246246-ec6a-4e9a-917e-d050dc2808c9"
+    } ],
+    "status" : "disabled"
+  } ]
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policy Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304229.html b/docs/csbs/api-ref/en-us_topic_0059304229.html new file mode 100644 index 000000000..eabe02df6 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304229.html @@ -0,0 +1,23 @@ + + +

Backup Management

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304230.html b/docs/csbs/api-ref/en-us_topic_0059304230.html new file mode 100644 index 000000000..71c9e7867 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304230.html @@ -0,0 +1,381 @@ + + +

Executing a Backup Policy

+

Function

This API is used to manually execute a backup policy and create a backup task.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    provider_id

    +

    Yes

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    checkpoint

    +

    Yes

    +

    checkpoint_req

    +

    For details, see the checkpoint_req field description.

    +
    +
    +
  • Parameter description of field checkpoint_req +
    + + + + + + + + + + + + + + + + +
    Table 3 Parameter description of field checkpoint_req

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    parameters

    +

    Yes

    +

    checkpoint_param

    +

    Backup parameters

    +

    plan_id

    +

    Yes

    +

    String

    +

    Backup policy ID. Refer to the backup policy ID that is returned by the API of Querying the Backup Policy List.

    +
    +
    +
  • Parameter description of field checkpoint_param +
    + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field checkpoint_param

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    auto_trigger

    +

    No

    +

    Boolean

    +

    Whether automatic trigger is enabled

    +

    resources

    +

    No

    +

    List<String>

    +

    ID list of resources to be backed up

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints
+{
+  "checkpoint" : {
+    "plan_id" : "62171999-3df1-42f7-9513-6f9b1bea4744",
+    "parameters" : {
+      "auto_trigger" : false,
+      "resources" : [ "7a32a8b5-7977-4e24-b5da-e0eb457db75b", "b2b433bf-7dd6-4a74-aa8f-85673dfbda48" ]
+    }
+  }
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 5 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    checkpoint

    +

    checkpoint_resp

    +

    See the checkpoint_resp field description.

    +
    +
    +
  • Parameter description of field checkpoint_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6 Parameter description of field checkpoint_resp

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Status. The value can be protecting, deleting, available, or error.

    +

    created_at

    +

    String

    +

    Creation time, for example, 2016-12-06T21:20:29.898823

    +

    id

    +

    String

    +

    Backup record ID

    +

    resource_graph

    +

    String

    +

    Resource diagram, which displays the mapping relationship between resources and backups. If the value is null, the backup contains only the resource backup of the entire system.

    +

    project_id

    +

    String

    +

    Project ID

    +

    protection_plan

    +

    plan_resp

    +

    Backup policy information

    +

    extra_info

    +

    String

    +

    Additional information about the backup object, such as the backup creation mode

    +
    +
    +
  • Parameter description of field plan_resp +
    + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field plan_resp

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Backup policy ID

    +

    name

    +

    String

    +

    Backup policy name

    +

    resources

    +

    List<resource>

    +

    Backup object list

    +
    +
    +
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 8 Parameter description of field resource

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Backup object ID

    +

    type

    +

    String

    +

    Entity object type of backup objects

    +

    The value is fixed at OS::Nova::Server (ECSs).

    +

    name

    +

    String

    +

    Backup object name

    +

    extra_info

    +

    String

    +

    Additional information of the resource

    +
    +
    +
  • Example response
    {
+  "checkpoint" : {
+    "status" : "protecting",
+    "created_at" : "2016-12-06T21:20:29.898823",
+    "id" : "14626f11-b54a-44ea-8e69-7463e527506a",
+    "resource_graph" : null,
+    "project_id" : "b942cc8342734d15bcb246babb1953cf",
+    "protection_plan" : {
+      "id" : "6a6cda7e-7b89-4b14-8e5c-3b6821a97d2c",
+      "resources" : [ {
+        "type" : "OS::Nova::Server",
+        "id" : "1c960fe4-e679-421a-97cd-4f7463d2344b",
+        "name" : "server0",
+        "extra_info": "{}"
+      } ],
+      "name" : "backup"
+    },
+    "extra_info": "{"created_by": "manual"}"
+  }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304232.html b/docs/csbs/api-ref/en-us_topic_0059304232.html new file mode 100644 index 000000000..d5f436cab --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304232.html @@ -0,0 +1,155 @@ + + +

Deleting a Backup

+

Function

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 deletion will not be completed immediately. You need to query the task information continuously to obtain the deletion result. A maximum of 30 minutes is required.

+

For example, a user can execute a maximum of five backup deletion tasks concurrently. If the number exceeds five, the sixth and subsequent tasks are queued.

+
+
+

URI

  • URI format

    DELETE https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints/{checkpoint_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    provider_id

    +

    Yes

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    checkpoint_id

    +

    Yes

    +

    String

    +

    Backup record ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    checkpoint_items

    +

    No

    +

    String

    +

    Indicates the ID list of the backup records to be deleted. If this parameter is not set, all backup records of checkpoint will be deleted.

    +
    +
    +
  • Parameter description

    None

    +
+
  • Example request
    Deleting all backups in the specified backup record:
+DELETE https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints/{checkpoint_id}
+Deleting a single backup in the specified backup record:
+DELETE https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints/{checkpoint_id}?checkpoint_items={checkpoint_items_id}
    +
+
+

Response

  • Parameter description

    None

    +
+
  • Example response
    { 
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304233.html b/docs/csbs/api-ref/en-us_topic_0059304233.html new file mode 100644 index 000000000..e8aef34a7 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304233.html @@ -0,0 +1,261 @@ + + +

Querying the Number of Backups

+

Function

This API is used to query the number of backups. Filtering parameters are supported.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/checkpoint_items/count

    +
  • Parameter description +
    + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    status

    +

    No

    +

    String

    +

    Query based on field status is supported.

    +

    Value range: waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting, and deleted

    +

    all_tenants

    +

    No

    +

    Boolean

    +

    Whether to query the backups of all tenants. Only administrators can query the backups of all tenants.

    +

    name

    +

    No

    +

    String

    +

    Supports query by backup name.

    +

    az

    +

    No

    +

    String

    +

    AZ-based filtering is supported.

    +

    resource_id

    +

    No

    +

    String

    +

    Filtering based on the backup object ID is supported.

    +

    resource_name

    +

    No

    +

    String

    +

    Filtering based on the backup object name is supported.

    +

    start_time

    +

    No

    +

    String

    +

    Filtering based on the backup time is supported. This is the backup start time. For example, 2017-04-15T04:25:38

    +

    end_time

    +

    No

    +

    String

    +

    Filtering based on the backup time is supported. This is the backup end time. For example, 2017-04-15T04:25:38

    +

    image_type

    +

    No

    +

    String

    +

    Supports filtering by backup image type. This parameter can be used only when images are created using backups. The image type can be obtained from Image Management Service.

    +

    policy_id

    +

    No

    +

    String

    +

    Filtering based on policy_id is supported.

    +

    ip

    +

    No

    +

    String

    +

    Searching based on the VM's IP address is supported.

    +

    checkpoint_id

    +

    No

    +

    String

    +

    Filtering based on checkpoint_id is supported.

    +

    resource_type

    +

    No

    +

    String

    +

    Type of the backup object. For example, OS::Nova::Server

    +
    +
    +
  • Parameter description

    None

    +
+
  • Example request
    Querying the total number of backups:
+GET https://{endpoint}/v1/{project_id}/checkpoint_items/count
+Querying the number of backups with certain conditions:
+GET https://{endpoint}/v1/{project_id}/checkpoint_items/count?status=error
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    count

    +

    Integer

    +

    Number of backups

    +
    +
    +
  • Example response
    {
+  "count" : 10
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304234.html b/docs/csbs/api-ref/en-us_topic_0059304234.html new file mode 100644 index 000000000..eab6f9c76 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304234.html @@ -0,0 +1,731 @@ + + +

Querying a Single Backup

+

Function

This API is used to query a single backup by ID.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/checkpoint_items/{checkpoint_item_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    checkpoint_item_id

    +

    Yes

    +

    String

    +

    Backup ID

    +
    +
    +
+
+

Request

  • Parameter description

    None

    +
+
  • Example request
    GET https://{endpoint}/v1/{project_id}/checkpoint_items/{checkpoint_item_id}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    checkpoint_item

    +

    checkpoint_item

    +

    For details, see Table 3.

    +
    +
    +
  • Parameter description of field checkpoint_item +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Parameter description of field checkpoint_item

    Parameter

    +

    Type

    +

    Description

    +

    checkpoint_id

    +

    String

    +

    Backup record ID

    +

    created_at

    +

    String

    +

    Creation time, for example, 2017-04-18T01:21:52.701973

    +

    extend_info

    +

    Dict

    +

    Extension information

    +

    id

    +

    String

    +

    Backup ID

    +

    name

    +

    String

    +

    Backup name

    +

    resource_id

    +

    String

    +

    Backup object ID

    +

    status

    +

    String

    +

    Backup status

    +

    Value range: waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting, and deleted

    +

    updated_at

    +

    String

    +

    Modification time, for example, 2017-04-18T01:21:52.701973

    +

    backup_data

    +

    Dict

    +

    VM metadata

    +

    description

    +

    string

    +

    Backup description

    +

    tags

    +

    List<resource_tag>

    +

    List of backup tags

    +

    Keys in the tag list must be unique.

    +

    resource_type

    +

    String

    +

    Backup object type

    +
    +
    +
  • Parameter description of field extend_info +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field extend_info

    Parameter

    +

    Type

    +

    Description

    +

    auto_trigger

    +

    Boolean

    +

    Whether automatic trigger is enabled

    +

    average_speed

    +

    Integer

    +

    Average rate. The unit is kb/s

    +

    copy_from

    +

    String

    +

    The destination region of a backup replication. The value is left blank by default.

    +

    copy_status

    +

    String

    +

    Backup replication status. The default value is na.

    +

    Possible values are na, waiting_copy, copying, success, and fail.

    +

    fail_code

    +

    fail_code

    +

    Error code

    +

    fail_op

    +

    String

    +

    Type of the failed operation

    +

    Enum: [backup, restore, delete]

    +

    fail_reason

    +

    String

    +

    Description of the failure cause

    +

    image_type

    +

    String

    +

    Backup type, for example, backup

    +

    incremental

    +

    Boolean

    +

    Whether the backup is an enhanced backup

    +

    progress

    +

    Integer

    +

    Backup progress. The value is an integer ranging from 0 to 100.

    +

    resource_az

    +

    String

    +

    AZ to which the backup resource belongs

    +

    resource_name

    +

    String

    +

    Backup object name

    +

    resource_type

    +

    String

    +

    Type of the backup object. For example, OS::Nova::Server

    +

    size

    +

    Integer

    +

    Backup capacity. The unit is MB.

    +

    space_saving_ratio

    +

    Integer

    +

    Space saving rate

    +

    volume_backups

    +

    List<volume_backup>

    +

    Disk backup list

    +

    finished_at

    +

    String

    +

    Backup completion time, for example, 2017-04-18T01:21:52.701973

    +

    supported_restore_mode

    +

    String

    +

    Restoration mode. Possible values are na, snapshot, and backup.

    +

    backup: Data is restored from backups of the disks of the server.

    +

    na: Restoration is not supported.

    +

    os_images_data

    +

    List<image_data>

    +

    Image data. This parameter has a value if an image has been created for the VM.

    +

    support_lld

    +

    Boolean

    +

    Whether to allow lazyloading for fast restoration

    +

    taskid

    +

    String

    +

    Job ID

    +

    hypervisor_type

    +

    String

    +

    Virtualization type

    +

    The value is fixed at QEMU.

    +
    +
    +
  • Parameter description of field backup_data +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field backup_data

    Parameter

    +

    Type

    +

    Description

    +

    __openstack_region_name

    +

    String

    +

    Name of the AZ where the server is located. If this parameter is left blank, such information about the server has not been obtained.

    +

    cloudservicetype

    +

    String

    +

    Server type

    +

    The value is fixed at server (ECSs).

    +

    disk

    +

    Integer

    +

    System disk size corresponding to the server specifications

    +

    imagetype

    +

    String

    +

    Image type

    +

    The value can be:

    +

    gold: public image

    +

    private: private image

    +

    market: market image

    +

    ram

    +

    Integer

    +

    Memory size of the server, in MB

    +

    vcpus

    +

    Integer

    +

    CPU cores corresponding to the server

    +

    eip

    +

    String

    +

    Elastic IP address of the server. If this parameter is left blank, such information about the server has not been obtained.

    +

    private_ip

    +

    String

    +

    Internal IP address of the server. If this parameter is left blank, such information about the server has not been obtained.

    +
    +
    +
  • Parameter description of field image_data +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    image_id

    +

    String

    +

    Image ID

    +
    +
    +
  • Parameter description of field fail_code +
    + + + + + + + + + + + + + +
    Table 6 Parameter description of field fail_code

    Parameter

    +

    Type

    +

    Description

    +

    Code

    +

    Long

    +

    Error code

    +

    Description

    +

    String

    +

    Error description

    +
    +
    +
  • Parameter description of field volume_backup +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field volume_backup

    Parameter

    +

    Type

    +

    Description

    +

    average_speed

    +

    Integer

    +

    Average rate, in MB/s

    +

    bootable

    +

    Boolean

    +

    Whether the disk functions as a system disk

    +

    The value can be true or false.

    +

    id

    +

    String

    +

    Cinder backup ID

    +

    image_type

    +

    String

    +

    Backup set type

    +

    Enum:[ backup]

    +

    incremental

    +

    Boolean

    +

    Whether incremental backup is used

    +

    name

    +

    String

    +

    Disk backup name

    +

    size

    +

    Integer

    +

    Accumulated size (MB) of backups

    +

    source_volume_id

    +

    String

    +

    Source disk ID

    +

    source_volume_size

    +

    Integer

    +

    Source disk size in GB

    +

    space_saving_ratio

    +

    Integer

    +

    Space saving rate

    +

    status

    +

    String

    +

    Status

    +

    source_volume_name

    +

    String

    +

    Source disk name

    +

    snapshot_id

    +

    String

    +

    ID of the snapshot from which the backup is generated

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + +
    Table 8 Parameter description of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    value

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response
    {
+  "checkpoint_item": {
+    "status": "available",
+    "backup_data": {
+      "eip": "",
+      "cloudservicetype": "",
+      "ram": 4096,
+      "vcpus": 4,
+      "__openstack_region_name": "",
+      "private_ip": "",
+      "disk": 0,
+      "imagetype": ""
+    },
+    "name": "backup_d32c",
+    "resource_id": "f45c477a-57e5-465f-999f-d845083962db",
+    "created_at": "2017-04-15T04:20:37.277880",
+    "checkpoint_id": "f672a1bb-6912-446a-816c-72792c5263e0",
+    "updated_at": "2017-04-15T04:25:38.680638",
+    "resource_type": "OS::Nova::Server",
+    "extend_info": {
+      "auto_trigger": false,
+      "space_saving_ratio": 0,
+      "copy_status": "na",
+      "fail_reason": "",
+      "resource_az": "az1.dc1",
+      "image_type": "backup",
+      "finished_at": "2017-04-15T04:25:38.675478",
+      "average_speed": 0,
+      "copy_from": "",
+      "supported_restore_mode": "backup",
+      "support_lld": false,
+      "os_images_data": [
+            {
+                "image_id": "fe84dd80-0229-4918-8d3d-cbb33154b565"
+            }
+        ],
+      "volume_backups": [
+        {
+          "status": "available",
+          "space_saving_ratio": 0,
+          "name": "manualbk_47222",
+          "bootable": true,
+          "average_speed": 0,
+          "source_volume_size": 20,
+          "source_volume_id": "ee27f809-6fb5-40ae-ac46-c932bb4ee8fe",
+          "incremental": false,
+          "image_type": "backup",
+          "source_volume_name": "karbor_02",
+          "id": "70675cbc-d3a8-43a7-9f81-c8b6bc3f5d6d",
+          "size": 0,
+          "snapshot_id": "36f520e1-d2ea-4907-956a-3d9cd53e2d38"
+        },
+        {
+          "status": "available",
+          "space_saving_ratio": 0,
+          "name": "manualbk_47222",
+          "bootable": true,
+          "average_speed": 0,
+          "source_volume_size": 20,
+          "source_volume_id": "e7f48980-927c-48de-afd4-f0245d2e5100",
+          "incremental": false,
+          "image_type": "backup",
+          "source_volume_name": "karbor_01",
+          "id": "8eb98e91-8924-4d4b-b6d6-28fb7b751e9c",
+          "size": 0,
+          "snapshot_id": "36f520e1-d2ea-4907-956a-3d9cd53e2d38"
+        }
+      ],
+      "fail_code": {},
+      "incremental": false,
+      "taskid": "e0a21692-2192-11e7-bf23-0242ac110007",
+      "hypervisor_type": "QEMU",
+      "progress": 100,
+      "fail_op": "",
+      "resource_name": "karbor_02",
+      "size": 0
+    },
+    "id": "90c1d5fa-1b9f-4aeb-b2f4-81c806e98190"
+  }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304235.html b/docs/csbs/api-ref/en-us_topic_0059304235.html new file mode 100644 index 000000000..5795c19b9 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304235.html @@ -0,0 +1,887 @@ + + +

Querying All Backups

+

Function

This API is used to query all backups. Filtering parameters are supported.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/checkpoint_items

    +
  • Parameter description +
    + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    status

    +

    No

    +

    String

    +

    Query based on field status is supported.

    +

    Value range: waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting, and deleted

    +

    limit

    +

    No

    +

    Integer

    +

    Number of resources displayed per page. The value must be a positive integer. The value defaults to 1000.

    +

    marker

    +

    No

    +

    String

    +

    ID of the last record displayed on the previous page

    +

    sort

    +

    No

    +

    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. Enumeration values of the key are as follows: created_at, updated_at, name, status, protected_at, and id.

    +

    all_tenants

    +

    No

    +

    Boolean

    +

    Whether to query the backups of all tenants. Only administrators can query the backups of all tenants.

    +

    name

    +

    No

    +

    String

    +

    Fuzzy search based on field name is supported.

    +

    az

    +

    No

    +

    String

    +

    Filtering based on the backup AZ is supported.

    +

    resource_id

    +

    No

    +

    String

    +

    Filtering based on the backup object ID is supported.

    +

    resource_name

    +

    No

    +

    String

    +

    Fuzzy search based on the backup object name is supported.

    +

    start_time

    +

    No

    +

    String

    +

    Filtering based on the backup start time is supported.

    +

    For example: 2017-04-18T01:21:52.701973

    +

    end_time

    +

    No

    +

    String

    +

    Filtering based on the backup end time is supported.

    +

    For example: 2017-04-18T01:21:52.701973

    +

    image_type

    +

    No

    +

    String

    +

    Supports filtering by image type, for example, backup.

    +

    policy_id

    +

    No

    +

    String

    +

    Filtering based on policy_id is supported.

    +

    offset

    +

    No

    +

    Integer

    +

    Offset value, which is a positive integer.

    +

    checkpoint_id

    +

    No

    +

    String

    +

    Filtering based on checkpoint_id is supported.

    +

    resource_type

    +

    No

    +

    String

    +

    Type of the backup object. For example, OS::Nova::Server

    +
    +
    +
  • Parameter description

    None

    +
+
  • Example request
    Querying all backups:
+GET https://{endpoint}/v1/{project_id}/checkpoint_items
+Querying backups with specified parameters:
+GET https://{endpoint}/v1/{project_id}/checkpoint_items?name=backup&status=error&limit=2
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    checkpoint_items

    +

    List<checkpoint_item>

    +

    -

    +
    +
    +
  • Parameter description of field checkpoint_item +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field checkpoint_item

    Parameter

    +

    Type

    +

    Description

    +

    checkpoint_id

    +

    String

    +

    Backup record ID

    +

    created_at

    +

    String

    +

    Creation time, for example, 2017-04-18T01:21:52.701973

    +

    extend_info

    +

    Dict

    +

    Extension information

    +

    id

    +

    String

    +

    Backup ID

    +

    name

    +

    String

    +

    Backup name

    +

    resource_id

    +

    String

    +

    Backup object ID

    +

    status

    +

    String

    +

    Backup status

    +

    The value can be waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting, or deleted.

    +

    updated_at

    +

    String

    +

    Modification time, for example, 2017-04-18T01:21:52.701973

    +

    backup_data

    +

    Dict

    +

    VM metadata

    +

    description

    +

    string

    +

    Backup description

    +

    tags

    +

    List<resource_tag>

    +

    List of backup tags

    +

    Keys in the tag list must be unique.

    +

    resource_type

    +

    String

    +

    Backup object type

    +
    +
    +
  • Parameter description of field extend_info +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field extend_info

    Parameter

    +

    Type

    +

    Description

    +

    auto_trigger

    +

    Boolean

    +

    Whether automatic trigger is enabled

    +

    average_speed

    +

    Integer

    +

    Average rate. The unit is kb/s

    +

    copy_from

    +

    String

    +

    The destination region of a backup replication. The value is left blank by default.

    +

    copy_status

    +

    String

    +

    Backup replication status. The default value is na.

    +

    Possible values are na, waiting_copy, copying, success, and fail.

    +

    fail_code

    +

    fail_code

    +

    Error code

    +

    fail_op

    +

    String

    +

    Type of the failed operation

    +

    Enum: [backup, restore, delete]

    +

    fail_reason

    +

    String

    +

    Description of the failure cause

    +

    image_type

    +

    String

    +

    Backup type, for example, backup

    +

    incremental

    +

    Boolean

    +

    Whether the backup is an enhanced backup

    +

    progress

    +

    Integer

    +

    Backup progress. The value is an integer ranging from 0 to 100.

    +

    resource_az

    +

    String

    +

    AZ to which the backup resource belongs

    +

    resource_name

    +

    String

    +

    Backup object name

    +

    resource_type

    +

    String

    +

    Type of the backup object. For example, OS::Nova::Server

    +

    size

    +

    Integer

    +

    Backup capacity. The unit is MB.

    +

    space_saving_ratio

    +

    Integer

    +

    Space saving rate

    +

    volume_backups

    +

    List<volume_backup>

    +

    Disk backup list

    +

    finished_at

    +

    String

    +

    Backup completion time, for example, 2017-04-18T01:21:52.701973

    +

    supported_restore_mode

    +

    String

    +

    Restoration mode. Possible values are na, snapshot, and backup.

    +

    backup: Data is restored from backups of the disks of the server.

    +

    na: Restoration is not supported.

    +

    os_images_data

    +

    List<image_data>

    +

    Image data. This parameter has a value if an image has been created for the VM.

    +

    support_lld

    +

    Boolean

    +

    Whether to allow lazyloading for fast restoration

    +

    taskid

    +

    String

    +

    Job ID

    +

    hypervisor_type

    +

    String

    +

    Virtualization type

    +

    The value is fixed at QEMU.

    +
    +
    +
  • Parameter description of field image_data +
    + + + + + + + + + +
    Table 6 Parameter description of field image_data

    Parameter

    +

    Type

    +

    Description

    +

    image_id

    +

    String

    +

    Image ID

    +
    +
    +
  • Parameter description of field backup_data +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field backup_data

    Parameter

    +

    Type

    +

    Description

    +

    __openstack_region_name

    +

    String

    +

    Name of the AZ where the server is located. If this parameter is left blank, such information about the server has not been obtained.

    +

    cloudservicetype

    +

    String

    +

    Server type

    +

    disk

    +

    Integer

    +

    System disk size corresponding to the server specifications

    +

    imagetype

    +

    String

    +

    Image type

    +

    The value can be:

    +

    gold: public image

    +

    private: private image

    +

    market: market image

    +

    ram

    +

    Integer

    +

    Memory size of the server, in MB

    +

    vcpus

    +

    Integer

    +

    CPU cores corresponding to the server

    +

    eip

    +

    String

    +

    Elastic IP address of the server. If this parameter is left blank, such information about the server has not been obtained.

    +

    private_ip

    +

    String

    +

    Internal IP address of the server. If this parameter is left blank, such information about the server has not been obtained.

    +
    +
    +
  • Parameter description of field fail_code +
    + + + + + + + + + + + + + +
    Table 8 Parameter description of field fail_code

    Parameter

    +

    Type

    +

    Description

    +

    Code

    +

    Long

    +

    Error code

    +

    Description

    +

    String

    +

    Error description

    +
    +
    +
  • Parameter description of field volume_backup +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 9 Parameter description of field volume_backup

    Parameter

    +

    Type

    +

    Description

    +

    average_speed

    +

    Integer

    +

    Average rate, in MB/s

    +

    bootable

    +

    Boolean

    +

    Whether the disk functions as a system disk

    +

    The value can be true or false.

    +

    id

    +

    String

    +

    Cinder backup ID

    +

    image_type

    +

    String

    +

    Backup set type

    +

    Enum:[ backup]

    +

    incremental

    +

    Boolean

    +

    Whether incremental backup is used

    +

    name

    +

    String

    +

    Disk backup name

    +

    size

    +

    Integer

    +

    Accumulated size (MB) of backups

    +

    source_volume_id

    +

    String

    +

    Source disk ID

    +

    source_volume_size

    +

    Integer

    +

    Source disk size in GB

    +

    space_saving_ratio

    +

    Integer

    +

    Space saving rate

    +

    status

    +

    String

    +

    Status

    +

    source_volume_name

    +

    String

    +

    Source disk name

    +

    snapshot_id

    +

    String

    +

    ID of the snapshot from which the backup is generated

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + +
    Table 10 Parameter description of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    value

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response
    {
+  "checkpoint_items" : [ {
+    "status" : "available",
+    "backup_data" : {
+      "eip" : "",
+      "cloudservicetype" : "",
+      "ram" : 4096,
+      "vcpus" : 4,
+      "__openstack_region_name" : "",
+      "private_ip" : "",
+      "disk" : 0,
+      "imagetype" : ""
+    },
+    "name" : "backup_d32c",
+    "resource_id" : "f45c477a-57e5-465f-999f-d845083962db",
+    "created_at" : "2017-04-15T04:20:37.277880",
+    "checkpoint_id" : "f672a1bb-6912-446a-816c-72792c5263e0",
+    "updated_at" : "2017-04-15T04:25:38.680638",
+    "resource_type": "OS::Nova::Server",
+    "extend_info" : {
+      "auto_trigger" : false,
+      "space_saving_ratio" : 0,
+      "copy_status" : "na",
+      "fail_reason" : "",
+      "resource_az" : "az1.dc1",
+      "image_type" : "backup",
+      "finished_at" : "2017-04-15T04:25:38.675478",
+      "average_speed" : 0,
+      "copy_from" : "",
+      "supported_restore_mode": "backup",
+      "support_lld": false,
+      "os_images_data": [
+            {
+                "image_id": "fe84dd80-0229-4918-8d3d-cbb33154b565"
+            }
+       ],
+      "volume_backups" : [ {
+        "status" : "available",
+        "space_saving_ratio" : 0,
+        "name" : "manualbk_47222",
+        "bootable" : true,
+        "average_speed" : 0,
+        "source_volume_size" : 20,
+        "source_volume_id" : "ee27f809-6fb5-40ae-ac46-c932bb4ee8fe",
+        "incremental" : false,
+        "image_type" : "backup",
+        "source_volume_name" : "karbor_xj_02",
+        "id" : "70675cbc-d3a8-43a7-9f81-c8b6bc3f5d6d",
+        "size" : 0,
+        "snapshot_id": "36f520e1-d2ea-4907-956a-3d9cd53e2d38"
+      }, {
+        "status" : "available",
+        "space_saving_ratio" : 0,
+        "name" : "manualbk_47222",
+        "bootable" : true,
+        "average_speed" : 0,
+        "source_volume_size" : 20,
+        "source_volume_id" : "e7f48980-927c-48de-afd4-f0245d2e5100",
+        "incremental" : false,
+        "image_type" : "backup",
+        "source_volume_name" : "karbor_01",
+        "id" : "8eb98e91-8924-4d4b-b6d6-28fb7b751e9c",
+        "size" : 0,
+        "snapshot_id": "36f520e1-d2ea-4907-956a-3d9cd53e2d38"
+      } ],
+      "fail_code" : { },
+      "incremental" : false,
+      "taskid" : "e0a21692-2192-11e7-bf23-0242ac110007",
+      "hypervisor_type" : "QEMU",
+      "progress" : 100,
+      "fail_op" : "",
+      "resource_name" : "karbor_02",
+      "size" : 0
+    },
+    "id" : "90c1d5fa-1b9f-4aeb-b2f4-81c806e98190"
+  } ]
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304236.html b/docs/csbs/api-ref/en-us_topic_0059304236.html new file mode 100644 index 000000000..bdf9d4196 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304236.html @@ -0,0 +1,15 @@ + + +

Restoration Management

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304237.html b/docs/csbs/api-ref/en-us_topic_0059304237.html new file mode 100644 index 000000000..fea6b91a2 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304237.html @@ -0,0 +1,499 @@ + + +

Creating a Restoration Task

+

Function

This API is used to perform backup-based restoration.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/restores

    +
  • Parameter description +
    + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    restore

    +

    Yes

    +

    restore_req

    +

    Restoration request

    +
    +
    +
  • Parameter description of field restore_req +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Parameter description of field restore_req

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    checkpoint_id

    +

    Yes

    +

    String

    +

    Backup record ID

    +

    parameters

    +

    Yes

    +

    restore_param

    +

    Restoration parameters

    +

    provider_id

    +

    Yes

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    restore_target

    +

    No

    +

    String

    +

    Restoration target

    +
    +
    +
  • Parameter description of field restore_param +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field restore_param

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    checkpoint_item_id

    +

    Yes

    +

    String

    +

    Backup ID

    +

    power_on

    +

    Yes

    +

    Boolean

    +

    Whether to instantly power on the VM after restoration

    +

    targets

    +

    Yes

    +

    restore_target

    +

    Restoration target

    +
    +
    +
  • Parameter description of field restore_target +
    + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field restore_target

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    server_id

    +

    Yes

    +

    String

    +

    ID of the ECS to be restored

    +

    volumes

    +

    Yes

    +

    List<restore_volume_mapping>

    +

    List of the mappings between disk backups and target disks

    +
    +
    +
  • Parameter description of field restore_volume_mapping +
    + + + + + + + + + + + + + + + + +
    Table 6 Parameter description of field restore_volume_mapping

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    backup_id

    +

    Yes

    +

    String

    +

    Disk backup ID

    +

    volume_id

    +

    Yes

    +

    String

    +

    ID of the destination disk for the restoration

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/restores
+{
+  "restore" : {
+    "provider_id" : "fc4d5750-22e7-4798-8a46-f48f62c4c1da",
+    "checkpoint_id" : "a2b9fb53-2770-4fcd-9bad-6cadd56e6c09",
+    "parameters" : {
+      "checkpoint_item_id" : "504b7d59-c361-411f-9ed3-814f35d08e3d",
+      "power_on" : true,
+      "targets" : {
+        "server_id" : "f45c477a-57e5-465f-999f-d845083962db",
+        "volumes" : [ {
+          "backup_id" : "bc118c24-3234-4afd-8423-d66d3d677649",
+          "volume_id" : "ee27f809-6fb5-40ae-ac46-c932bb4ee8fe"
+        }]
+      }
+    }
+  }
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 7 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    restore

    +

    restore_resp

    +

    Restoration response

    +
    +
    +
  • Parameter description of field restore_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 8 Parameter description of field restore_resp

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Restoration ID

    +

    checkpoint_id

    +

    String

    +

    Backup record ID

    +

    parameters

    +

    restore_param

    +

    Restoration parameters

    +

    project_id

    +

    String

    +

    Project ID

    +

    provider_id

    +

    String

    +

    Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.

    +

    resources_reason

    +

    Dict

    +

    Cause of the resource restoration failure

    +

    resources_status

    +

    Dict

    +

    Resource status after the resource is restored, for example, available

    +

    restore_target

    +

    String

    +

    Restoration target

    +

    status

    +

    String

    +

    Status

    +
    +
    +
  • Parameter description of field restore_param +
    + + + + + + + + + + + + + + + + + +
    Table 9 Parameter description of field restore_param

    Parameter

    +

    Type

    +

    Description

    +

    checkpoint_item_id

    +

    String

    +

    Backup ID

    +

    power_on

    +

    Boolean

    +

    Whether to power on the VM after restoration

    +

    targets

    +

    restore_target

    +

    Restoration target

    +
    +
    +
  • Parameter description of field restore_target +
    + + + + + + + + + + + + + +
    Table 10 Parameter description of field restore_target

    Parameter

    +

    Type

    +

    Description

    +

    server_id

    +

    String

    +

    ID of the ECS to be restored

    +

    volumes

    +

    List<restore_volume_mapping>

    +

    List of the mappings between disk backups and target disks

    +
    +
    +
  • Parameter description of field restore_volume_mapping +
    + + + + + + + + + + + + + +
    Table 11 Parameter description of field restore_volume_mapping

    Parameter

    +

    Type

    +

    Description

    +

    backup_id

    +

    String

    +

    Disk backup ID

    +

    volume_id

    +

    String

    +

    ID of the disk to which data is restored

    +
    +
    +
  • Example response
    {
+  "restore" : {
+    "restore_target" : "http://192.168.1.2:35357/v2.0/",
+    "status" : "in_progress",
+    "provider_id" : "fc4d5750-22e7-4798-8a46-f48f62c4c1da",
+    "resources_status" : in_progress,
+    "parameters" : {
+      "power_on" : true,
+      "targets" : {
+        "server_id" : "f45c477a-57e5-465f-999f-d845083962db",
+        "volumes" : [ {
+          "backup_id" : "bc118c24-3234-4afd-8423-d66d3d677649",
+          "volume_id" : "ee27f809-6fb5-40ae-ac46-c932bb4ee8fe"
+        } ]
+      },
+      "checkpoint_item_id" : "504b7d59-c361-411f-9ed3-814f35d08e3d"
+    },
+    "checkpoint_id" : "a2b9fb53-2770-4fcd-9bad-6cadd56e6c09",
+    "project_id" : "b942cc8342734d15bcb246babb1953cf",
+    "id" : "d3a54e80-6483-485d-98f6-c0409e6f2e0a",
+    "resources_reason" : { }
+  }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Restoration Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304238.html b/docs/csbs/api-ref/en-us_topic_0059304238.html new file mode 100644 index 000000000..98230c490 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304238.html @@ -0,0 +1,15 @@ + + +

Quota Management

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0059304243.html b/docs/csbs/api-ref/en-us_topic_0059304243.html new file mode 100644 index 000000000..f39c2a49d --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0059304243.html @@ -0,0 +1,199 @@ + + +

Querying Quotas

+

Function

This API is used to query tenant quotas.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/quotas

    +
  • Parameter description +
    + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description

    None

    +
+
  • Example request
    GET https://{endpoint}/v1/{project_id}/quotas
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    quotas

    +

    quota

    +

    See the quota field description.

    +
    +
    +
  • Parameter description of field quota +
    + + + + + + + + + +
    Table 3 Parameter description of field quota

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    List<resource_resp>

    +

    Quota resources

    +
    +
    +
  • Parameter description of field resource_resp +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field resource_resp

    Parameter

    +

    Type

    +

    Description

    +

    unit

    +

    String

    +

    Unit

    +

    used

    +

    Integer

    +

    Used quota

    +

    quota

    +

    Integer

    +

    Quota size

    +

    type

    +

    String

    +

    Type

    +

    backup_capacity specifies the backup storage capacity quota. Value -1 indicates no restriction on the quota size.

    +

    backups specifies the number of retained backups.

    +
    +
    +
  • Example response
    {
+  "quotas" : {
+    "resources" : [{
+      "type" : "backup_capacity",
+      "unit" : "GB",
+      "quota" : -1,
+      "used" : 0
+    },
+    {
+        "used": 0,
+        "type": "backups",
+        "quota": 600
+    }]
+  }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid request parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    No operation permission.

    +

    404

    +

    Requested object not found.

    +

    500

    +

    Service internal error.

    +

    503

    +

    Service unavailable.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0061309751.html b/docs/csbs/api-ref/en-us_topic_0061309751.html new file mode 100644 index 000000000..c5eb6361f --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0061309751.html @@ -0,0 +1,8 @@ + + +

API Usage Guidelines

+

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 Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0071888296.html b/docs/csbs/api-ref/en-us_topic_0071888296.html new file mode 100644 index 000000000..43e825d5a --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0071888296.html @@ -0,0 +1,13 @@ + + +

Appendixes

+
+
+ +
+ diff --git a/docs/csbs/api-ref/en-us_topic_0071888297.html b/docs/csbs/api-ref/en-us_topic_0071888297.html new file mode 100644 index 000000000..7639ec3a7 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0071888297.html @@ -0,0 +1,606 @@ + + +

Error Codes

+

An example response error is returned as follows:

+
{
+  "error_code": xxxx,//Error code
+  "error_msg": xxxxx//Error message
+}
+

Table 1 describes the error codes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Error code description

Status Code

+

Error Code

+

Error Message

+

Description

+

Solution

+

400

+

CSBS.0001

+

Service over limit

+

The number of backup policies has reached the upper limit.

+

Delete an existing backup policy and try again.

+

400

+

CSBS.6000

+

server do not exist

+

The server does not exist.

+

Check whether the server exists.

+

400

+

CSBS.6001

+

The server has stopped.

+

The server has stopped.

+

Check whether the server has stopped.

+

400

+

CSBS.6003

+

Resource (%s) type (%s) is not support protection.

+

Currently, only cloud server backup is supported.

+

Select servers and add them to the backup policy.

+

400

+

CSBS.6005

+

Server (%s) is already in service.

+

The current server status does not allow backup.

+

Ensure that the server status allows restoration and try again.

+

400

+

CSBS.6006

+

Server (%s) status (%s) is not allowed to protect.

+

This type of server does not support backup.

+

Select servers of a correct type.

+

400

+

CSBS.6007

+

No volume attached to the server (%s) for protect.

+

Servers without EVS disks do not support backup.

+

Check whether an EVS disk is attached to the server.

+

400

+

CSBS.6010

+

Volume (%s) attached to server (%s) is shareable volume.

+

The server does not support backup, because it hosts shared EVS disks.

+

Remove the shared disk and perform the backup again.

+

400

+

CSBS.6013

+

Resource (%s) type (%s) is not support restoration.

+

Only server restoration is supported currently.

+

Select servers for restoration.

+

400

+

CSBS.6014

+

Volume(s) (%s) not found in target server.

+

The specified EVS disk is not attached to the server to be restored.

+

Select an EVS disk attached to the server to be restored.

+

400

+

CSBS.6015

+

The server is restoring.

+

The server in the current status cannot be restored.

+

Ensure that the server status allows restoration and try again.

+

400

+

CSBS.9001

+

provider invalid

+

Parameter verification failed.

+

Enter the correct parameter.

+

403

+

CSBS.9009

+

User is unverified.

+

The user is not authenticated by real name. Authenticate the user's real name and try again.

+

Authenticate the user's real name and try again.

+

400

+

CSBS.9009

+

The backup or replication space after reduction cannot be less than the used space.

+

The backup or replication space after applying for reduction is less than the used space.

+

Ensure that the remaining space is greater than the used space.

+

500

+

CSBS.9998

+

System not support

+

Service unavailable

+

Try later or contact technical support.

+

500

+

CSBS.9999

+

%s failed

+

System internal error

+

Try later or contact technical support.

+

400

+

CSBS.0002

+

Volume of services from different storagetype

+

The volumes of the server have different storage types. (Not used currently.)

+

Use the same type of volumes.

+

500

+

CSBS.1001

+

The policy is executing backup.

+

The backup task cannot be executed, because a manual backup task is being executed.

+

Re-execute the backup task after the manual backup task is complete.

+

400

+

CSBS.2003

+

item in executing

+

The selected backup is in the Backing up, Restoring, or Deleting state.

+

Try again after the task is complete.

+

400

+

CSBS.2004

+

item in plan executing

+

The policy is being executed for backup. Try again after the backup is complete.

+

Try again after the task is complete.

+

404

+

CSBS.3001

+

Checkpoint_item (%s) is not found.

+

The backup does not exist.

+

Check whether the backup exists.

+

400

+

CSBS.6027

+

The AZ where the resource (%s) is located does not support backup.

+

The AZ to which the ECS belongs does not support backup.

+

Contact the administrator to reconfigure the AZ.

+

500

+

CSBS.6030

+

auto plan executing

+

The backup task cannot be executed, because an automatic backup task is being executed.

+

Re-execute the backup task after the automatic backup task is complete.

+

400

+

CSBS.6031

+

manual copy executing

+

The replication task cannot be executed, because a manual replication task is being executed.

+

Re-execute the replication task after the manual replication task is complete.

+

500

+

CSBS.6032

+

plan has no resource backup

+

There are no servers that can be backed up in the backup policy.

+

Bind the policy to servers or wait until the bound server is restored to a state that supports backup.

+

400

+

CSBS.6033

+

Service type of volume %s(belong to server %s) is dss.

+

A server with DSS disks cannot be backed up.

+

Check whether a dedicated storage disk has been attached to the server.

+

400

+

CSBS.6061

+

volume of server in this pod does not support backup

+

The current server does not support backup or restoration.

+

Deselect the disks that do not support backup and retry.

+

500

+

CSBS.8001

+

The backup status is not allowed to create image

+

Backups in the current status cannot be registered as images.

+

Try later or contact technical support.

+

400

+

CSBS.8007

+

The backup {checkpoint_item_id} has register to image, can't be delete

+

An image has been created by using the backup and the backup cannot be deleted.

+

Delete the created image first and then the backup.

+

500

+

CSBS.8008

+

The backup {checkpoint_item_id}'s status is not allowed query

+

The current backup status does not support query.

+

Check whether the backup exists.

+

500

+

CSBS.8009

+

The backup has not system disk backup is not allowed to create image

+

The backup does not contain the system disk data and cannot be used to create an image.

+

Check whether the backup contains a system disk.

+

400

+

CSBS.9006

+

Quota exceeded for resources: %s

+

Insufficient quota

+

Contact the administrator to change the quota or delete the backups that are no longer needed.

+

500

+

CSBS.1002

+

resource_in_protecting

+

The selected server is being backed up. (Not used currently.)

+

Try again after the backup task is complete.

+

500

+

CSBS.2001

+

item in plan is executing

+

A task is being executed by using this backup policy. (Not used currently.)

+

Try again after the task is complete.

+

404

+

CSBS.3000

+

plan not found

+

The backup policy does not exist.

+

Check whether the backup policy exists.

+

500

+

CSBS.5001

+

Scheduel operation status can't be set unable

+

Failed to stop the policy.

+

Check the backup policy status.

+

400

+

CSBS.6004

+

Server (%s) is already in service.

+

The server has been bound to a backup policy and cannot be bound again.

+

Check whether the server has been bound to a backup policy.

+

400

+

CSBS.9007

+

duplicate service name

+

The backup policy name already exists.

+

Change the name and try again.

+

400

+

CSBS.7000

+

request tags exceed the max allowed count: %s.

+

The resource's tags have reached the upper limit.

+

Delete unnecessary tags and try again.

+

404

+

CSBS.7001

+

The backup tag does not exist.

+

The resource tag to be deleted does not exist.

+

Refresh the page to check whether the tag has been deleted.

+

400

+

CSBS.4000

+

checkpoint item not available

+

The current backup status does not allow restoration.

+

Try again later or contact technical support.

+

400

+

CSBS.6016

+

can not restore server type is not allow

+

This type of server does not support restoration.

+

Select servers of a correct type.

+

400

+

CSBS.6017

+

Can not find backup(s) (%s) in checkpoint item (%s).

+

The specified backup disk is not in the specified backup.

+

Select a backup disk in the specified backup for restoration.

+

400

+

CSBS.6018

+

Not assign backup(s) (%s) to volume(s), partial restore is not supported."

+

The system does not support the restoration of some backup disks in the backup.

+

Select all backup disks in the backup for restoration.

+

500

+

CSBS.6019

+

The source server (%s) type (%s) is not the same as the target server (%s) type (%s).

+

The type of the target server is different from that of the source server.

+

Select a target server of the same type as the source server.

+

400

+

CSBS.6020

+

No volume attached to the server (%s) for restore.

+

Servers without EVS disks do not support restoration.

+

Check whether an EVS disk is attached to the server.

+

400

+

CSBS.6021

+

Volume (%s) attached to server (%s) is shareable volume.

+

The backup cannot be restored to a shared EVS disk of the server.

+

Restore the backup to a non-shared EVS disk of the server.

+

500

+

CSBS.6023

+

Can not restore data volume to system volume. server id is (%s).

+

The backup for a data disk cannot be restored to a system disk of the server.

+

Restore the backup to a data disk of the server.

+

400

+

CSBS.6024

+

Target volume (%s) size (%s) small than volume backup (%s) size (%s).

+

Restoration cannot be executed because the size of the disk attached to the server is smaller than the backup size.

+

Expand the disk and try again, or restore backup data to a disk that has a larger size than the backup.

+

400

+

CSBS.6025

+

The AZ of local checkpoint item (%s) is not support to restore the resource (%s).

+

Restoration is not supported between the AZ to which the specified backup belongs and the AZ to which the server belongs.

+

Contact the administrator to reconfigure the AZ.

+

400

+

CSBS.9008

+

Checkpoint Item Status Not Support Create VM

+

Only backups in the Available state can be used to create ECSs.

+

Check whether the backup is available.

+

404

+

CSBS.6040

+

task not found

+

The backup job to be deleted does not exist.

+

Check whether the backup job exists.

+
+
+

Karbor native APIs:

+

http://developer.openstack.org/api-ref/data-protection-orchestration/v1/index.html

+
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0071888298.html b/docs/csbs/api-ref/en-us_topic_0071888298.html new file mode 100644 index 000000000..5b88369ea --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0071888298.html @@ -0,0 +1,127 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Release Date

+

What's New

+

2022-08-19

+

Updated the following content:

+

Optimized some descriptions in this document.

+

2021-08-30

+

Updated the following content:

+

Deleted the parameters field and the table that describes the policy_param field from section "Updating a Backup Policy."

+

2021-07-21

+

Updated the following content:

+

Deleted the description of parameter app_consistency.

+

2020-03-06

+

Updated the following content:

+

Optimized the descriptions of parameters day_backups, week_backups, month_backups, and year_backups in section "Creating a Backup Policy."

+

2020-03-05

+

Updated the following content:

+
  • Modified the example request in section "Creating a Backup Policy."
  • Added the descriptions of parameters day_backups, week_backups, month_backups, and year_backups in section "Creating a Backup Policy."
+

2020-02-17

+

Updated the following content:

+
  • Modified the description of parameter provider_id.
  • Modified the description of parameter resource_id in section "Creating a Resource Backup."
  • Modified the descriptions of parameters max_backups and retention_duration_days in section "Updating a Backup Policy."
  • Modified the descriptions in section "Deleting a Backup."
+

2020-02-11

+

Updated the following content:

+
  • Modified the table formats and table titles.
  • Modified the parameter description and examples in section "Creating a Resource Backup."
  • Modified the parameter description in section "Querying Backup Capabilities of Resources."
  • Modified the parameter description in section "Querying Restoration Capabilities of Resources."
  • Modified the parameter description in section "Creating a Backup Policy."
  • Modified the parameter description in section "Updating a Backup Policy."
  • Modified the examples in section "Querying Backup Resource Instances."
+

2019-02-12

+

Updated the following content:

+

Modified the description of the enabled parameter in section "Creating a Backup Policy."

+

2019-02-02

+

Updated the following content:

+

Changed the enabled parameter in section "Creating a Backup Policy" to mandatory and modified the parameter description.

+

2018-10-15

+

Updated the following content:

+
  • Added the incremental parameter in section "Creating a Resource Backup".
  • Removed content about BMS backups.
  • Added the description of parameters max_backups, retention_duration_days, and permanent in sections "Creating a Backup Policy" and "Updating a Backup Policy".
+

2018-09-07

+

Accepted in OTC-3.2.

+

2018-08-15

+

Updated the following content:

+

Modified the description of the pattern parameter.

+

2018-07-30

+

Updated the following content:

+

Added fields related to BMS backup.

+

2018-06-26

+

Updated the following content:

+
  • Added description of image-related fields.
  • Modified the naming rules for tag keys and tag values.
  • Accepted in OTC 3.1.
+

2018-05-03

+

Updated the following content:

+

Deleted the former sections 1 API Calling and 2 Common Message Headers, and added section 1 API Usage Guidelines.

+

2018-03-30

+

Updated the following content:

+

Added APIs related to tag management.

+

2018-01-23

+

Updated the following content:

+
  • Some ease-of-use issues are resolved.
  • Added the support for specifying the backup interval in units of days.
+

2017-09-08

+

Updated the following content:

+

Some ease-of-use issues are resolved.

+

2017-07-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098466174.html b/docs/csbs/api-ref/en-us_topic_0098466174.html new file mode 100644 index 000000000..2d1cf09e6 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098466174.html @@ -0,0 +1,37 @@ + + +

Tag Management

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635086.html b/docs/csbs/api-ref/en-us_topic_0098635086.html new file mode 100644 index 000000000..19730d66a --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635086.html @@ -0,0 +1,1021 @@ + + +

Querying Backup Resources by Tag

+

Function

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 query capabilities.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/csbs_backup/resource_instances/action

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    No

    +

    List<tag>

    +

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

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 keys.

    +

    Keys in this list must be unique.

    +

    Keys 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.

    +

    tags_any

    +

    No

    +

    List<tag>

    +

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

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 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.

    +

    not_tags

    +

    No

    +

    List<tag>

    +

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

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 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.

    +

    not_tags_any

    +

    No

    +

    List<tag>

    +

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

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 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.

    +

    limit

    +

    No

    +

    String

    +

    Query count (This parameter is not displayed if action is set to count.)

    +

    If action is set to filter, the value defaults to 1000. The value ranges from 1 to 1000. If you set a value out of this range, an error will be reported. The number of returned records does not exceed the value of limit.

    +

    offset

    +

    No

    +

    String

    +

    Query index (This parameter is not displayed if action is set to count.)

    +

    If action is set to filter, the value defaults to 0 (minimum value). The first record in the query result is the offset+1 record that meets the query criteria.

    +

    action

    +

    Yes

    +

    String

    +

    Operation type

    +

    Possible values are filter and count.

    +

    filter indicates pagination query and count indicates that a specified number of queried records will be returned.

    +

    matches

    +

    No

    +

    List<match>

    +

    List of query criteria supported by resources

    +

    This list cannot be an empty list.

    +

    Keys in this list must be unique.

    +
    +
    +
  • Parameter description of field tag +
    + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    A tag key consists of up to 127 characters.

    +

    A tag key cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

    values

    +

    Yes

    +

    List<String>

    +

    List of tag values

    +

    The list can contain up to 10 values.

    +

    A tag value consists of up to 255 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.

    +
    +
    +
  • Parameter description of field match +
    + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field match

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    Possible values are:

    +

    resource_name: indicates the resource name.

    +

    value

    +

    Yes

    +

    String

    +

    Tag value

    +

    A tag value consists of up to 255 characters.

    +

    If key is set to resource_name, an empty character string indicates exact matching and any non-empty string indicates fuzzy matching.

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/csbs_backup/resource_instances/action
    +
+
  • When action is set to filter:
    {
+    "offset": "100",
+    "limit": "100",
+    "action": "filter",
+    "matches": [{
+            "key": "resource_name",
+            "value": "resource1"
+        }
+    ],
+    "not_tags": [{
+            "key": "key1",
+            "values": [
+                "*value1",
+                "value2"
+            ]
+        }
+    ],
+    "tags": [{
+            "key": "key1",
+            "values": [
+                "*value1",
+                "value2"
+            ]
+        }
+    ],
+    "tags_any": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "not_tags_any": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ]
+}
    +
+
  • When action is set to count:
    {
+    "action": "count",
+    "not_tags": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "*value2"
+            ]
+        }
+    ],
+    "tags": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "tags_any": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "not_tags_any": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "matches": [{
+            "key": "resource_name",
+            "value": "resource1"
+        }
+    ]
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +
    Table 6 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    List<resource>

    +

    List of matched resources (This parameter is not displayed if action is set to count.)

    +

    total_count

    +

    Integer

    +

    Total number of matched resources

    +
    +
    +
+
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field resource

    Parameter

    +

    Type

    +

    Description

    +

    resource_id

    +

    String

    +

    Resource ID

    +

    resource_detail

    +

    Object

    +

    Resource details

    +

    Backup details, including tags

    +

    tags

    +

    List<resource_tag>

    +

    Tag list

    +

    resource_name

    +

    String

    +

    Resource name

    +
    +
    +
  • Parameter description of field resource_detail +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 8 Parameter description of field resource_detail

    Parameter

    +

    Type

    +

    Description

    +

    checkpoint_id

    +

    String

    +

    Backup record ID

    +

    created_at

    +

    String

    +

    Creation time, for example, 2017-04-18T01:21:52.701973

    +

    extend_info

    +

    Dict

    +

    Extension information

    +

    id

    +

    String

    +

    Backup ID

    +

    name

    +

    String

    +

    Backup name

    +

    resource_id

    +

    String

    +

    Backup object ID

    +

    status

    +

    String

    +

    Backup status

    +

    Value range: waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting, and deleted

    +

    updated_at

    +

    String

    +

    Modification time, for example, 2017-04-18T01:21:52.701973

    +

    backup_data

    +

    Dict

    +

    VM metadata

    +

    description

    +

    string

    +

    Backup description

    +

    tags

    +

    List<resource_tag>

    +

    Tag list

    +

    resource_type

    +

    String

    +

    Backup object type

    +
    +
    +
  • Parameter description of field extend_info +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 9 Parameter description of field extend_info

    Parameter

    +

    Type

    +

    Description

    +

    auto_trigger

    +

    Boolean

    +

    Whether automatic trigger is enabled

    +

    average_speed

    +

    Integer

    +

    Average speed

    +

    copy_from

    +

    String

    +

    This parameter is left blank by default.

    +

    copy_status

    +

    String

    +

    This parameter is left blank by default.

    +

    fail_code

    +

    fail_code

    +

    Error code

    +

    fail_op

    +

    String

    +

    Type of the failed operation

    +

    Enum: [backup, restore, delete, verify, copy]

    +

    fail_reason

    +

    String

    +

    Description of the failure cause

    +

    image_type

    +

    String

    +

    Backup type

    +

    incremental

    +

    Boolean

    +

    Whether incremental backup is used

    +

    progress

    +

    Integer

    +

    Backup progress. The value is an integer ranging from 0 to 100.

    +

    resource_az

    +

    String

    +

    AZ to which the backup resource belongs

    +

    resource_name

    +

    String

    +

    Backup object name

    +

    resource_type

    +

    String

    +

    Backup object type

    +

    size

    +

    Integer

    +

    Backup capacity

    +

    space_saving_ratio

    +

    Integer

    +

    Space saving rate

    +

    volume_backups

    +

    List<volume_backup>

    +

    Disk backup list

    +

    finished_at

    +

    String

    +

    Backup completion time, for example, 2017-04-18T01:21:52.701973

    +

    supported_restore_mode

    +

    String

    +

    Restoration mode. Possible values are na, snapshot, and backup.

    +

    snapshot: Data is restored from snapshots of the disks of the server.

    +

    backup: Data is restored from backups of the disks of the server.

    +

    na: Restoration is not supported.

    +

    tags

    +

    List<resource_tag>

    +

    Tag list

    +
    +
    +
  • Parameter description of field backup_data +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 10 Parameter description of field backup_data

    Parameter

    +

    Type

    +

    Description

    +

    __openstack_region_name

    +

    String

    +

    Name of the AZ where the ECS resides

    +

    cloudservicetype

    +

    String

    +

    ECS type

    +

    disk

    +

    String

    +

    System disk size corresponding to the ECS specifications

    +

    imagetype

    +

    String

    +

    Image type. Possible values are gold (public image), private (private image), and market (market image).

    +

    Enum: [gold, private, market]

    +

    ram

    +

    String

    +

    Memory size of the ECS, in MB

    +

    vcpus

    +

    String

    +

    CPU cores corresponding to the ECS

    +

    eip

    +

    String

    +

    Elastic IP address of the ECS

    +

    private_ip

    +

    String

    +

    Internal IP address of the ECS

    +
    +
    +
  • Parameter description of field image_data +
    + + + + + + + + + +
    Table 11 Parameter description of field image_data

    Parameter

    +

    Type

    +

    Description

    +

    image_id

    +

    String

    +

    Image ID

    +
    +
    +
  • Parameter description of field fail_code +
    + + + + + + + + + + + + + +
    Table 12 Parameter description of field fail_code

    Parameter

    +

    Type

    +

    Description

    +

    Code

    +

    Long

    +

    Error code

    +

    Description

    +

    String

    +

    Error description

    +
    +
    +
  • Parameter description of field volume_backup +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 13 Parameter description of field volume_backup

    Parameter

    +

    Type

    +

    Description

    +

    average_speed

    +

    Integer

    +

    Average speed

    +

    bootable

    +

    Boolean

    +

    Whether the disk functions as a system disk

    +

    id

    +

    String

    +

    Cinder backup ID

    +

    image_type

    +

    String

    +

    Backup set type

    +

    Enum:[ backup]

    +

    incremental

    +

    Boolean

    +

    Whether incremental backup is used

    +

    name

    +

    String

    +

    Disk backup name

    +

    size

    +

    Integer

    +

    Accumulated size (MB) of backups

    +

    source_volume_id

    +

    String

    +

    Source disk ID

    +

    source_volume_size

    +

    Integer

    +

    Source disk size in GB

    +

    space_saving_ratio

    +

    Integer

    +

    Space saving rate

    +

    status

    +

    String

    +

    Status

    +

    source_volume_name

    +

    String

    +

    Source disk name

    +

    snapshot_id

    +

    String

    +

    ID of the snapshot from which the backup is generated

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + +
    Table 14 Parameter description of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    value

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +

    +
    +
    +
  • Example response

    When action is set to filter:

    +
    {
+    "status":"aviable",
+    "backup_data":{
+        "eip":"",
+        "cloudservicetype":"QEMU",
+        "ram":1024,
+        "__openstack_region_name":"",
+        "vcpus":1,
+        "private_ip":"",
+        "disk":0,
+        "imagetype":"gold"
+    },
+    "periodic_type":null,
+    "name":"manualbk_ea67",
+    "resource_id":"58482e0b-a357-4125-bdad-102f796b0e0c",
+    "created_at":"2020-02-11T06:34:43.897750",
+    "checkpoint_id":"ee45c782-71f8-4265-8392-e31fc701836c",
+    "replication_records":[
+ 
+    ],
+    "updated_at":"2020-02-11T06:38:29.765609",
+    "protected_at":"2020-02-11T06:30:26.000000",
+    "tags":[
+ 
+    ],
+    "extend_info":{
+        "auto_trigger":false,
+        "finished_at":"2020-02-11T06:38:29.748932",
+        "volume_backups":[
+ 
+        ],
+        "incremental":true,
+        "copy_from":null,
+        "dec_size":0,
+        "size":0,
+        "resource_az":"br-iaas-odin1b",
+        "copy_status":"na",
+        "image_type":"backup",
+        "average_speed":0,
+        "taskid":"e9c97c75-59fa-4b99-8b4b-1dd991dbba33",
+        "progress":8,
+        "resource_type":"OS::Nova::Server"
+    },
+    "progress":null,
+    "expired_at":null,
+    "id":"a6d04e0e-0121-41d1-8371-eaeab14482f8",
+    "resource_type":"OS::Nova::Server",
+    "description":"--"
+}
    +
    When action is set to count:
    {
+    total_count": 1000
+}
    +
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635087.html b/docs/csbs/api-ref/en-us_topic_0098635087.html new file mode 100644 index 000000000..3b6bd7835 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635087.html @@ -0,0 +1,262 @@ + + +

Batch Adding or Removing Tags of a Backup Resource

+

Function

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 idempotent.

+

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

+

If the key of the to-be-created tag is the same as that of an existing tag, the value of the existing tag will be overwritten.

+

When deleting tags, you can upload duplicate keys.

+

When tags are being deleted and some tags do not exist, the operation is considered successful by default, and the character set of the tags will not be checked upon deletion. A key and a value can respectively consist of up to 127 and 255 characters. The tag structure cannot be missing, and the key cannot be left blank or an empty string.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/csbs_backup/{resource_id}/tags/action

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    resource_id

    +

    Yes

    +

    String

    +

    Resource ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    Yes

    +

    List<resource_tag>

    +

    Tag list

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 keys.

    +

    Keys in this list must be unique.

    +

    action

    +

    Yes

    +

    String

    +

    Operation to be performed. The value can be set to create or delete only.

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field resource_tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key (when action is set to create)

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

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

    +

    Tag key (when action is set to delete)

    +

    It consists of up to 127 characters.

    +

    It cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

    value

    +

    Yes

    +

    String

    +

    Tag value (when action is set to create)

    +

    This parameter is mandatory.

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

    Spaces before and after a tag value will be deprecated.

    +

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

    +

    Tag value (when action is set to delete)

    +

    The tag value can be passed or not.

    +

    It consists of up to 255 characters.

    +

    It can be an empty string.

    +

    Spaces before and after a tag value will be deprecated.

    +

    If the value is not passed, the tag is located and deleted based on the key and value. If the value is passed, the tag is located and deleted based on the key.

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/csbs_backup/{resource_id}/tags/action
    +
+
  • Request body
    {
+    "action": "create",
+    "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key",
+            "value": "value3"
+        }
+    ]
+}
+or
+{
+    "action": "delete",
+    "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key2",
+            "value": "value3"
+        }
+    ]
+}
+
    +
+
+

Response

  • Parameter description
+

None

+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    204

    +

    No Content

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid action.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635088.html b/docs/csbs/api-ref/en-us_topic_0098635088.html new file mode 100644 index 000000000..f82abb859 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635088.html @@ -0,0 +1,210 @@ + + +

Adding a Tag to a Backup Resource

+

Function

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.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/csbs_backup/{resource_id}/tags

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    resource_id

    +

    Yes

    +

    String

    +

    Resource ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tag

    +

    Yes

    +

    tag

    +

    List of tags

    +
    +
    +
  • Parameter description of field tag +
    + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

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

    +

    value

    +

    Yes

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

    Spaces before and after a tag value will be deprecated.

    +

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

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/csbs_backup/{resource_id}/tags
    +
+
  • Example request
    {
+    "tag":
+    {
+        "key":"DEV",
+        "value":"DEV1"
+    }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    204

    +

    No Content

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid action.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635089.html b/docs/csbs/api-ref/en-us_topic_0098635089.html new file mode 100644 index 000000000..eb545aa1a --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635089.html @@ -0,0 +1,152 @@ + + +

Removing a Tag from a Backup Resource

+

Function

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

  • URI format

    DELETE https://{endpoint}/v1/{project_id}/csbs_backup/{resource_id}/tags/{key}

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    resource_id

    +

    Yes

    +

    String

    +

    Resource ID

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    A tag key consists of up to 127 characters.

    +

    A tag key cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

    It cannot contain the following characters: ASCII (0-31), asterisks (*), less-than signs (<), greater-than signs (>), backslashes (\), equal signs (=), commas (,), vertical bars (|), and slashes (/).

    +

    (The code only verifies whether the key is an empty character string, instead of the length and character set. Keys are checked and used after deleting the spaces before and after them. Even invalid tags existing at the bottom layer can be deleted.)

    +
    +
    +
+
+

Request

  • Example request
    DELETE https://{endpoint}/v1/{project_id}/csbs_backup/{resource_id}/tags/{key}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    204

    +

    No Content

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635090.html b/docs/csbs/api-ref/en-us_topic_0098635090.html new file mode 100644 index 000000000..91db70530 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635090.html @@ -0,0 +1,206 @@ + + +

Querying Tags of a Backup Resource

+

Function

This API is used to query tags of a specific resource.

+

TMS uses this API to query all tags of a specific resource.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/csbs_backup/{resource_id}/tags

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    resource_id

    +

    Yes

    +

    String

    +

    Resource ID

    +
    +
    +
+
+

Request

  • Parameter description

    None

    +
+
  • Example request
    GET https://{endpoint}/v1/{project_id}/csbs_backup/{resource_id}/tags
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    List<resource_tag>

    +

    Tag list

    +

    Keys in the tag list must be unique.

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + +
    Table 4 Parameter description of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    value

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response
    {
+       "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key2",
+            "value": "value3"
+        }
+    ]
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635091.html b/docs/csbs/api-ref/en-us_topic_0098635091.html new file mode 100644 index 000000000..e060f497e --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635091.html @@ -0,0 +1,203 @@ + + +

Querying Backup Tags of a Project

+

Function

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 creation and resource filtering on the console.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/csbs_backup/tags

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description

    None

    +
+
  • Example request
    GET https://{endpoint}/v1/{project_id}/csbs_backup/tags
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    List<tag>

    +

    Tag list

    +

    Keys in the tag list must be unique.

    +
    +
    +
  • Parameter description of field tag +
    + + + + + + + + + + + + + +
    Table 4 Parameter description of field tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    values

    +

    List<String>

    +

    List of tag values

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response
    {
+      "tags": [
+        {
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+             ]
+        },
+        {
+            "key": "key2",
+            "values": [
+                "value1",
+                "value2"
+             ]
+        }
+    ]
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635092.html b/docs/csbs/api-ref/en-us_topic_0098635092.html new file mode 100644 index 000000000..fe37b64ee --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635092.html @@ -0,0 +1,523 @@ + + +

Querying Backup Policies by Tag

+

Function

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.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/csbs_backup_policy/resource_instances/action

    +

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    No

    +

    List<tag>

    +

    List of included tags. Backup resources with these tags will be filtered.

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 keys.

    +

    Keys in this list must be unique.

    +

    Keys in this list are in an AND relationship.

    +

    tags_any

    +

    No

    +

    List<tag>

    +

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

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 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.

    +

    not_tags

    +

    No

    +

    List<tag>

    +

    List of excluded tags. Backup resources without these tags will be filtered.

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 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.

    +

    not_tags_any

    +

    No

    +

    List<tag>

    +

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

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 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.

    +

    action

    +

    Yes

    +

    String

    +

    Operation type

    +

    Possible values are filter and count.

    +

    filter indicates pagination query and count indicates that a specified number of queried records will be returned.

    +

    matches

    +

    No

    +

    List<match>

    +

    List of query criteria supported by resources

    +

    This list cannot be an empty list.

    +

    Keys in this list must be unique.

    +

    limit

    +

    No

    +

    String

    +

    Query count (This parameter is not displayed if action is set to count.)

    +

    If action is set to filter, the value defaults to 1000. The value ranges from 1 to 1000. If you set a value out of this range, an error will be reported. The number of returned records does not exceed the value of limit.

    +

    offset

    +

    No

    +

    String

    +

    Query index (This parameter is not displayed if action is set to count.)

    +

    If action is set to filter, the value defaults to 0 (minimum value). The first record in the query result is the offset+1 record that meets the query criteria.

    +
    +
    +
  • Parameter description of field tag +
    + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    A tag key consists of up to 127 characters.

    +

    A tag key cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

    values

    +

    Yes

    +

    List<String>

    +

    List of tag values

    +

    The list can contain up to 10 values.

    +

    A tag value consists of up to 255 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.

    +
    +
    +
  • Parameter description of field match +
    + + + + + + + + + + + + + + + + +
    Table 5 Parameter description of field match

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    Possible values are:

    +

    resource_name: indicates the resource name.

    +

    value

    +

    Yes

    +

    String

    +

    Tag value

    +

    A tag value consists of up to 255 characters.

    +

    If key is set to resource_name, an empty character string indicates exact matching and any non-empty string indicates fuzzy matching.

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/csbs_backup_policy/resource_instances/action
    +
+
  • When action is set to filter:
    {
+    "offset": "100",
+    "limit": "100",
+    "action": "filter",
+    "matches": [{
+            "key": "resource_name",
+            "value": "resource1"
+        }
+    ],
+    "not_tags": [{
+            "key": "key1",
+            "values": [
+                "*value1",
+                "value2"
+            ]
+        }
+    ],
+    "tags": [{
+            "key": "key1",
+            "values": [
+                "*value1",
+                "value2"
+            ]
+        }
+    ],
+    "tags_any": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "not_tags_any": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ]
+}
    +
+
  • When action is set to count:
    {
+    "action": "count",
+    "not_tags": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "*value2"
+            ]
+        }
+    ],
+    "tags": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "tags_any": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "not_tags_any": [{
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "matches": [{
+            "key": "resource_name",
+            "value": "resource1"
+        }
+    ]
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +
    Table 6 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    List<resource>

    +

    List of matched resources (This parameter is not displayed if action is set to count.)

    +

    total_count

    +

    Integer

    +

    Total number of matched resources

    +
    +
    +
+
  • Parameter description of field resource +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 7 Parameter description of field resource

    Parameter

    +

    Type

    +

    Description

    +

    resource_id

    +

    String

    +

    Resource ID

    +

    resource_detail

    +

    Object

    +

    Resource details

    +

    The returned value is an empty dictionary.

    +

    tags

    +

    List<resource_tag>

    +

    Tag list

    +

    resource_name

    +

    String

    +

    Resource name

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + +
    Table 8 Parameter description of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    value

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response

    When action is set to filter:

    +
    {
+    "resources": [
+        {
+            "resource_detail": {}, 
+            "resource_id": "cdfs_cefs_wesas_12_dsad", 
+            "resource_name": "resouece1", 
+            "tags": [
+                {
+                   "key": "key1",
+                   "value": "value1"
+                }
+             ]
+         }
+    ], 
+    "total_count": 1000
+}
    +

    When action is set to count:

    +
    {
+       "total_count": 1000
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635093.html b/docs/csbs/api-ref/en-us_topic_0098635093.html new file mode 100644 index 000000000..314bfc19e --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635093.html @@ -0,0 +1,260 @@ + + +

Batch Adding or Removing Tags of a Backup Policy

+

Function

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 idempotent.

+

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

+

If the key of the to-be-created tag is the same as that of an existing tag, the value of the existing tag will be overwritten.

+

When tags are being deleted and some tags do not exist, the operation is considered successful by default, and the character set of the tags will not be checked upon deletion. A key and a value can respectively consist of up to 127 and 255 characters. The tag structure cannot be missing, and the key cannot be left blank or an empty string.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags/action

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    resource_id

    +

    Yes

    +

    String

    +

    Resource ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    Yes

    +

    List<resource_tag>

    +

    Tag list

    +

    This list cannot be an empty list.

    +

    The list can contain up to 10 keys.

    +

    Keys in this list must be unique.

    +

    action

    +

    Yes

    +

    String

    +

    Operation to be performed. The value can be set to create or delete only.

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field resource_tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key (when action is set to create)

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

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

    +

    Tag key (when action is set to delete)

    +

    It consists of up to 127 characters.

    +

    It cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

    value

    +

    No

    +

    String

    +

    Tag value (when action is set to create)

    +

    This parameter is mandatory.

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

    Spaces before and after a tag value will be deprecated.

    +

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

    +

    Tag value (when action is set to delete)

    +

    The tag value can be passed or not.

    +

    It consists of up to 255 characters.

    +

    It can be an empty string.

    +

    Spaces before and after a tag value will be deprecated.

    +

    If the value is not passed, the tag is located and deleted based on the key and value. If the value is passed, the tag is located and deleted based on the key.

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags/action
    +
+
  • Request body
    {
+    "action": "create",
+    "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key",
+            "value": "value3"
+        }
+    ]
+}
+or
+{
+    "action": "delete",
+    "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key2",
+            "value": "value3"
+        }
+    ]
+}
    +
+
+

Response

  • Parameter description
+

None

+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    204

    +

    No Content

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid action.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635094.html b/docs/csbs/api-ref/en-us_topic_0098635094.html new file mode 100644 index 000000000..f2d06aba5 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635094.html @@ -0,0 +1,211 @@ + + +

Adding a Tag to a Backup Policy

+

Function

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.

+
+

URI

  • URI format

    POST https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags

    +

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    resource_id

    +

    Yes

    +

    String

    +

    Resource ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tag

    +

    Yes

    +

    tag

    +

    List of tags

    +
    +
    +
  • Parameter description of field tag +
    + + + + + + + + + + + + + + + + +
    Table 4 Parameter description of field tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

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

    +

    value

    +

    Yes

    +

    String

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

    Spaces before and after a tag value will be deprecated.

    +

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

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags
    +
+
  • Request body
    {
+    "tag":
+    {
+        "key":"DEV",
+        "value":"DEV1"
+    }
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    204

    +

    No Content

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid action.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635095.html b/docs/csbs/api-ref/en-us_topic_0098635095.html new file mode 100644 index 000000000..fb8fae3da --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635095.html @@ -0,0 +1,153 @@ + + +

Removing a Tag from a Backup Policy

+

Function

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

  • URI format

    DELETE https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags/{key}

    +

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    resource_id

    +

    Yes

    +

    String

    +

    Resource ID

    +

    key

    +

    Yes

    +

    String

    +

    Tag key

    +

    A tag key consists of up to 127 characters.

    +

    A tag key cannot be an empty string.

    +

    Spaces before and after a key will be deprecated.

    +

    It cannot contain the following characters: ASCII (0-31), asterisks (*), less-than signs (<), greater-than signs (>), backslashes (\), equal signs (=), commas (,), vertical bars (|), and slashes (/).

    +

    (The code only verifies whether the key is an empty character string, instead of the length and character set. Keys are checked and used after deleting the spaces before and after them. Even invalid tags existing at the bottom layer can be deleted.)

    +
    +
    +
+
+

Request

  • Example request
    DELETE https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags/{key}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    204

    +

    No Content

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635096.html b/docs/csbs/api-ref/en-us_topic_0098635096.html new file mode 100644 index 000000000..5b1550925 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635096.html @@ -0,0 +1,206 @@ + + +

Querying Tags of a Backup Policy

+

Function

This API is used to query tags of a specific resource.

+

TMS uses this API to query all tags of a specific resource.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +

    resource_id

    +

    Yes

    +

    String

    +

    Resource ID

    +
    +
    +
+
+

Request

  • Parameter description

    None

    +
+
  • Example request
    GET https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    List<resource_tag>

    +

    Tag list

    +

    Keys in the tag list must be unique.

    +
    +
    +
  • Parameter description of field resource_tag +
    + + + + + + + + + + + + + +
    Table 4 Parameter description of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    value

    +

    List<String>

    +

    Tag value

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response
    {
+       "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key2",
+            "value": "value3"
+        }
+    ]
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0098635097.html b/docs/csbs/api-ref/en-us_topic_0098635097.html new file mode 100644 index 000000000..4fcedbfa6 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0098635097.html @@ -0,0 +1,203 @@ + + +

Querying Backup Policy Tags of a Project

+

Function

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 creation and resource filtering on the console.

+
+

URI

  • URI format

    GET https://{endpoint}/v1/{project_id}/csbs_backup_policy/tags

    +
  • Request header +
    + + + + + + + + + + + + + + + + +
    Table 1 Request header

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    Content-type

    +

    Yes

    +

    MIME type of the body in the request

    +

    application/json

    +

    X-Auth-Token

    +

    Yes

    +

    User token

    +

    -

    +
    +
    +
+
  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Parameter description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description
+

None

+
  • Example request
    GET https://{endpoint}/v1/{project_id}/csbs_backup_policy/tags
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    List<tag>

    +

    Tag list

    +

    Keys in the tag list must be unique.

    +
    +
    +
  • Parameter description of field tag +
    + + + + + + + + + + + + + +
    Table 4 Parameter description of field tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Tag key

    +

    It consists of up to 36 characters.

    +

    It cannot be an empty string.

    +

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

    +

    values

    +

    List<String>

    +

    List of tag values

    +

    It consists of up to 43 characters.

    +

    It can be an empty string.

    +

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

    +
    +
    +
  • Example response
    {
+    "tags": [
+    {
+        "key": "key1",
+        "values": [
+            "value1",
+            "value2"
+        ]
+    },
+    {
+        "key": "key2",
+        "values": [
+            "value1",
+            "value2"
+        ]
+    }
+    ]
+}
    +
+
+

Status Codes

  • Normal +
    + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    OK

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400

    +

    Invalid parameters.

    +

    401

    +

    Authentication failed.

    +

    403

    +

    You do not have permission to perform this operation.

    +

    404

    +

    The requested resource was not found.

    +

    500

    +

    A system exception occurs.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/csbs/api-ref/en-us_topic_0134484533.html b/docs/csbs/api-ref/en-us_topic_0134484533.html new file mode 100644 index 000000000..7761b3e29 --- /dev/null +++ b/docs/csbs/api-ref/en-us_topic_0134484533.html @@ -0,0 +1,121 @@ + + +

Status Codes

+
  • Normal +
    + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    200 OK

    +

    The results of GET and PUT operations are returned as expected.

    +

    201 Created

    +

    The results of the POST operation are returned as expected.

    +

    202 Accepted

    +

    The request has been accepted for processing.

    +

    204 No Content

    +

    The results of the DELETE operation are returned as expected.

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the page requested.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server cannot be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication. Then the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request cannot be processed due to a conflict.

    +

    500 Internal Server Error

    +

    The request is not completed because the service is abnormal.

    +

    501 Not Implemented

    +

    The request is not completed because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    The request is not completed because the request is invalid.

    +

    503 Service Unavailable

    +

    The request is not completed because the system is out of service temporarily.

    +

    504 Gateway Timeout

    +

    Gateway times out.

    +
    +
    +
+
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/csbs/api-ref/public_sys-resources/ExpandCollapse.js b/docs/csbs/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 000000000..116ddaabf --- /dev/null +++ b/docs/csbs/api-ref/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}}; \ No newline at end of file diff --git a/docs/csbs/api-ref/public_sys-resources/avgCompile.js b/docs/csbs/api-ref/public_sys-resources/avgCompile.js new file mode 100644 index 000000000..327822688 --- /dev/null +++ b/docs/csbs/api-ref/public_sys-resources/avgCompile.js @@ -0,0 +1 @@ +var name1=null;function test1(a){a=a.parentNode;a.className="test1"}function test2(a){a=a.parentNode;a.className="test2"}function test3(a){a=a.parentNode;a.className="test3"}function test4(a){a=a.parentNode;a.className="test4"}function test5(a){a=a.parentNode;a.className="test5"}function test6(a){a=a.parentNode;a.className="test6"}function test7(a){a=a.parentNode;a.className="test7"}function test8(a){a=a.parentNode;a.className="test8"}function test9(a){a=a.parentNode;a.className="test9"}function test10(a){a=a.parentNode;a.className="test10"}function test11(a){a=a.parentNode;a.className="test11"}function test12(a){a=a.parentNode;a.className="test12"}function test13(a){a=a.parentNode;a.className="test13"}function test2(a){a=a.parentNode;a.className="test2"}function test14(a){a=a.parentNode;a.className="test14"}function test15(a){a=a.parentNode;a.className="test15"}function test16(a){a=a.parentNode;a.className="test16"}function test17(a){a=a.parentNode;a.className="test17"}function test18(a){a=a.parentNode;a.className="test18"}function test19(a){a=a.parentNode;a.className="test19"}function test20(a){a=a.parentNode;a.className="test20"}function test21(a){a=a.parentNode;a.className="test21"}function test22(a){a=a.parentNode;a.className="test22"}function test23(a){a=a.parentNode;a.className="test23"}; \ No newline at end of file diff --git a/docs/csbs/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/csbs/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..60f60762138fe7d98fa081415cf26a4943897779 GIT binary patch literal 2752 zcmV;x3P1IUP)pPa!Eu%RCwC$n`u~-F-BFk{0Y@>jH&Wt02T)4n7aXBssVicB` zOX`JaF2{q_2~&#?rkP8$id|Xfs23G(+0lTGT0tnFxgZFMIx;xG$R>Lr2ng2sFhB=q zSd{Td_5QEx{V+WDJooe7@Bg{)|8u`XpV~`~ZvvYTAfN{@5<(zAAd&!qNCE^R2@oI< zNq|5k0e^NPrRGdyW8`F%MH7XH|3P8=s2${2dg49z003YAM?%tm1!4=85P2aZJs3WS zG6CT8kCv0C(eT;v!9vu9jP&3oZEw^8HmnQ6+clMCL4mv(zK?)Ob8&M#`$%sr@v0v& z@zoUHs-n619H>uFER~Aj==ntk06q~XtAWrX`-(7l=)GLjQP?!@q z{@ZTZw0`amLgo~4vvd&0Pxryp)QHy>ob2%4P9)V*SX4zr!(BuoQ>IK9!d&k>z1cqI z{8L;})njUE#LIJj>h%6Q^ZVF{wB;i;Qi+5h9}NJn%x@raKm6;fW+Fl#T`67idLh|4 zu~b$4-1hhHTVfMtV@>p)0G=3ns@?Zq+;oGKv z*YE#+n>`1!`TpdYF4yhs&w)&meoVo}#+v$ur`WVKNyq<%YnFsZMC$eXSc!Bf$)AMeNOrxm z98up?0IbZ4d1uoLyuSG}0{xcY?H+G%68SDpqp0{6ZmtR(?ChBNKk$ZxK&chd%Fub9B!C3$z*oSdfKP$^R+Au*=jW--Q5@}8T8wOFz(A> z+jPJi0CSN!@M}8~J+m~H+qJd0$mL8L?}^W38D?fiTvJtZ_QG{CGOx1j!^2co2eNIY zE_th}e&*28WCEs4)4Ngh`F*TJs&5jrEg}J*$>Ry|NTs@Q5S4XS*jiLGYupV!l}OmJ zCkyWg!}|T(8zmGK-@ggmTpXX4Lzd^H6d8Ibpk8+o_km$bMW>TS}&FY)P96F+{d%+84 z0FbR#^Wj0eUL$0WrHtk7-A3#N4!~oiv))WDwoq|!rza!b-MC#_%g6i5bZq+f?}v+A z&dvOM*6oz`?o(Suoq{*R_pvM}5O;^mT)Ww?Z7fftAwAED0FP9BCXZ)ZL<03qVuSdN zP8xtRONCq}V{LHL13e@F7rC5Q7nL%1)>HuEPG%TvZ9T=8(JF40lp-DCMCkm>9oo4$ zp2gbI0)X_(**fDB#*QLr-bCyM4&cnWE2QR3>%BzUvd0>L#Q|n|$1Tk60kC$33wat1 zyP`b|;`hpR?G6;%TDEA7?qPdG5~XG3DCEwFEmXV^*atUP1r?Q*Z6tf#C@HG~z|7R7 z%W^bSHmKdEz8|Y+XCNKoj5;@$;5Eqx+bjkplCo$bd!u65ur3Iht+xK#S>J1CGr+PQ z0C$JWZS8>kO3xnquB&Tk(E(-;v|eN5zDOk!LKaKgc6D>}Jxa^U*&dP9D~M#(l4Wdd zEW5NF>oE`jQ&SV}G+O8_@4Ge+!`aD+oB8?teVaq?BU0GA1xO_l=1nQrAx&+WdOB8S#d?X;+5%{W zL%$q0tP5gqR7{WS^|&#ETLM_$tqfODr{F@Wvh7$L9&xbkIv%IZL`G<~%z?=et2Z8l(~lTRu|vXblrbH{CQq;M*jC6P7 zAFJjO7P_e26);09x-VYJYSS8{M>uNB=$!_=`UBu*VJQICR{ab{qy@7TIM~}!cc+es zuSRv+yK8E024LzW_fF?DH>qIv7JK9}8Okgb+deq(_=yx1KZZPwhLE7)i2By(j4ulc zZ0X+G=!}W_*0i+)j$M5C6#K-`Q^PI#NC$_uZf2|)Q-QCDmtJxjn1b~m%uQ)q7k*!v<@zee~^S^yy8n;SIv9h!z@F~L` zuV;E)#MIP`TP3BWq~-E)te=ie;#EKP>`x<4qruHp!K;f(yPS8hZ8~d0reR}ajZ`A( z(HeW)kgTXvuy(`eEDH)`tWfsw@ySLcm z71)pX#Is~7?MOOfjY2*gfad0Vq-SPfE=p#UyBs4UBW!G}*%&$+h}RorbCI@}bUZGD z(D`DX7<2A;EnO+wSMkI5S3ZiysJKOPz zXHjNr`1+U~!-i@z2TQevhO_F+9anqo4qDp6*s z{^#^#iMhy}=wm-XjcU;ayd~S zjKa+^{((2(%#||Kxw$%iyNf&$A}5<97d+PwF{vJcqF5t}K17 zWA47SPe$ba7&NE7d;EGLztWTQN_%qi?{fFvpbejgc;mTn%wk=QtX`o_PVsJli{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/csbs/api-ref/public_sys-resources/commonltr_print.css b/docs/csbs/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 000000000..a59823141 --- /dev/null +++ b/docs/csbs/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/csbs/api-ref/public_sys-resources/commonrtl.css b/docs/csbs/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 000000000..f261da752 --- /dev/null +++ b/docs/csbs/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/csbs/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/csbs/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..47a9c723532a0ac410285e5152684262127922bf GIT binary patch literal 2771 zcmV;^3M}=BP)pPg-Jv~RCwC$oO@7HS02Ydnp$REOA{(Mow8*Mm>A3h9MeO=6 zYU>mmT}9emv9DQm*RJeXc5T5Q!v0 zB$5b`NFqdtL=w?OklwC|&JB*_kR*g*P1STeQY~6uB+{*;B2i1mw!HxCh>m7?uX_kB zZW668hPGS7cBvYGjjLu-T2{ta(MHkoqDQ**khXqXE?M&}B*qkwZb{|!wVV0PLl1U( zh|@k2Pt@e8KI2W7%cc| zO7%;oh!GEaKI?~$MKHY5t{0Ps=^60OI`;KR@k?HRh+XkChOueL!}QpzFXL=(zz|LUxf|B{Fmxd{EXn6tyV1mZmG!*PMf2b20p#%- z`o8%ZVfQ~su(20?SHHrs3D0@S-1|flxSZIlFT0HsqCq!dAXirJ4@lTnmkYTz0`t-t zoL%_-P1mIvW2W1<$B}7tG*?~Z^s+@a=y&VTO-%?Gh7Jy#@{?>}D?H+5hs1sBQ0R>W z$rPxPB0JS9by>2#BO!*;vNGmn#B$c!n|>2>7?JiN4?lg9=9Ul^WTvn;zkmZNJ#I@f zXfLYayW|WUHCNr9F<}t$c#W4#+=3U8s&%wF9keEQnyx}+}N<*(D-{;R$ zaL&lM{`n*i9mMK`CvfP6+g4qiUbYCAy$P8{NBGDGJ>#mRNP+|zE_)NFmo4(hwYIv@ zj4}Jw)#_@YXz^U^wkl+5Ed$yU@(x$pVxcJ-ZmXBjPZHcyBPNTQ@jT3znFTMzB|S?h0gxfpz6m)AA4I1f{{Z$&2y zk3ciVjBaWI{dcTHs?p)HH*sm#raQmUz>fucJ<0Wt1$&7Yo{Gv8hdf^6w-o?Tw&YWcsTM+dBoLi8 zm#bgrQM3K5ud%~av^tvIiFi|^-&R4OlHQ{uGz@8In6F1rD1F94&As{c8*2bi=#8{A z)KIlQhtnC$?tCJxvO0({nRs+qm1oR!Z=IKnF2v^f{N$t{)~t1Vv2?ngNK$nuGEKO< zzf@ihKvc#!1ci#0h8lzrHSz1+9!LmL<7})$rq&Yk)GWTA^F~0u-~E0TNjvu-Q)}t} z)&}+s8s@*>B2&1%Q%tPac=st8NJG2{;%siGF;7#NJH;& zhtmrs6i)v0ou4BeO^#u2egO+IQwUR3_$5wT3!n{#&@*Jsx3K<;Tq+W^T~4H!KR$~@ zu5|Zlat{Mw&iD(0QiW8dAv|#;hS6ylMyC;;I1(Y)o!@mEZ@FnQU-ZJ$IBKhr$d&Y3 z@~n?c&GxedN!C@{=B92P%iuKA4P5P zF?T5M7UQl=?_?r5^a9HdpCWnaAVwy9ACNdxCO+iz-A9L25o0p3%IfG+5=G4$jjDT3 z_rX_P#9mZ`W{jEERu|5u25kR1=sC=`>*|qQT57FGWQv;}!j;wgsVgZ&P^ySbnS#<_ z@{wsQcZWQgM(3rkuisR2@ddhKm zm>y`QU}}cvFx#%9zncRR0f}5m+=3T>`k`rb(CYH78vp)0Ee*BEwGqTVll7BY1|4qD zR@y0eaw?7*EAlWsiJLyTGjpW6UP@ltw4HQIDv2=#er2YNQnNeHL|TgfF7e2O?@1my zh~&SD2{!g(;QB4N?2Xi&J%utn0;xtv zkRbctK7@An=2gu(9Ra)bZS!9G@?)aLPe-neAnxr2otkuaibwkB-UtAuk5dGci8mbQ zpHD?%2tDKXzEY@Rj-@xHWo6{`Gk44bDS}ZNOehT|CG6gP2Ggpt~a%lW$PyZ(R zi8N$tEzX8o&aMocNSD04oR)@K6nZ1(%xk%iRHX^nOsp#j+)(^s?wgdX$fl*dQ#vN{kQBLN_&` z(}>jJm$ns&TBh$jOxAo08KVLl?;k50S@-!F7S4`i=H$SR@bCXNvu5pPHYX!BHAMhH=PbZLgf2GrXYPBlYfJrz}; z)`4zn0@|b`lo3(5nj87CARk+Pp-;mw(B7`!W7{6u*6MHG>-993S9MlnGP}b>T0X$Q z*4=p=+dA4SslE}Gg;&WhtYpG)6U!Ea29!H%?ahd^54+^o0V28#9s2{xQ^UKnb$1>s zUY^}9i2&9v4QJu(xOPbdVAh?wt?d92zi^J^&vgoySb1+qmmi0B}` Z`Y-il7nw201!5QImN;7^FeRDuvlieQm$nqSgH2#ST^0cx)=Dn zcnY!FJo_HPt-fVW+YdiB+UT#;6V;vF(d}+cR@IeV(d8~pF{?8>qtl(5 z-l&f3hz@sXMqTY}N84?I)T&mtqU9C|*g%8DFx{Fx6Im5iuF|X}%dCt_S87;LjI4+X zS7=Dl>numvWx_9&xPzYqFMxz!h@dKJnV+WiNj6zrg25Bat1rHX34YcM&(@mM25EsKp^s$!A zn#VD|u6s{$op5YkSDD^r^tisfo6%**9APOOq(ypevUm*eg627JCCoz;t2Wm=9wHzA zIZpn)d?D?0K6~e%(5n+Y{``IW_383vZ~ype`|Z!iyVvi|9^OBm{E(}2>Xh(M9J1dY2CIYT07X)PL*D{uoU3SWSe zM5)Z@cZj(9E!*Rn@%yj8UtL_@?zGcisVAyCyQACPnyjiTyQ0fonqpRGc1EW=HN8j060m^=i($GodnU3fs$8X6OO{y~m9EsVpcq*Z6|T^b zqSslDvde-aqopiG$tAYJ8Zb!15?a()3^veUF{}|ZIT4x8)aYX^Swx02G;(1<(UEpq zsD~82sYp46Jp6zr)7XK2NT3kbfI%9Tw8DeMU;_=7#;04Wd;7XW>CRXi!yzvnE_|I|r wZ*w5M>1_7SKcT}DJ@4vn|M>OS_UPly>%-H_{r>p;)5Xs}-+pgDf7s~DJ6{D>Q~&?~ literal 0 HcmV?d00001 diff --git a/docs/csbs/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/csbs/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 0000000000000000000000000000000000000000..84eec9be2f2ce458e888f8a9b803f9387247726a GIT binary patch literal 68 zcmZ?wbhEHbzkByxQ$u Mo$o?7J5~m305MV#!~g&Q literal 0 HcmV?d00001 diff --git a/docs/csbs/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/csbs/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 0000000000000000000000000000000000000000..39583d168d6db303b366b5b8c1780698a6bb6017 GIT binary patch literal 70 zcmZ?wbhEHbEMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 diff --git a/docs/csbs/api-ref/public_sys-resources/icon-danger.gif b/docs/csbs/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..079c79b263f4b48089f3b3256154c73e7699593f GIT binary patch literal 1086 zcmW+#YfRQ<6hA3LZMyP?V}KhnEtF{Q4vGxS52AozEVM85nq$#%tv8gRF!3GhgM?_) zd5Luv3SKrXFTGCpn$y>EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 diff --git a/docs/csbs/api-ref/public_sys-resources/icon-huawei.gif b/docs/csbs/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 0000000000000000000000000000000000000000..a31d60f895af919d33855217ca02daf4093136d7 GIT binary patch literal 2767 zcmV;=3NZCYNk%w1VaEV40Oo%H*MEWRpQG)+!RUX6`tR@RDKg4%aM+KK_}}3B+S#H2 z0rt<*_Nl4!k%7|y4fwgY^uNNg00pZ61NzIz@q2NyEiLIHE%S?g^NEbfKt%9!YU?yQ z^qh&+U}WbD8{q&E?Mq9<013DN2H5})@N8$u01CkX3Fs9f^{bWHKuGLFOZ1kS)=*aD z01@p=RQ9r(>pemK^YiUeQPU6`>94W!hk53YleQ2Q>_SB7aCr2fj@; z@a|n&?qX^0W?<$J9`9pa@`8Bj9VzWnT-qQk!yqQl01W6ECF?mp=LHtlFgo|Iv-PHs z+HiFBprpVM7yReuz5od5zrUyu5$;)5@{gDATVup9HOgRO=U{2(0u;*t3-Hg-^OuGE z;N9vkH}7a--=Co1Fg#jPP{_r^k&B8kCM0%mZLFxL@$v9KH8SJk;?~sDy0^BTnwV%{ zUQ9zlgnfM9U}wHiP~xwz{`dCrZ*%7e7{X9d^{Afom69VE761SLA^8LW004ggEC2ui z0LK6@000O7fPaF6goTEOh>41ejE#|lU+C8$A-c{-jb1$W_sAqMbtN`+RZ#DGFR(dnrcRE3N%f+!F;*y7(oOv#1FPiAwy#YP$z^Q7U<_8BLs** zMSr>_(L`oBgxA?;z>x3<218xJ;14v)$l4!yG&Wrk_I1$$0*;vB$B=#`at4uppizkb zkVG1Zq>_oSkp_`a7SaZiZXiMjk!m2q29j+I!X%PpB5B5wO%5V}2qJRl1%NsHfxr&G z=|x^!dAKu_41Dql0y7LOA)N(0dcZ^rABfh-m_;ITB$a5UdB~$fR(S{-NTzYfmPE#Z z$dyBCddM0`(jjJQ3^=Hu0tmpW@WUTds1O^W zCv4aPqTVsWsFRSgiX^m^Dgr8zYZ&qdl5-rgEs}5?A_tOhoSJHxtD4)WAg_+-CV)r$ z0l^3=PP3O0e*huI221P;!@n>Lqi=>hZs_9&J75vyw2nR*>5$YWnFy(5hH1$EwSHt- z2&Y^c@+FZL3&QBRsy<8z0uiv;-+usJMIdJZ34w1G1pu?}1~|L$M-&7rk*ppEBV3oW z3{UE?w2~S^sl>(pGc6ETQUgwH}48uSiAJo0SA(QX~FrGzYvq#TC0!EGVmk{K=`YG64w z*^4Iq2N`U_YT26(@Ww;iA6V3a3V*n8!U;+!QN-&o;K;WJKrdVR4kI*6wC0H)Z8+gt z8&Y|wjA~4X(?lBohtwStGUbrnULHxSg=BE{y8s3-FXI^_2KJ7l* zPUi?^WVSHxgDj2s;6@ith~r!?-DM$hAerqT7$efv{s0FgQSEnvBN74j@P$DTKnvHC zONlTuy0+nk2Y*mO7rMX%Cg?#AOZY{0)h5f{2_S7&W;+3~xxv`varUz{DmpF%e^`f&wJ41t9(5fhwzv1mBc| z0U*EuBM2j%FvtTFnh*k5Fk|UZh`TZf2my8Qf){uKMUtgzel#qE{5o z`T+owlz=pEZ~#HrKnm`Pm2OzzgBhrem4EOJodD;_ahfxf-U+}Ak|4_v=x&*|EE67c z`G;K+;#whFp8pE*u^;}yhknQwAj5S;KNQlDsB)$xqbbb@AmI*w_<|O)xy2+vAOLDp z8yCVE${l#|oS_`S5dZ^$BP4;HUf`rVX&Fy4%@bn4W7;49dBA^~$q>dQOL?8kgXdnQvsYOnDfj24t0FVQ&GJsH);SXF0X(+eq z0|aFCq_QkQ2uwgnL@)|$U)!lnaS7A<-BO9Aav~Zq1~shtZ;*=2X&Qw1zoAY~flO_x zQ=i%a0w5p*o16;-5U|cJ{sE(En`{^}sx}@hzy~=vDN0qkRui}|sdcU4U8UAnL&&wT ze-NTA73oVe_41G0LefE{2Z>hMA+geI=u@QtfIkQT2`1nUZwBxt8^}v-apD4J9dHDm z*r2j$RqI-*fP_WBP>(V+WFp;)q}Cd-rO7KqPBT@AJ}!>D^n`Dbmde!NE;eOIpur!e zT2+HIfiCh&!V$`4~D_J+6+9nP?X4+~QQR3Nd6O>yUni+~O!R{(#Yf%|x3 zV=w6V57*_SoPYe_5lO*{ETyMCXS!kI{qmTJC@5?}tYs@Z`Gp%cnIOCjX8WdC#YjMN znOSg%0i?hn3uwZe>0DG@D8{!L9NVviU!0?6(AlZm;xWpa)Zb-c0Yf<`I615cvC$3@R|NPo+jf8PRu)%BB zhMd<%u5!4#ylXATHvtr$a54bk<~ZL%26n#lMX-S98Gr)LaZUq?L;OQXHv|E!0Ok|h zR|}ywHv~IJbrC%JsW+&2(zpJHJ2XAlm3#yMI(PL)OS76>Px~OC`E{mNAnK0zLI%qI z)ZlJG?RXaiuD@;tv`>NzH;90J?Vk56!rvj>leB^Xjy?$j0N@7pwE`ImPx(Jo;pSvu Vyd?-=a{xfJ@}LjB=qC{f06U7uGEOJ7jGVWt0R$WZ8s=je-u*DOe&kq9}!i z4KyN^y7WUtlMt&*F%bljtRbDEJamX6>@vOi{twMwE+=kqtJr%yLc-a1j}Z>-)`f9GBO%WDhy=L0>5=eLzUZCI?G``P_| zXl3c^-NL}=_M!Zh=FG7pU)shB58htr9~}O0uVbq2_rt-Fxv_(zmmdB7)lfOReyZ>D zrqum6#Z#+~moGM-oS4Ziby(A(@4L&ZrWcR4wV&_mTide#$G4kXKF-|cGp}2pJe$2t GE&l)<3Z_>8 literal 0 HcmV?d00001 diff --git a/docs/csbs/api-ref/public_sys-resources/icon-notice.gif b/docs/csbs/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..409070650a49518feb1624c624d814c3bfa63d2e GIT binary patch literal 962 zcmb7D&r8&C5S<{wSd_qn6)U)w5LOaRh!N}_*49lD)S!dZp@M<3gPIX|@UR9-fz+X3 zAaT9)OY{xZtO-;RC85Vab;JEUNIMS5f^r$7-e%-XK`j{0+N$CsgpRd6B1wp z8dw-cH^rU^H4`&7qgabf)l^K`l!66{q9$U(CKRO5%W5pfY)s&YQ6n`HBR0ZTum%`N zgC%I8hQ+`JG_WvCAt-W$sIn@BKCDG1qQWW^a=`*c7G+i@s0S(ZDv1&+K_2`7O-#cM z=m!ZX1Z#kSG+3e)Jg^wpfCd(Yb5TZ)U=a!DwsG z)Z`|1ejMK4ap%CHj;%+>T6=D++5I=uBbQ$fZ48cf{hV1}9&Njl-I}i7e0#6Hdug@s zsr-57_=gLr&9Ros$k}}M>tJ77=hEJ}iPaZ%8|P+gUbS|Oj}5I{|5nZZc)C1$e*Rj` d`09hYXJ4M@PhCx)dHK8WZo1*|*q+^V@*ncduk8Q; literal 0 HcmV?d00001 diff --git a/docs/csbs/api-ref/public_sys-resources/icon-tip.gif b/docs/csbs/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..c47bae05c9fd17c02a851d96cfac67bf194498d8 GIT binary patch literal 879 zcmchWKWmj?48@OdDOZPr)a61!OE4yGD)salg#|^Ix$qIEF#uk)V>D{95e^!2r`i+9t# zTMu5YtUcd+@#gp0tDE;9ug>oLIzL$6dOx4-t#2PKExu1KulwoYeD?Os#mVO%AMWih HO|EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 diff --git a/docs/csbs/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/csbs/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..57a0e1f53377b28fd80ceb393b035f8d9b8b392a GIT binary patch literal 1080 zcmV-81jqY{P)pI>PbXFRA}Dqnq7z+RTRg6r`*v5D@IBmL~4s5$SN3-f`YICkrqS^ z3O*?4J{4psT?>Nv;P$DA4|YKmeJd1v=!+{-P(e)MT23E4 zfpM5g?!;YNyXOywggfWv-aG#}pA%7499KRz`7Lmw98Q!I<#3`LPLvbnaH1TQ5UMEG zlVk_b1{y%CK&5Na8Kh~iV1CQyHSIUD=$Ui|Y1(mW{t2nlnW!hpqTT3)%#9tQ2@Hwc z4!jG@4brq%Pm%+`OlEvYXy4{GY5awd{We?gCpulWuT{Z9`oN)jk~9ZtI#ba@Tm#IC$eXI#i?GB7 z@C|Siuxi7{ffK+jzyrW_z5t&id2Xi{7fGOZ7RUNhF z=`q(YYu4B2zr}fA1-My6UW~A&C(H`Z0J{sqLLYb>ST?)$UTJH~j4 z)U5D`kx~@HyTBjADBwh`9UcOHGnaO3gx+o=^sFTdqcDs&7cD!S1Y1R9DJQENmMBXi zUX68u7SqPL=oS0?tDydiCJNY=lMCxo@cxg;Iw&H0tZv&cB5#jSkGc8v45{4-xAi@+ zH#c^6Llb3aTk2cp0#8`%*2*ZSb3DivIwje71|rV*JnwHI2e{V0 z?L}VtT_k|}D>qFKHz^_)cUMxtxkDBWXzz2D1oirfKkqs5Z>m~O`i+$JJR1>-NN>fsG-Q5hHbmeou}1??2@ zp;^{uvz{qy3k557pH|h^|K(Paf~;?wS^K(J)S`9Ki+p;|vZBS3*BostG+QG&8PgN& z=@C2h$ubuxBJTs&=XH#%UFPZrh=oAMNN{DPG_uReuDWcPESRPGOKD;{Otwcu3X@*QY`k0+@}-e yxT4{IZgHXpLI!Q!9RCwC$n{8}UWfaGMW8J;IUE8&LY1fUhGLTVa3!QBW+ZA*L=y*M3rfr5il?z?dJZieJ#47>M$@*mD4$1ecadv1qsU1#wR$;qu4Bmh4yS`Hi)ReG=4*#e zajgEV5YlLPaKTMvrW)|6L6Y@JtlU|tX}9u@d<^;|8a!TJ`kRn8mKIZX-z)%<^+`jn z738I}>P{CwooQ#@mc8ItdHsQ6rsk%O$iLY)*x7Zcj%}lwEK@`-=;otzSyX+&p9{kzQYbgSF@Q=2Qy+?#VW0=Vy|cYT&lQ@%;A2YQ{hH z9%ov+34{hBa~SnWOw39F;7p5`9$z4G?cJ)An*I*rb~&khdI=d8h1SkK)If-j5C2TB z8p4%r<<^31tR|Tw4Xs1QHMjMk20}yD8f4p%dXd_$me9Z-SWPlj8%nUOe;>LpUUAI& z1+$nxI~Q3>q`9q!{1-nPlEMa4o@e_SGSdvCrzn))J%_ut?ipfIn4e4CD=Pq4zT@D? zqk$|@wV{L*qfBG7mtFghv-Lntl$pcnz~kwNI)BUSUuvgmQEXp5=UThz?DmmjlsW$V z@)3#dyh6UbBYa%QD%n4gom-Glu20@0My{Xs3VRpaU9=0QxbJP-J)Pz^`?kOW30Tn z@ufYqb@gL4$<)8N0%S?kG%v#(IqvH7UvcW1v+a@N8!}9Baks0-uUUYP1beE1+)Q)S zUobczB2ql)J>S90pM1~e2X4k70q-59;@Rj(Ixc6Ok_Z$V@dbE+GNTrV;HlFQ=lRMeN%CX^J*|inqrfX$fdWuECU& zYE~#M%8xCgqI||*N`--7Xw)BgEZ#bB0-qYhW>q--LhLmBU*r0E*5+4PP+l2n2}rtV z_qXh+#jl32SrvAyo2R)OD=o_BoyYIMW>x6y_Tety7r)3^eF8`TK$3KP{`eA2F}YpN zxa|~0YP$+*PB&3e-M~W&UFbFHknL5q%yVT?GB=Ox3?p^VEh7*N@$03nevU0%RA*Qe zy8Bd~e78Ejsl=~x+vYF$e)B!#In3BC3Kw>)rNi4F>6}lnndnzTghB(1f9&nZP({}9 z<_Y#X?@5R5*rUdbm zZ9zPQB)-@t_#f`t1VTsxAtZr72uUD>BoIOp2q6gsLP&yt3mvdY+y=oIIs7M?<}pwN SX0_=60000=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!==null&&typeof document.body!=="undefined"){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(e){if(document.body===null||typeof document.body==="undefined"){return}if(i==0){return}clickFlag=true;var f=Json.parse("jsonData."+e);var a=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var b=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){b=0}var c=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=f;dhtmlgoodies_tooltip.style.left=c+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+b+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=c+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+b+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var d=dhtmlgoodies_tooltip.offsetWidth;if(da){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if((dhtmlgoodies_tooltip!==null&&typeof dhtmlgoodies_tooltip!=="undefined")&&+(dhtmlgoodies_tooltip.style!==null&&typeof dhtmlgoodies_tooltip.style!=="undefined")){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/csbs/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/csbs/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..def5c3565da51684d78479f45904c0360844c243 GIT binary patch literal 3164 zcmV-i45RajP)pR4oO5oRCwC$oPSW0cb>;zfj~mSuLKN~5E4Ot2?$cVg1bfW*MgmP zwXW?r{^)GC>z&@*cI;fk*-bA_)*65J|u{1o1b~sY9&bgB!&FtPHC|>aqwkEf8t)sIV8a zy`l<$fv1-750WZjrUfER4&AbBw(qRs>9xxN*j}-pMOzA)VQ&y-TOiWJv9nVR=-IGB zL`2wi-rWtmJCwYrnwtLq8d^@54N{_E#qc2?d98FYUt9|#UM6CV$k!5{lNa$(kHW9K zOnWgQF}`S;)25`yKPRE0?;CL9SWtgolNa zrBRX}cY`9==aUXcrj$ru%8RMoU&9MOUrS=-S8j{+s~_?FOYc$kFAFFdtPOe${ncT1 z{rLzf8V%)-DtvDE-wqmRZ8xCPYAJtA<5`q3{Ob`bjZO9Fv|84D-@EVUj$Eg)=@6=E z@#L*7W|qCq*W!xRyz%}azq+NTrIL{{k5{wx9=$&5QFz+d73A@UdA>TE#nbrfC(X3B z8(6fZ$fI-Rsms(id`VH^EXwBij$f6Q%6pGy`z7a}PPWn1d>+=6lPmX*Un}gz{Ox!v z`WEl|IDGSOT%3|O*G+D{rZj7N?NbLjt(LV5jh=HqnA?U z8mrYxV|c!gMHxe<(a3REu1^wRwhaLAc*#s3m+W-80O+~e%iEuijH}D~<%`(7rkqDg z=TTZb2dmA-!DFZR&9(3NZQo)rQeiLlD~pmzCp{Of?FN2YE1pz;Th3*$^KYlnx3rR& zpyJ_&X0!Fj%Xs-G%lKj0eA3fW0mv9`|G!E9Ya~lJ`Po^X-Lx2KsErPD79Hj+q@gxm z{Mlkoes-3_qjQ5Er(oy{Vq#*j+H8D$A>2z=-J3vbyTSAQk0(04Sglr))oM!O z`@CekFQuSwX(c8)8igX37UN~i63tz8`Qdaso8^aiGyN2A&2A@2H4T81Uv&6wZ?)Oj zTifJC_?WSn~TqB!^hRw*Ad4e7J~3dFR=6G>_8NdnsMLm)G}au^{sd3m-1x^#e`g zF3xz6x-4W*PjVBduE|UGaf6#U1-aQM6tVOT40?@sz!ZhmW+Or>@p4-Zv4VXye+OW7 zc`+d&A#@sz?CP00DZSLHz!o=IttMHmrqgKTxg*zuw$4$Jkz99N$7-|j*1@mnmSvB7 zO=WExR-28GkWk(!3-#*~r7p`oB}P+1qz`Ts(`7QTajn||ZQHTiBYWfRy#Q?8q@~Mb zVxKK9=<$~3C;^C&N<0(TEz8Di8z5P&W>aZ0G0`z}8jaMCZ=XmZMWeykeJP-en=p}N zQr=uQi}bWqx=f~kF79@>Z|%3c-P>cc{E{db1WhEfM8nqKxzqiJbY}y$o33o;>9xz* zUQson-E%k07oQ_VqoK9kz%l!D08Tq~beT*pkf^ z4(PF1`pDEKqI8;gLeoonS}MI}GariryW_5*SlZ-;)XNs|tUjBo*UTssvHYZ9)NlJ) z_By_sKLd-UZ%SNTyvWApvWyA2xbs6QE?m4wVctygq*taq{STT*zcFP3uVFUm(>{fsnY2byQucdN-4PVNGGwlltbpW(qxPn=t@v%0g@(xlo8u|zNX$;Tj zL~B0)v5_*bKys%(iq>`m{r&x%z8c|~$V_b_07FC0fQu6zCMG;gOl!LV)wFmvmglg* zQ8R8V_1h;>NK8;+wORT1?%)IOmvT)cCaCB#nI=Te-qC2U(nDqS8QysRkk_a3)aCm} zq?bP(MW@xWs-)NJe1QW+nJCD~rsrxeyN)(b$ZgNE*Rg8RgYE+A=jS;+kQlUu{`Kmaq-Zo)ZC1bW*X)SP zB&*dleDyW$_FJ1<>AK4LvN>#CQ_ki!<><89`&-$rmo4DrXSKYw{l~;e&UndGvBREY zdBhz%GStSin-=p=&;OneA1vbs!`1gR{w#YP5zt^s>sevrzAfWX_)uEYBrfUeBv}`^qrW~HGWfKsmsDE zOQ*BGS9P4Wl`RF-yksh zy60FsZNNwVNWragKrk^ve!4rg7mMBdVO@#NOI{X#h4i#kMn*=saPcD79Zs)o<((?G z^^%CiJRf_Q&GJKDpRI*9vNO}^G#dG@zTAL%%&<4GWyKs~qN8as7&HHba-?wT_zK+{<0Kls4ZZI zwt3@|Ua`~d_}Me*beT*+rNNJ9iBKqFak*TiXf(`~bowmtSfv`EtT@NZqPks+{a z5!JMKPh8~>&n-znE|bw}==6Ccb0>biz(smmDwnVHu}ZPEji zzW45)-n*6<0^#-C^K4pKLR_4Zk&zJ&pEynB{*O3#>=aGS=dlkuD9FiX!}lillwCC0 z-?hEgU&dQ|syVhNu(h$+M6CR&JD%9FMMGhZ|GG+tIg8TOds)AHF)ylW?m2UG5RP)x z8t}<_w^)soA(EXPo(HDmU3a@1zaW|JX{#K%Oq;}A@|fXl@p%B-Ez8C%ib2W{N|$?g zkBuLwVmzkfoqdk=b-RuZv4S>9rqBJ{sq>hQNv?~2V>^dfL1TD6U)yB#J4cCkVw)_#|7FHwSFj&?I903+@}Q+?E}XNC3Nz=CN(ZZjK1= zEPb1Cd{SB4f1Go_kMMN4^{(v-b4ID$mhCyd8&;L{vU{JFmp>h)qCi-YZ!0DoBh||m zu>a`Eo9X_gaoZQ>jE+kpfEdXop55erJD^6gL|Bn;DJE=@t~lNAw+sx9aIkUClqxYW z=nj}aF^#ZTB`nJSYa&gTT1nApc>bmLzAo-6E0000