From 63123ef1bebd017915c2f2d80aba4c0d5801e1e9 Mon Sep 17 00:00:00 2001 From: "Wei, Hongmin" Date: Tue, 25 Oct 2022 07:47:39 +0000 Subject: [PATCH] VBS API initial version Reviewed-by: gtema Co-authored-by: Wei, Hongmin Co-committed-by: Wei, Hongmin --- docs/vbs/api-ref/ALL_META.TXT.json | 452 +++++++++++ docs/vbs/api-ref/CLASS.TXT.json | 407 ++++++++++ docs/vbs/api-ref/PARAMETERS.txt | 3 + docs/vbs/api-ref/en-us_topic_0020237251.html | 243 ++++++ docs/vbs/api-ref/en-us_topic_0020237254.html | 57 ++ docs/vbs/api-ref/en-us_topic_0020237255.html | 309 ++++++++ docs/vbs/api-ref/en-us_topic_0020237256.html | 174 +++++ docs/vbs/api-ref/en-us_topic_0020237257.html | 212 ++++++ docs/vbs/api-ref/en-us_topic_0020237258.html | 307 ++++++++ docs/vbs/api-ref/en-us_topic_0020237259.html | 620 +++++++++++++++ docs/vbs/api-ref/en-us_topic_0020237260.html | 473 ++++++++++++ docs/vbs/api-ref/en-us_topic_0022472082.html | 14 + docs/vbs/api-ref/en-us_topic_0022472083.html | 719 ++++++++++++++++++ docs/vbs/api-ref/en-us_topic_0024723797.html | 163 ++++ docs/vbs/api-ref/en-us_topic_0043410516.html | 44 ++ docs/vbs/api-ref/en-us_topic_0043410517.html | 320 ++++++++ docs/vbs/api-ref/en-us_topic_0043410558.html | 277 +++++++ docs/vbs/api-ref/en-us_topic_0043410559.html | 297 ++++++++ docs/vbs/api-ref/en-us_topic_0043410560.html | 165 ++++ docs/vbs/api-ref/en-us_topic_0043410561.html | 300 ++++++++ docs/vbs/api-ref/en-us_topic_0043410562.html | 239 ++++++ docs/vbs/api-ref/en-us_topic_0043410563.html | 165 ++++ docs/vbs/api-ref/en-us_topic_0043410564.html | 37 + docs/vbs/api-ref/en-us_topic_0043430177.html | 336 ++++++++ docs/vbs/api-ref/en-us_topic_0049453221.html | 164 ++++ docs/vbs/api-ref/en-us_topic_0060614329.html | 318 ++++++++ docs/vbs/api-ref/en-us_topic_0061309333.html | 8 + docs/vbs/api-ref/en-us_topic_0067142129.html | 208 +++++ docs/vbs/api-ref/en-us_topic_0067142130.html | 197 +++++ docs/vbs/api-ref/en-us_topic_0067142131.html | 198 +++++ docs/vbs/api-ref/en-us_topic_0067142132.html | 227 ++++++ docs/vbs/api-ref/en-us_topic_0067142133.html | 430 +++++++++++ docs/vbs/api-ref/en-us_topic_0078214151.html | 284 +++++++ docs/vbs/api-ref/en-us_topic_0078214152.html | 158 ++++ docs/vbs/api-ref/en-us_topic_0078214153.html | 492 ++++++++++++ docs/vbs/api-ref/en-us_topic_0078214154.html | 233 ++++++ docs/vbs/api-ref/en-us_topic_0078214155.html | 347 +++++++++ docs/vbs/api-ref/en-us_topic_0098527676.html | 211 +++++ docs/vbs/api-ref/en-us_topic_0098527677.html | 174 +++++ docs/vbs/api-ref/en-us_topic_0113236392.html | 241 ++++++ docs/vbs/api-ref/en-us_topic_0134476439.html | 13 + docs/vbs/api-ref/en-us_topic_0134480835.html | 121 +++ docs/vbs/api-ref/en-us_topic_0143705534.html | 319 ++++++++ docs/vbs/api-ref/en-us_topic_0143705535.html | 345 +++++++++ docs/vbs/api-ref/en-us_topic_0143705536.html | 514 +++++++++++++ docs/vbs/api-ref/en-us_topic_0143705537.html | 356 +++++++++ docs/vbs/api-ref/en-us_topic_0143705538.html | 164 ++++ docs/vbs/api-ref/en-us_topic_0143705539.html | 208 +++++ .../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 .../vbs/api-ref/public_sys-resources/popup.js | 1 + .../warning_3.0-en-us.png | Bin 0 -> 3164 bytes 70 files changed, 12270 insertions(+) create mode 100644 docs/vbs/api-ref/ALL_META.TXT.json create mode 100644 docs/vbs/api-ref/CLASS.TXT.json create mode 100644 docs/vbs/api-ref/PARAMETERS.txt create mode 100644 docs/vbs/api-ref/en-us_topic_0020237251.html create mode 100644 docs/vbs/api-ref/en-us_topic_0020237254.html create mode 100644 docs/vbs/api-ref/en-us_topic_0020237255.html create mode 100644 docs/vbs/api-ref/en-us_topic_0020237256.html create mode 100644 docs/vbs/api-ref/en-us_topic_0020237257.html create mode 100644 docs/vbs/api-ref/en-us_topic_0020237258.html create mode 100644 docs/vbs/api-ref/en-us_topic_0020237259.html create mode 100644 docs/vbs/api-ref/en-us_topic_0020237260.html create mode 100644 docs/vbs/api-ref/en-us_topic_0022472082.html create mode 100644 docs/vbs/api-ref/en-us_topic_0022472083.html create mode 100644 docs/vbs/api-ref/en-us_topic_0024723797.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043410516.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043410517.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043410558.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043410559.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043410560.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043410561.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043410562.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043410563.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043410564.html create mode 100644 docs/vbs/api-ref/en-us_topic_0043430177.html create mode 100644 docs/vbs/api-ref/en-us_topic_0049453221.html create mode 100644 docs/vbs/api-ref/en-us_topic_0060614329.html create mode 100644 docs/vbs/api-ref/en-us_topic_0061309333.html create mode 100644 docs/vbs/api-ref/en-us_topic_0067142129.html create mode 100644 docs/vbs/api-ref/en-us_topic_0067142130.html create mode 100644 docs/vbs/api-ref/en-us_topic_0067142131.html create mode 100644 docs/vbs/api-ref/en-us_topic_0067142132.html create mode 100644 docs/vbs/api-ref/en-us_topic_0067142133.html create mode 100644 docs/vbs/api-ref/en-us_topic_0078214151.html create mode 100644 docs/vbs/api-ref/en-us_topic_0078214152.html create mode 100644 docs/vbs/api-ref/en-us_topic_0078214153.html create mode 100644 docs/vbs/api-ref/en-us_topic_0078214154.html create mode 100644 docs/vbs/api-ref/en-us_topic_0078214155.html create mode 100644 docs/vbs/api-ref/en-us_topic_0098527676.html create mode 100644 docs/vbs/api-ref/en-us_topic_0098527677.html create mode 100644 docs/vbs/api-ref/en-us_topic_0113236392.html create mode 100644 docs/vbs/api-ref/en-us_topic_0134476439.html create mode 100644 docs/vbs/api-ref/en-us_topic_0134480835.html create mode 100644 docs/vbs/api-ref/en-us_topic_0143705534.html create mode 100644 docs/vbs/api-ref/en-us_topic_0143705535.html create mode 100644 docs/vbs/api-ref/en-us_topic_0143705536.html create mode 100644 docs/vbs/api-ref/en-us_topic_0143705537.html create mode 100644 docs/vbs/api-ref/en-us_topic_0143705538.html create mode 100644 docs/vbs/api-ref/en-us_topic_0143705539.html create mode 100644 docs/vbs/api-ref/public_sys-resources/ExpandCollapse.js create mode 100644 docs/vbs/api-ref/public_sys-resources/avgCompile.js create mode 100644 docs/vbs/api-ref/public_sys-resources/caution_3.0-en-us.png create mode 100644 docs/vbs/api-ref/public_sys-resources/commonltr.css create mode 100644 docs/vbs/api-ref/public_sys-resources/commonltr_print.css create mode 100644 docs/vbs/api-ref/public_sys-resources/commonrtl.css create mode 100644 docs/vbs/api-ref/public_sys-resources/danger_3.0-en-us.png create mode 100644 docs/vbs/api-ref/public_sys-resources/delta.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/deltaend.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/icon-arrowdn.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/icon-arrowrt.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/icon-caution.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/icon-danger.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/icon-huawei.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/icon-note.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/icon-notice.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/icon-tip.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/icon-warning.gif create mode 100644 docs/vbs/api-ref/public_sys-resources/note_3.0-en-us.png create mode 100644 docs/vbs/api-ref/public_sys-resources/notice_3.0-en-us.png create mode 100644 docs/vbs/api-ref/public_sys-resources/popup.js create mode 100644 docs/vbs/api-ref/public_sys-resources/warning_3.0-en-us.png diff --git a/docs/vbs/api-ref/ALL_META.TXT.json b/docs/vbs/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..e578a4e2b --- /dev/null +++ b/docs/vbs/api-ref/ALL_META.TXT.json @@ -0,0 +1,452 @@ +[ + { + "uri":"en-us_topic_0061309333.html", + "product_code":"vbs", + "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_0134476439.html", + "product_code":"vbs", + "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_0020237254.html", + "product_code":"vbs", + "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":"VBS Backups", + "title":"VBS Backups", + "githuburl":"" + }, + { + "uri":"en-us_topic_0020237255.html", + "product_code":"vbs", + "code":"4", + "des":"This API is used to create a VBS backup.If the API is successfully called, the backup task is successfully delivered. You can query the backup status by using the API for", + "doc_type":"api", + "kw":"Creating a VBS Backup,VBS Backups,API Reference", + "title":"Creating a VBS Backup", + "githuburl":"" + }, + { + "uri":"en-us_topic_0020237256.html", + "product_code":"vbs", + "code":"5", + "des":"This API is used to delete a VBS backup. This API is deprecated. You are advised to use the API described in Deleting a VBS Backup (Native OpenStack API) to delete a back", + "doc_type":"api", + "kw":"Deleting a VBS Backup (Deprecated),VBS Backups,API Reference", + "title":"Deleting a VBS Backup (Deprecated)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0020237257.html", + "product_code":"vbs", + "code":"6", + "des":"This API is used to restore a disk using a VBS backup.URI formatPOST /v2/{project_id}/cloudbackups/{backup_id}/restorePOST /v2/{project_id}/cloudbackups/{backup_id}/res", + "doc_type":"api", + "kw":"Restoring a Disk Using a VBS Backup,VBS Backups,API Reference", + "title":"Restoring a Disk Using a VBS Backup", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060614329.html", + "product_code":"vbs", + "code":"7", + "des":"This API is used to create a VBS backup.URI formatPOST /v2/{project_id}/backupsPOST /v2/{project_id}/backupsParameter descriptionParameterMandatoryDescriptionproject_idYe", + "doc_type":"api", + "kw":"Creating a VBS Backup (Native OpenStack API),VBS Backups,API Reference", + "title":"Creating a VBS Backup (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0143705534.html", + "product_code":"vbs", + "code":"8", + "des":"This API is used to create a VBS backup.URI formatPOST /v3/{project_id}/backupsPOST /v3/{project_id}/backupsParameter descriptionParameterMandatoryDescriptionproject_idYe", + "doc_type":"api", + "kw":"Creating a VBS Backup (Native OpenStack V3 API),VBS Backups,API Reference", + "title":"Creating a VBS Backup (Native OpenStack V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0020237258.html", + "product_code":"vbs", + "code":"9", + "des":"This API is used to query summary information about VBS backups.URI formatGET /v2/{project_id}/backupsGET /v2/{project_id}/backupsParameter descriptionParameterMandatoryD", + "doc_type":"api", + "kw":"Querying Summary Information About VBS Backups (Native OpenStack API),VBS Backups,API Reference", + "title":"Querying Summary Information About VBS Backups (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0143705535.html", + "product_code":"vbs", + "code":"10", + "des":"This API is used to query summary information about VBS backups.URI formatGET /v3/{project_id}/backupsGET /v3/{project_id}/backupsParameter descriptionParameterMandatoryD", + "doc_type":"api", + "kw":"Querying Summary Information About VBS Backups (Native OpenStack V3 API),VBS Backups,API Reference", + "title":"Querying Summary Information About VBS Backups (Native OpenStack V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0020237259.html", + "product_code":"vbs", + "code":"11", + "des":"This API is used to query the details about VBS backups.URI formatGET /v2/{project_id}/backups/detailGET /v2/{project_id}/backups/detailParameter descriptionParameterMand", + "doc_type":"api", + "kw":"Querying Details About VBS Backups (Native OpenStack API),VBS Backups,API Reference", + "title":"Querying Details About VBS Backups (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0143705536.html", + "product_code":"vbs", + "code":"12", + "des":"This API is used to query the details about VBS backups.URI formatGET /v3/{project_id}/backups/detailGET /v3/{project_id}/backups/detailParameter descriptionParameterMand", + "doc_type":"api", + "kw":"Querying Details About VBS Backups (Native OpenStack V3 API),VBS Backups,API Reference", + "title":"Querying Details About VBS Backups (Native OpenStack V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0020237260.html", + "product_code":"vbs", + "code":"13", + "des":"This API is used to query details about a VBS backup.URI formatGET /v2/{project_id}/backups/{backup_id}GET /v2/{project_id}/backups/{backup_id}Parameter descriptionParame", + "doc_type":"api", + "kw":"Querying Details About a VBS Backup (Native OpenStack API),VBS Backups,API Reference", + "title":"Querying Details About a VBS Backup (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0143705537.html", + "product_code":"vbs", + "code":"14", + "des":"This API is used to query details about a VBS backup.URI formatGET /v3/{project_id}/backups/{backup_id}GET /v3/{project_id}/backups/{backup_id}Parameter descriptionParame", + "doc_type":"api", + "kw":"Querying Details About a VBS Backup (Native OpenStack V3 API),VBS Backups,API Reference", + "title":"Querying Details About a VBS Backup (Native OpenStack V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0020237251.html", + "product_code":"vbs", + "code":"15", + "des":"This API is used to query the execution status of a job, such as VBS backup creation, VBS backup deletion, and VBS backup-based disk restoration.URI formatGET /v1/{projec", + "doc_type":"api", + "kw":"Querying the Job Status,VBS Backups,API Reference", + "title":"Querying the Job Status", + "githuburl":"" + }, + { + "uri":"en-us_topic_0049453221.html", + "product_code":"vbs", + "code":"16", + "des":"This API is used to delete a VBS backup.URI formatDELETE /v2/{project_id}/backups/{backup_id}DELETE /v2/{project_id}/backups/{backup_id}Parameter descriptionParameterMand", + "doc_type":"api", + "kw":"Deleting a VBS Backup (Native OpenStack API),VBS Backups,API Reference", + "title":"Deleting a VBS Backup (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0143705538.html", + "product_code":"vbs", + "code":"17", + "des":"This API is used to delete a VBS backup.URI formatDELETE /v3/{project_id}/backups/{backup_id}DELETE /v3/{project_id}/backups/{backup_id}Parameter descriptionParameterMand", + "doc_type":"api", + "kw":"Deleting a VBS Backup (Native OpenStack V3 API),VBS Backups,API Reference", + "title":"Deleting a VBS Backup (Native OpenStack V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0067142129.html", + "product_code":"vbs", + "code":"18", + "des":"This API is used to restore a disk using a VBS backup.URI formatPOST /v2/{project_id}/backups/{backup_id}/restorePOST /v2/{project_id}/backups/{backup_id}/restoreParamete", + "doc_type":"api", + "kw":"Restoring a Disk Using a VBS Backup (Native OpenStack API),VBS Backups,API Reference", + "title":"Restoring a Disk Using a VBS Backup (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0143705539.html", + "product_code":"vbs", + "code":"19", + "des":"This API is used to restore a disk using a VBS backup.URI formatPOST /v3/{project_id}/backups/{backup_id}/restorePOST /v3/{project_id}/backups/{backup_id}/restoreParamete", + "doc_type":"api", + "kw":"Restoring a Disk Using a VBS Backup (Native OpenStack V3 API),VBS Backups,API Reference", + "title":"Restoring a Disk Using a VBS Backup (Native OpenStack V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0078214151.html", + "product_code":"vbs", + "code":"20", + "des":"This API is used to share a backup to another project.URI formatPOST /v2/{project_id}/os-vendor-backup-sharingPOST /v2/{project_id}/os-vendor-backup-sharingParameter desc", + "doc_type":"api", + "kw":"Sharing a Backup,VBS Backups,API Reference", + "title":"Sharing a Backup", + "githuburl":"" + }, + { + "uri":"en-us_topic_0078214152.html", + "product_code":"vbs", + "code":"21", + "des":"This API is used to cancel the sharing of a backup.URI formatDELETE /v2/{project_id}/os-vendor-backup-sharing/{id}DELETE /v2/{project_id}/os-vendor-backup-sharing/{id}Par", + "doc_type":"api", + "kw":"Canceling Sharing of a Backup,VBS Backups,API Reference", + "title":"Canceling Sharing of a Backup", + "githuburl":"" + }, + { + "uri":"en-us_topic_0078214153.html", + "product_code":"vbs", + "code":"22", + "des":"This API is used to query backup sharings.URI formatGET /v2/{project_id}/os-vendor-backup-sharing/detailGET /v2/{project_id}/os-vendor-backup-sharing/detailParameter desc", + "doc_type":"api", + "kw":"Querying Backup Sharings,VBS Backups,API Reference", + "title":"Querying Backup Sharings", + "githuburl":"" + }, + { + "uri":"en-us_topic_0078214154.html", + "product_code":"vbs", + "code":"23", + "des":"This API is used to count backup sharings with conditions.URI formatGET /v2/{project_id}/os-vendor-backup-sharing/countGET /v2/{project_id}/os-vendor-backup-sharing/count", + "doc_type":"api", + "kw":"Counting Backup Sharings,VBS Backups,API Reference", + "title":"Counting Backup Sharings", + "githuburl":"" + }, + { + "uri":"en-us_topic_0078214155.html", + "product_code":"vbs", + "code":"24", + "des":"This API is used to query details about a backup sharing.URI formatGET /v2/{project_id}/os-vendor-backup-sharing/{id}GET /v2/{project_id}/os-vendor-backup-sharing/{id}Par", + "doc_type":"api", + "kw":"Querying Details About a Backup Sharing,VBS Backups,API Reference", + "title":"Querying Details About a Backup Sharing", + "githuburl":"" + }, + { + "uri":"en-us_topic_0113236392.html", + "product_code":"vbs", + "code":"25", + "des":"This API is used to query tenant quotas.URIGET /v2/{project_id}/cloudbackups/quotaGET /v2/{project_id}/cloudbackups/quotaParameter descriptionParameterMandatoryDescriptio", + "doc_type":"api", + "kw":"Querying Quotas,VBS Backups,API Reference", + "title":"Querying Quotas", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043410516.html", + "product_code":"vbs", + "code":"26", + "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 Policies", + "title":"Backup Policies", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043410517.html", + "product_code":"vbs", + "code":"27", + "des":"This API is used to create a backup policy. A tenant can create a maximum of 10 backup policies.URI formatPOST /v2/{project_id}/backuppolicyPOST /v2/{project_id}/backuppo", + "doc_type":"api", + "kw":"Creating a Backup Policy,Backup Policies,API Reference", + "title":"Creating a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043410558.html", + "product_code":"vbs", + "code":"28", + "des":"This API is used to query all backup policies of a tenant.URI formatGET /v2/{project_id}/backuppolicyGET /v2/{project_id}/backuppolicyParameter descriptionParameterMandat", + "doc_type":"api", + "kw":"Querying Backup Policies,Backup Policies,API Reference", + "title":"Querying Backup Policies", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043410559.html", + "product_code":"vbs", + "code":"29", + "des":"This API is used to modify a backup policy.URI formatPUT /v2/{project_id}/backuppolicy/{policy_id}PUT /v2/{project_id}/backuppolicy/{policy_id}Parameter descriptionParame", + "doc_type":"api", + "kw":"Modifying a Backup Policy,Backup Policies,API Reference", + "title":"Modifying a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043410560.html", + "product_code":"vbs", + "code":"30", + "des":"This API is used to delete a backup policy.URI formatDELETE /v2/{project_id}/backuppolicy/{policy_id}DELETE /v2/{project_id}/backuppolicy/{policy_id}Parameter description", + "doc_type":"api", + "kw":"Deleting a Backup Policy,Backup Policies,API Reference", + "title":"Deleting a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043410561.html", + "product_code":"vbs", + "code":"31", + "des":"This API is used to associate one or more resources with a backup policy.URI formatPOST /v2/{project_id}/backuppolicyresourcesPOST /v2/{project_id}/backuppolicyresourcesP", + "doc_type":"api", + "kw":"Associating Resources with a Backup Policy,Backup Policies,API Reference", + "title":"Associating Resources with a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043410562.html", + "product_code":"vbs", + "code":"32", + "des":"This API is used to disassociate one or more resources from a backup policy.URI formatPOST /v2/{project_id}/backuppolicyresources/{policy_id}/deleted_resourcesPOST /v2/{p", + "doc_type":"api", + "kw":"Disassociating Resources from a Backup Policy,Backup Policies,API Reference", + "title":"Disassociating Resources from a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043410563.html", + "product_code":"vbs", + "code":"33", + "des":"This API is used to back up resources associated with a backup policy at once.URI formatPOST /v2/{project_id}/backuppolicy/{policy_id}/actionPOST /v2/{project_id}/backupp", + "doc_type":"api", + "kw":"Executing a Backup Policy At Once,Backup Policies,API Reference", + "title":"Executing a Backup Policy At Once", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043410564.html", + "product_code":"vbs", + "code":"34", + "des":"This API is used to enable or disable a backup policy. After a backup policy is enabled, it will be scheduled based on the specified time. After a backup policy is disabl", + "doc_type":"api", + "kw":"Enabling or Disabling a Backup Policy,Backup Policies,API Reference", + "title":"Enabling or Disabling a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0043430177.html", + "product_code":"vbs", + "code":"35", + "des":"This API is used to query the status of backup jobs triggered by a backup policy.URI formatGET /v2/{project_id}/backuppolicy/{policy_id}/backuptasksGET /v2/{project_id}/b", + "doc_type":"api", + "kw":"Querying Backup Jobs Triggered by a Backup Policy,Backup Policies,API Reference", + "title":"Querying Backup Jobs Triggered by a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098527676.html", + "product_code":"vbs", + "code":"36", + "des":"This API is used to add a tag to a backup policy.URI formatPOST /v2/{project_id}/backuppolicy/{policy_id}/tagsPOST /v2/{project_id}/backuppolicy/{policy_id}/tagsParameter", + "doc_type":"api", + "kw":"Adding a Tag to a Backup Policy,Backup Policies,API Reference", + "title":"Adding a Tag to a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0098527677.html", + "product_code":"vbs", + "code":"37", + "des":"This API is used to remove a tag from a backup policy.URI formatDELETE /v2/{project_id}/backuppolicy/{policy_id}/tags/{key}DELETE /v2/{project_id}/backuppolicy/{policy_id", + "doc_type":"api", + "kw":"Removing a Tag from a Backup Policy,Backup Policies,API Reference", + "title":"Removing a Tag from a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0067142130.html", + "product_code":"vbs", + "code":"38", + "des":"This API is used to query tags of all backup policies.URI formatGET /v2/{project_id}/backuppolicy/tagsGET /v2/{project_id}/backuppolicy/tagsParameter descriptionParameter", + "doc_type":"api", + "kw":"Querying All Backup Policy Tags,Backup Policies,API Reference", + "title":"Querying All Backup Policy Tags", + "githuburl":"" + }, + { + "uri":"en-us_topic_0067142131.html", + "product_code":"vbs", + "code":"39", + "des":"This API is used to query the tags of a specific backup policy.URI formatGET /v2/{project_id}/backuppolicy/{policy_id}/tagsGET /v2/{project_id}/backuppolicy/{policy_id}/t", + "doc_type":"api", + "kw":"Querying Tags of a Backup Policy,Backup Policies,API Reference", + "title":"Querying Tags of a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0067142132.html", + "product_code":"vbs", + "code":"40", + "des":"This API is used to update or remove the tags of a backup policy.URI formatPOST /v2/{project_id}/backuppolicy/{policy_id}/tags/actionPOST /v2/{project_id}/backuppolicy/{p", + "doc_type":"api", + "kw":"Batch Updating or Removing Tags of a Backup Policy,Backup Policies,API Reference", + "title":"Batch Updating or Removing Tags of a Backup Policy", + "githuburl":"" + }, + { + "uri":"en-us_topic_0067142133.html", + "product_code":"vbs", + "code":"41", + "des":"This API is used to query backup policies by tag.URI formatPOST /v2/{project_id}/backuppolicy/resource_instances/actionPOST /v2/{project_id}/backuppolicy/resource_instanc", + "doc_type":"api", + "kw":"Querying Backup Policies by Tag,Backup Policies,API Reference", + "title":"Querying Backup Policies by Tag", + "githuburl":"" + }, + { + "uri":"en-us_topic_0022472082.html", + "product_code":"vbs", + "code":"42", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Appendix", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"en-us_topic_0134480835.html", + "product_code":"vbs", + "code":"43", + "des":"NormalStatus CodeDescription200 OKSpecifies the normal response for the GET and PUT operations.201 CreatedSpecifies the normal response for the POST operation.202 Accepte", + "doc_type":"api", + "kw":"Status Codes,Appendix,API Reference", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"en-us_topic_0022472083.html", + "product_code":"vbs", + "code":"44", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Error Codes,Appendix,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"en-us_topic_0024723797.html", + "product_code":"vbs", + "code":"45", + "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/vbs/api-ref/CLASS.TXT.json b/docs/vbs/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..accfa8452 --- /dev/null +++ b/docs/vbs/api-ref/CLASS.TXT.json @@ -0,0 +1,407 @@ +[ + { + "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":"vbs", + "title":"API Usage Guidelines", + "uri":"en-us_topic_0061309333.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":"vbs", + "title":"API Description", + "uri":"en-us_topic_0134476439.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":"vbs", + "title":"VBS Backups", + "uri":"en-us_topic_0020237254.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"This API is used to create a VBS backup.If the API is successfully called, the backup task is successfully delivered. You can query the backup status by using the API for", + "product_code":"vbs", + "title":"Creating a VBS Backup", + "uri":"en-us_topic_0020237255.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This API is used to delete a VBS backup. This API is deprecated. You are advised to use the API described in Deleting a VBS Backup (Native OpenStack API) to delete a back", + "product_code":"vbs", + "title":"Deleting a VBS Backup (Deprecated)", + "uri":"en-us_topic_0020237256.html", + "doc_type":"api", + "p_code":"3", + "code":"5" + }, + { + "desc":"This API is used to restore a disk using a VBS backup.URI formatPOST /v2/{project_id}/cloudbackups/{backup_id}/restorePOST /v2/{project_id}/cloudbackups/{backup_id}/res", + "product_code":"vbs", + "title":"Restoring a Disk Using a VBS Backup", + "uri":"en-us_topic_0020237257.html", + "doc_type":"api", + "p_code":"3", + "code":"6" + }, + { + "desc":"This API is used to create a VBS backup.URI formatPOST /v2/{project_id}/backupsPOST /v2/{project_id}/backupsParameter descriptionParameterMandatoryDescriptionproject_idYe", + "product_code":"vbs", + "title":"Creating a VBS Backup (Native OpenStack API)", + "uri":"en-us_topic_0060614329.html", + "doc_type":"api", + "p_code":"3", + "code":"7" + }, + { + "desc":"This API is used to create a VBS backup.URI formatPOST /v3/{project_id}/backupsPOST /v3/{project_id}/backupsParameter descriptionParameterMandatoryDescriptionproject_idYe", + "product_code":"vbs", + "title":"Creating a VBS Backup (Native OpenStack V3 API)", + "uri":"en-us_topic_0143705534.html", + "doc_type":"api", + "p_code":"3", + "code":"8" + }, + { + "desc":"This API is used to query summary information about VBS backups.URI formatGET /v2/{project_id}/backupsGET /v2/{project_id}/backupsParameter descriptionParameterMandatoryD", + "product_code":"vbs", + "title":"Querying Summary Information About VBS Backups (Native OpenStack API)", + "uri":"en-us_topic_0020237258.html", + "doc_type":"api", + "p_code":"3", + "code":"9" + }, + { + "desc":"This API is used to query summary information about VBS backups.URI formatGET /v3/{project_id}/backupsGET /v3/{project_id}/backupsParameter descriptionParameterMandatoryD", + "product_code":"vbs", + "title":"Querying Summary Information About VBS Backups (Native OpenStack V3 API)", + "uri":"en-us_topic_0143705535.html", + "doc_type":"api", + "p_code":"3", + "code":"10" + }, + { + "desc":"This API is used to query the details about VBS backups.URI formatGET /v2/{project_id}/backups/detailGET /v2/{project_id}/backups/detailParameter descriptionParameterMand", + "product_code":"vbs", + "title":"Querying Details About VBS Backups (Native OpenStack API)", + "uri":"en-us_topic_0020237259.html", + "doc_type":"api", + "p_code":"3", + "code":"11" + }, + { + "desc":"This API is used to query the details about VBS backups.URI formatGET /v3/{project_id}/backups/detailGET /v3/{project_id}/backups/detailParameter descriptionParameterMand", + "product_code":"vbs", + "title":"Querying Details About VBS Backups (Native OpenStack V3 API)", + "uri":"en-us_topic_0143705536.html", + "doc_type":"api", + "p_code":"3", + "code":"12" + }, + { + "desc":"This API is used to query details about a VBS backup.URI formatGET /v2/{project_id}/backups/{backup_id}GET /v2/{project_id}/backups/{backup_id}Parameter descriptionParame", + "product_code":"vbs", + "title":"Querying Details About a VBS Backup (Native OpenStack API)", + "uri":"en-us_topic_0020237260.html", + "doc_type":"api", + "p_code":"3", + "code":"13" + }, + { + "desc":"This API is used to query details about a VBS backup.URI formatGET /v3/{project_id}/backups/{backup_id}GET /v3/{project_id}/backups/{backup_id}Parameter descriptionParame", + "product_code":"vbs", + "title":"Querying Details About a VBS Backup (Native OpenStack V3 API)", + "uri":"en-us_topic_0143705537.html", + "doc_type":"api", + "p_code":"3", + "code":"14" + }, + { + "desc":"This API is used to query the execution status of a job, such as VBS backup creation, VBS backup deletion, and VBS backup-based disk restoration.URI formatGET /v1/{projec", + "product_code":"vbs", + "title":"Querying the Job Status", + "uri":"en-us_topic_0020237251.html", + "doc_type":"api", + "p_code":"3", + "code":"15" + }, + { + "desc":"This API is used to delete a VBS backup.URI formatDELETE /v2/{project_id}/backups/{backup_id}DELETE /v2/{project_id}/backups/{backup_id}Parameter descriptionParameterMand", + "product_code":"vbs", + "title":"Deleting a VBS Backup (Native OpenStack API)", + "uri":"en-us_topic_0049453221.html", + "doc_type":"api", + "p_code":"3", + "code":"16" + }, + { + "desc":"This API is used to delete a VBS backup.URI formatDELETE /v3/{project_id}/backups/{backup_id}DELETE /v3/{project_id}/backups/{backup_id}Parameter descriptionParameterMand", + "product_code":"vbs", + "title":"Deleting a VBS Backup (Native OpenStack V3 API)", + "uri":"en-us_topic_0143705538.html", + "doc_type":"api", + "p_code":"3", + "code":"17" + }, + { + "desc":"This API is used to restore a disk using a VBS backup.URI formatPOST /v2/{project_id}/backups/{backup_id}/restorePOST /v2/{project_id}/backups/{backup_id}/restoreParamete", + "product_code":"vbs", + "title":"Restoring a Disk Using a VBS Backup (Native OpenStack API)", + "uri":"en-us_topic_0067142129.html", + "doc_type":"api", + "p_code":"3", + "code":"18" + }, + { + "desc":"This API is used to restore a disk using a VBS backup.URI formatPOST /v3/{project_id}/backups/{backup_id}/restorePOST /v3/{project_id}/backups/{backup_id}/restoreParamete", + "product_code":"vbs", + "title":"Restoring a Disk Using a VBS Backup (Native OpenStack V3 API)", + "uri":"en-us_topic_0143705539.html", + "doc_type":"api", + "p_code":"3", + "code":"19" + }, + { + "desc":"This API is used to share a backup to another project.URI formatPOST /v2/{project_id}/os-vendor-backup-sharingPOST /v2/{project_id}/os-vendor-backup-sharingParameter desc", + "product_code":"vbs", + "title":"Sharing a Backup", + "uri":"en-us_topic_0078214151.html", + "doc_type":"api", + "p_code":"3", + "code":"20" + }, + { + "desc":"This API is used to cancel the sharing of a backup.URI formatDELETE /v2/{project_id}/os-vendor-backup-sharing/{id}DELETE /v2/{project_id}/os-vendor-backup-sharing/{id}Par", + "product_code":"vbs", + "title":"Canceling Sharing of a Backup", + "uri":"en-us_topic_0078214152.html", + "doc_type":"api", + "p_code":"3", + "code":"21" + }, + { + "desc":"This API is used to query backup sharings.URI formatGET /v2/{project_id}/os-vendor-backup-sharing/detailGET /v2/{project_id}/os-vendor-backup-sharing/detailParameter desc", + "product_code":"vbs", + "title":"Querying Backup Sharings", + "uri":"en-us_topic_0078214153.html", + "doc_type":"api", + "p_code":"3", + "code":"22" + }, + { + "desc":"This API is used to count backup sharings with conditions.URI formatGET /v2/{project_id}/os-vendor-backup-sharing/countGET /v2/{project_id}/os-vendor-backup-sharing/count", + "product_code":"vbs", + "title":"Counting Backup Sharings", + "uri":"en-us_topic_0078214154.html", + "doc_type":"api", + "p_code":"3", + "code":"23" + }, + { + "desc":"This API is used to query details about a backup sharing.URI formatGET /v2/{project_id}/os-vendor-backup-sharing/{id}GET /v2/{project_id}/os-vendor-backup-sharing/{id}Par", + "product_code":"vbs", + "title":"Querying Details About a Backup Sharing", + "uri":"en-us_topic_0078214155.html", + "doc_type":"api", + "p_code":"3", + "code":"24" + }, + { + "desc":"This API is used to query tenant quotas.URIGET /v2/{project_id}/cloudbackups/quotaGET /v2/{project_id}/cloudbackups/quotaParameter descriptionParameterMandatoryDescriptio", + "product_code":"vbs", + "title":"Querying Quotas", + "uri":"en-us_topic_0113236392.html", + "doc_type":"api", + "p_code":"3", + "code":"25" + }, + { + "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":"vbs", + "title":"Backup Policies", + "uri":"en-us_topic_0043410516.html", + "doc_type":"api", + "p_code":"2", + "code":"26" + }, + { + "desc":"This API is used to create a backup policy. A tenant can create a maximum of 10 backup policies.URI formatPOST /v2/{project_id}/backuppolicyPOST /v2/{project_id}/backuppo", + "product_code":"vbs", + "title":"Creating a Backup Policy", + "uri":"en-us_topic_0043410517.html", + "doc_type":"api", + "p_code":"26", + "code":"27" + }, + { + "desc":"This API is used to query all backup policies of a tenant.URI formatGET /v2/{project_id}/backuppolicyGET /v2/{project_id}/backuppolicyParameter descriptionParameterMandat", + "product_code":"vbs", + "title":"Querying Backup Policies", + "uri":"en-us_topic_0043410558.html", + "doc_type":"api", + "p_code":"26", + "code":"28" + }, + { + "desc":"This API is used to modify a backup policy.URI formatPUT /v2/{project_id}/backuppolicy/{policy_id}PUT /v2/{project_id}/backuppolicy/{policy_id}Parameter descriptionParame", + "product_code":"vbs", + "title":"Modifying a Backup Policy", + "uri":"en-us_topic_0043410559.html", + "doc_type":"api", + "p_code":"26", + "code":"29" + }, + { + "desc":"This API is used to delete a backup policy.URI formatDELETE /v2/{project_id}/backuppolicy/{policy_id}DELETE /v2/{project_id}/backuppolicy/{policy_id}Parameter description", + "product_code":"vbs", + "title":"Deleting a Backup Policy", + "uri":"en-us_topic_0043410560.html", + "doc_type":"api", + "p_code":"26", + "code":"30" + }, + { + "desc":"This API is used to associate one or more resources with a backup policy.URI formatPOST /v2/{project_id}/backuppolicyresourcesPOST /v2/{project_id}/backuppolicyresourcesP", + "product_code":"vbs", + "title":"Associating Resources with a Backup Policy", + "uri":"en-us_topic_0043410561.html", + "doc_type":"api", + "p_code":"26", + "code":"31" + }, + { + "desc":"This API is used to disassociate one or more resources from a backup policy.URI formatPOST /v2/{project_id}/backuppolicyresources/{policy_id}/deleted_resourcesPOST /v2/{p", + "product_code":"vbs", + "title":"Disassociating Resources from a Backup Policy", + "uri":"en-us_topic_0043410562.html", + "doc_type":"api", + "p_code":"26", + "code":"32" + }, + { + "desc":"This API is used to back up resources associated with a backup policy at once.URI formatPOST /v2/{project_id}/backuppolicy/{policy_id}/actionPOST /v2/{project_id}/backupp", + "product_code":"vbs", + "title":"Executing a Backup Policy At Once", + "uri":"en-us_topic_0043410563.html", + "doc_type":"api", + "p_code":"26", + "code":"33" + }, + { + "desc":"This API is used to enable or disable a backup policy. After a backup policy is enabled, it will be scheduled based on the specified time. After a backup policy is disabl", + "product_code":"vbs", + "title":"Enabling or Disabling a Backup Policy", + "uri":"en-us_topic_0043410564.html", + "doc_type":"api", + "p_code":"26", + "code":"34" + }, + { + "desc":"This API is used to query the status of backup jobs triggered by a backup policy.URI formatGET /v2/{project_id}/backuppolicy/{policy_id}/backuptasksGET /v2/{project_id}/b", + "product_code":"vbs", + "title":"Querying Backup Jobs Triggered by a Backup Policy", + "uri":"en-us_topic_0043430177.html", + "doc_type":"api", + "p_code":"26", + "code":"35" + }, + { + "desc":"This API is used to add a tag to a backup policy.URI formatPOST /v2/{project_id}/backuppolicy/{policy_id}/tagsPOST /v2/{project_id}/backuppolicy/{policy_id}/tagsParameter", + "product_code":"vbs", + "title":"Adding a Tag to a Backup Policy", + "uri":"en-us_topic_0098527676.html", + "doc_type":"api", + "p_code":"26", + "code":"36" + }, + { + "desc":"This API is used to remove a tag from a backup policy.URI formatDELETE /v2/{project_id}/backuppolicy/{policy_id}/tags/{key}DELETE /v2/{project_id}/backuppolicy/{policy_id", + "product_code":"vbs", + "title":"Removing a Tag from a Backup Policy", + "uri":"en-us_topic_0098527677.html", + "doc_type":"api", + "p_code":"26", + "code":"37" + }, + { + "desc":"This API is used to query tags of all backup policies.URI formatGET /v2/{project_id}/backuppolicy/tagsGET /v2/{project_id}/backuppolicy/tagsParameter descriptionParameter", + "product_code":"vbs", + "title":"Querying All Backup Policy Tags", + "uri":"en-us_topic_0067142130.html", + "doc_type":"api", + "p_code":"26", + "code":"38" + }, + { + "desc":"This API is used to query the tags of a specific backup policy.URI formatGET /v2/{project_id}/backuppolicy/{policy_id}/tagsGET /v2/{project_id}/backuppolicy/{policy_id}/t", + "product_code":"vbs", + "title":"Querying Tags of a Backup Policy", + "uri":"en-us_topic_0067142131.html", + "doc_type":"api", + "p_code":"26", + "code":"39" + }, + { + "desc":"This API is used to update or remove the tags of a backup policy.URI formatPOST /v2/{project_id}/backuppolicy/{policy_id}/tags/actionPOST /v2/{project_id}/backuppolicy/{p", + "product_code":"vbs", + "title":"Batch Updating or Removing Tags of a Backup Policy", + "uri":"en-us_topic_0067142132.html", + "doc_type":"api", + "p_code":"26", + "code":"40" + }, + { + "desc":"This API is used to query backup policies by tag.URI formatPOST /v2/{project_id}/backuppolicy/resource_instances/actionPOST /v2/{project_id}/backuppolicy/resource_instanc", + "product_code":"vbs", + "title":"Querying Backup Policies by Tag", + "uri":"en-us_topic_0067142133.html", + "doc_type":"api", + "p_code":"26", + "code":"41" + }, + { + "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":"vbs", + "title":"Appendix", + "uri":"en-us_topic_0022472082.html", + "doc_type":"api", + "p_code":"", + "code":"42" + }, + { + "desc":"NormalStatus CodeDescription200 OKSpecifies the normal response for the GET and PUT operations.201 CreatedSpecifies the normal response for the POST operation.202 Accepte", + "product_code":"vbs", + "title":"Status Codes", + "uri":"en-us_topic_0134480835.html", + "doc_type":"api", + "p_code":"42", + "code":"43" + }, + { + "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":"vbs", + "title":"Error Codes", + "uri":"en-us_topic_0022472083.html", + "doc_type":"api", + "p_code":"42", + "code":"44" + }, + { + "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":"vbs", + "title":"Change History", + "uri":"en-us_topic_0024723797.html", + "doc_type":"api", + "p_code":"", + "code":"45" + } +] \ No newline at end of file diff --git a/docs/vbs/api-ref/PARAMETERS.txt b/docs/vbs/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/vbs/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/vbs/api-ref/en-us_topic_0020237251.html b/docs/vbs/api-ref/en-us_topic_0020237251.html new file mode 100644 index 000000000..50b5568d3 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0020237251.html @@ -0,0 +1,243 @@ + + +

Querying the Job Status

+

Function

This API is used to query the execution status of a job, such as VBS backup creation, VBS backup deletion, and VBS backup-based disk restoration.

+
+

URI

  • URI format

    GET /v1/{project_id}/jobs/{job_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    job_id

    +

    Yes

    +

    Job ID

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    string

    +

    Job status

    +
    • SUCCESS: The job is successfully executed.
    • RUNNING: The job is in progress.
    • FAIL: The job failed.
    • INIT: The job is being initialized.
    +

    entities

    +

    map<string, string>

    +

    Response to the job. Each type of job has different contents.

    +

    job_id

    +

    string

    +

    Job ID

    +

    job_type

    +

    string

    +

    Job type

    +

    begin_time

    +

    string

    +

    Time when the job started

    +

    end_time

    +

    string

    +

    Time when the job finished

    +

    error_code

    +

    string

    +

    Error code returned after the job execution fails

    +

    fail_reason

    +

    string

    +

    Cause of the execution failure

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +

    sub_jobs

    +

    list

    +

    Execution information about a sub-job. When no sub-job exists, the value of this parameter is left blank. The structure of each sub-job is similar to that of the parent job.

    +
    +
    +
  • Example response
    {
+    "status": "SUCCESS",
+    "entities": {
+        "bks_create_volume_name": "autobk_volume",
+        "backup_id": "ba5401a2-7cd2-4c01-8c0d-c936ab412d6d",
+        "volume_id": "7e5fdc5a-5e36-4b22-8bcc-7f17037290cc",
+        "snapshot_id": "a77a96bf-dd18-40bf-a446-fdcefc1719ec"
+    },
+    "job_id": "4010b39b5281d3590152874bfa3b1604",
+    "job_type": "bksCreateBackup",
+    "begin_time": "2016-01-28T16:14:09.466Z",
+    "end_time": "2016-01-28T16:25:27.690Z",
+    "error_code": null,
+    "fail_reason": null
+}
    +

    or

    +
    {
+"error": {
+"message": "XXXX",
+"code": "XXX"
+}
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0020237254.html b/docs/vbs/api-ref/en-us_topic_0020237254.html new file mode 100644 index 000000000..b7798fb10 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0020237254.html @@ -0,0 +1,57 @@ + + +

VBS Backups

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0020237255.html b/docs/vbs/api-ref/en-us_topic_0020237255.html new file mode 100644 index 000000000..f3466d515 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0020237255.html @@ -0,0 +1,309 @@ + + +

Creating a VBS Backup

+

Function

This API is used to create a VBS backup.

+

If the API is successfully called, the backup task is successfully delivered. You can query the backup status by using the API for Querying Details About a VBS Backup (Native OpenStack API).

+
+

URI

  • URI format

    POST /v2/{project_id}/cloudbackups

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    backup

    +

    Yes

    +

    dict

    +

    Backup to be created. For details, see the backup field description.

    +
    +
    +
  • backup field description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    volume_id

    +

    Yes

    +

    string

    +

    ID of the disk to be backed up

    +

    snapshot_id

    +

    No

    +

    string

    +

    Snapshot ID of the disk to be backed up

    +

    name

    +

    Yes

    +

    string

    +

    Backup name. The value is a string of 1 to 64 characters that can contain digits, letters, underscores (_), and hyphens (-), not starting with auto.

    +

    description

    +

    No

    +

    string

    +

    Backup description. The value is a string of 1 to 64 characters and cannot contain the less-than sign (<) or greater-than sign (>).

    +

    tags

    +

    No

    +

    list<dict>

    +

    List of tags to be configured for the backup resources. For details, see the tag field description.

    +

    extend_param

    +

    No

    +

    map<string,string>

    +

    Additional information for creating the VBS backup. The FullBackup field is supported. If FullBackup is set to true, full backup will be adopted this time. If FullBackup is set to false or the parameter is left blank, incremental backup will be adopted.

    +
    +
    +
    • tag field description +
      + + + + + + + + + + + + + + + + +

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      key

      +

      Yes

      +

      string

      +

      Tag key. A tag key consists of up to 36 characters. A tag key cannot contain non-printable ASCII characters (0-31) and the following special characters: =*<>\,|/

      +

      value

      +

      Yes

      +

      string

      +

      Tag value. A tag value consists of 0 to 43 characters. A tag key cannot contain non-printable ASCII characters (0-31) and the following special characters: =*<>\,|/

      +
      +
      +
    +

    When you use Instant Restore for the first time and the to-be-restored disk has been backed up before the feature is enabled, you need to perform a full backup on the disk on the console or directly call the API for creating a full backup (POST /v2/{tenant_id}/cloudbackups). After doing this, the disk backups generated through APIs will support this feature.

    +
    +
+
  • Example request
    {
+    "backup": {
+        "volume_id": "c68ae7fb-0aa5-4a97-ab01-ed02c5b7e768",
+        "snapshot_id": null,
+        "name": "backup1",
+        "description": "Backup_Demo",
+        "tags":[{
+            "key":"key",
+            "value":"value"
+         }],
+        "extend_param": {"FullBackup": "true"}
+    }
+}
    +
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    string

    +

    Job ID

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+"job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+}
    +

    or

    +
    {
+"error": {
+"message": "XXXX",
+"code": "XXX"
+}
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0020237256.html b/docs/vbs/api-ref/en-us_topic_0020237256.html new file mode 100644 index 000000000..dcc0d59f3 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0020237256.html @@ -0,0 +1,174 @@ + + +

Deleting a VBS Backup (Deprecated)

+

Function

This API is used to delete a VBS backup. This API is deprecated. You are advised to use the API described in Deleting a VBS Backup (Native OpenStack API) to delete a backup.

+
+

URI

  • URI format

    POST /v2/{project_id}/cloudbackups/{backup_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    backup_id

    +

    Yes

    +

    ID of the backup to be deleted

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    string

    +

    Job ID

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+"job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+}
    +

    or

    +
    {
+"error": {
+"message": "XXXX",
+"code": "XXX"
+}
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0020237257.html b/docs/vbs/api-ref/en-us_topic_0020237257.html new file mode 100644 index 000000000..457efebd4 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0020237257.html @@ -0,0 +1,212 @@ + + +

Restoring a Disk Using a VBS Backup

+

Function

This API is used to restore a disk using a VBS backup.

+
+

URI

  • URI format

    POST /v2/{project_id}/cloudbackups/{backup_id}/restore

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    backup_id

    +

    Yes

    +

    ID of the backup used to restore a disk

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    restore

    +

    Yes

    +

    dict

    +

    Restoration operation

    +

    volume_id

    +

    Yes

    +

    string

    +

    ID of the disk to be restored

    +
    +
    +
+
  • Example request
    {
+"restore":{
+"volume_id":"c96e4a94-927a-425c-8795-63f9964cfebd"
+}
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    job_id

    +

    string

    +

    Job ID

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+"job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+}
    +

    or

    +
    {
+"error": {
+"message": "XXXX",
+"code": "XXX"
+}
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0020237258.html b/docs/vbs/api-ref/en-us_topic_0020237258.html new file mode 100644 index 000000000..eaffb6095 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0020237258.html @@ -0,0 +1,307 @@ + + +

Querying Summary Information About VBS Backups (Native OpenStack API)

+

Function

This API is used to query summary information about VBS backups.

+
+

URI

  • URI format

    GET /v2/{project_id}/backups

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
  • Request filter parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    No

    +

    string

    +

    Name of the backups to be queried. This parameter is used to query the backups whose names are specified character strings.

    +

    status

    +

    No

    +

    string

    +

    Status of the backups to be queried. This parameter is used to query the backups in a specified state. The value can be available, error, restoring, creating, deleting, or error_restoring.

    +

    offset

    +

    No

    +

    int

    +

    Offset of the queried information

    +

    limit

    +

    No

    +

    int

    +

    Maximum number of query results that can be returned

    +

    volume_id

    +

    No

    +

    string

    +

    Disk ID of the backups to be queried. It is used to query the backups for specific disks.

    +
    +
    +
  • Example request
    GET /v2/{project_id}/backups?name=backup&status=error&limit=10&volume_id=7d7c6fbe-d7ee-4b4d-8bae-bdd08b5604bb
    +

    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backups

    +

    list<dict>

    +

    Backup list returned by the query request. For details, see the backup field description.

    +
    +
    +
  • backup field description +
    + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    string

    +

    Backup ID

    +

    links

    +

    list<dict>

    +

    Backup URL. For details, see the links field description.

    +

    name

    +

    string

    +

    Backup name

    +

    backups_links

    +

    list<dict>

    +

    Only part of a tenant's backup information is queried, such as query by page with the limit specified and when the number of backups exceeds 1000.

    +
    +
    +
  • links field description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    string

    +

    URL of the last backup queried

    +

    rel

    +

    string

    +

    Relationship between the query result and href. The value next indicates that some backups are not obtained.

    +
    +
    +
  • Example response
    {
+"backups": [
+{
+"id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "bookmark"
+}
+],
+"name": null
+},
+{
+"id": "b3cf7a16-decc-4beb-8077-682737d94a58",
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+"rel": "bookmark"
+}
+],
+"name": null
+}
+],
+"backups_links": [
+    {
+      "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups?limit=1&offset=1&marker=b3cf7a16-decc-4beb-8077-682737d94a58",
+      "rel": "next"
+    }
+  ]
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0020237259.html b/docs/vbs/api-ref/en-us_topic_0020237259.html new file mode 100644 index 000000000..7c864bf2b --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0020237259.html @@ -0,0 +1,620 @@ + + +

Querying Details About VBS Backups (Native OpenStack API)

+

Function

This API is used to query the details about VBS backups.

+
+

URI

  • URI format

    GET /v2/{project_id}/backups/detail

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
  • Request filter parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    No

    +

    string

    +

    Name of the backups to be queried. This parameter is used to query the backups whose names are specified character strings.

    +

    status

    +

    No

    +

    string

    +

    Status of the backups to be queried. This parameter is used to query the backups in a specified state. The value can be available, error, restoring, creating, deleting, or error_restoring.

    +

    sort_key

    +

    No

    +

    string

    +

    Sorts by attribute. Possible values are name, status, container_format, disk_format, size, id, created_at, and updated_at. The default value is created_at. This API uses the natural sort direction of the sort_key attribute.

    +

    sort_dir

    +

    No

    +

    string

    +

    Sorts by a set of one or more sort direction and attribute (sort_key) combinations. If you omit the sort direction in a set, the value defaults to desc.

    +

    offset

    +

    No

    +

    int

    +

    Offset of the queried information

    +

    limit

    +

    No

    +

    int

    +

    Maximum number of query results that can be returned

    +

    volume_id

    +

    No

    +

    string

    +

    Disk ID of the backups to be queried. It is used to query the backups for specific disks.

    +
    +
    +
  • Example request
    GET /v2/{project_id}/backups/detail?name=backup&status=error&limit=10&volume_id=7d7c6fbe-d7ee-4b4d-8bae-bdd08b5604bb
    +

    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backups

    +

    list<dict>

    +

    List of queried backups

    +

    status

    +

    string

    +

    Backup status

    +

    description

    +

    string

    +

    Backup description

    +

    links

    +

    list<dict>

    +

    Backup URL

    +

    availability_zone

    +

    string

    +

    AZ where the backup resides

    +

    volume_id

    +

    string

    +

    Source disk ID of the backup

    +

    fail_reason

    +

    string

    +

    Cause of the backup failure

    +

    id

    +

    string

    +

    Backup ID

    +

    size

    +

    int

    +

    Backup size

    +

    object_count

    +

    int

    +

    Number of objects on Object Storage Service (OBS) for the disk data

    +

    container

    +

    string

    +

    Container of the backup

    +

    name

    +

    string

    +

    Backup name

    +

    created_at

    +

    string

    +

    Backup creation time

    +

    os-bak-tenant-attr:tenant_id

    +

    string

    +

    ID of the project that owns the VBS backup

    +

    service_metadata

    +

    string

    +

    Backup metadata

    +

    updated_at

    +

    string

    +

    Time when the backup was updated

    +

    data_timestamp

    +

    string

    +

    Current time

    +

    has_dependent_backups

    +

    boolean

    +

    Whether a dependent backup exists. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.

    +

    snapshot_id

    +

    string

    +

    ID of the snapshot associated with the backup

    +

    is_incremental

    +

    boolean

    +

    Whether the backup is an incremental backup. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.

    +

    backups_links

    +

    list<dict>

    +

    Only part of a tenant's backup information is queried, such as query by page with the limit specified and when the number of backups exceeds 1000.

    +

    href

    +

    string

    +

    URL of the last backup queried

    +

    rel

    +

    string

    +

    Relationship between the query result and href. The value next indicates that some backups are not obtained.

    +
    +
    +
  • service_metadata parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    DL

    +

    int

    +

    0: non-deduplication and non-compression; 1: deduplication and non-compression; 2: non-deduplication and compression; 3: deduplication and compression If this key is not specified, the value is 0 (non-deduplication and non-compression).

    +

    VK

    +

    string

    +

    Encryption VK of an encrypted volume. The value is a string of 64 characters.

    +

    bootable

    +

    boolean

    +

    Whether the disk is the boot disk

    +

    backupurl

    +

    string

    +

    Backup image ID on the backup system

    +

    SP

    +

    string

    +

    Path name of the backup image in the storage unit

    +

    VMID

    +

    string

    +

    ID of the VM to which the backup image belongs

    +

    ST

    +

    int

    +

    Backup service type. 0: disk backup; 1: VM backup; 4: disk backup copy, 5: VM backup copy. If this tag does not exist, disk backup is specified.

    +

    BT

    +

    int

    +

    Backup storage type

    +

    SS

    +

    int

    +

    Space saving rate

    +

    BP

    +

    string

    +

    Storage unit path

    +

    CMKID

    +

    string

    +

    Specifies the CMK ID of an encrypted volume. The content is UUID and contains 36 characters.

    +

    progress

    +

    int

    +

    Backup progress

    +

    CS

    +

    int

    +

    Total backup data of the chain where the backup is located. The unit is MB.

    +

    VT

    +

    string

    +

    Production storage disk type

    +

    OMID

    +

    string

    +

    Host ID of the job execution node

    +

    Type

    +

    int

    +

    Backup type. 0: full backup; 1: incremental backup

    +

    ebk_T_I

    +

    string

    +

    Job ID of the backup system

    +

    AT

    +

    float

    +

    Average rate (Average Throughput). The unit is MB/s. One digit is reserved after the decimal point.

    +
    +
    +
  • description parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    DESC

    +

    string

    +

    Backup description

    +

    INC

    +

    int

    +

    Whether the backup request was an incremental backup call. 1: incremental backup; 0: full backup

    +
    +
    +
  • Example response
    {
+"backups": [
+{
+"status": "error",
+"description": null,
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "bookmark"
+}
+],
+"availability_zone": null,
+"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
+"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
+"id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"size": 1,
+"object_count": null,
+"container": "volumebackups",
+"name": null,
+"created_at": "2013-06-27T08:48:03.000000",
+"os-bak-tenant-attr:tenant_id": "b23b579f08c84228b9b4673c46f0c442",
+"service_metadata": " {\"bootable\": false, \"backupurl\": \"58d94782-6509-45ad-9442-970d2a005050\", \"BackupSize\": 0, \"progress\": \"0\", \"snap_id\": \"665e411f5d87431ca98c199fbd4a64fd\", \"Type\": 0} "
+},
+{
+"status": "error",
+"description": null,
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/80e17946-6e56-46e0-9547-e9ba4f1619bd",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/80e17946-6e56-46e0-9547-e9ba4f1619bd",
+"rel": "bookmark"
+}
+],
+"availability_zone": null,
+"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
+"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
+"id": "80e17946-6e56-46e0-9547-e9ba4f1619bd",
+"size": 1,
+"object_count": null,
+"container": "volumebackups",
+"name": null,
+"created_at": "2013-06-27T08:56:58.000000"
+},
+{
+"status": "error",
+"description": null,
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+"rel": "bookmark"
+}
+],
+"availability_zone": null,
+"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
+"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
+"id": "b3cf7a16-decc-4beb-8077-682737d94a58",
+"size": 1,
+"object_count": null,
+"container": "volumebackups",
+"name": null,
+"created_at": "2013-06-27T08:46:31.000000"
+}
+],
+"backups_links": [
+    {
+      "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups?limit=1&offset=1&marker=b3cf7a16-decc-4beb-8077-682737d94a58",
+      "rel": "next"
+    }
+  ]
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0020237260.html b/docs/vbs/api-ref/en-us_topic_0020237260.html new file mode 100644 index 000000000..5d3cd507f --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0020237260.html @@ -0,0 +1,473 @@ + + +

Querying Details About a VBS Backup (Native OpenStack API)

+

Function

This API is used to query details about a VBS backup.

+
+

URI

  • URI format

    GET /v2/{project_id}/backups/{backup_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    backup_id

    +

    Yes

    +

    Backup ID

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backup

    +

    dict

    +

    List of queried backups

    +

    status

    +

    string

    +

    Backup status

    +

    description

    +

    string

    +

    Backup description

    +

    links

    +

    list<dict>

    +

    Backup URL

    +

    availability_zone

    +

    string

    +

    AZ where the backup resides

    +

    volume_id

    +

    string

    +

    Source disk ID of the backup

    +

    fail_reason

    +

    string

    +

    Cause of the backup failure

    +

    id

    +

    string

    +

    Backup ID

    +

    size

    +

    int

    +

    Backup size

    +

    object_count

    +

    int

    +

    Number of objects on OBS for the disk data

    +

    container

    +

    string

    +

    Container of the backup

    +

    name

    +

    string

    +

    Backup name

    +

    created_at

    +

    string

    +

    Backup creation time

    +

    os-bak-tenant-attr:tenant_id

    +

    string

    +

    ID of the project that owns the VBS backup

    +

    service_metadata

    +

    string

    +

    Backup metadata

    +

    updated_at

    +

    string

    +

    Time when the backup was updated

    +

    data_timestamp

    +

    string

    +

    Current time

    +

    has_dependent_backups

    +

    boolean

    +

    Whether a dependent backup exists

    +

    snapshot_id

    +

    string

    +

    ID of the snapshot associated with the backup

    +

    is_incremental

    +

    boolean

    +

    Whether the backup is an incremental backup

    +
    +
    +
  • service_metadata parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    DL

    +

    int

    +

    0: non-deduplication and non-compression; 1: deduplication and non-compression; 2: non-deduplication and compression; 3: deduplication and compression If this key is not specified, the value is 0 (non-deduplication and non-compression).

    +

    VK

    +

    string

    +

    Encryption VK of an encrypted volume. The value is a string of 64 characters.

    +

    bootable

    +

    boolean

    +

    Whether the disk is the boot disk

    +

    backupurl

    +

    string

    +

    Backup image ID on the backup system

    +

    SP

    +

    string

    +

    Path name of the backup image in the storage unit

    +

    VMID

    +

    string

    +

    ID of the VM to which the backup image belongs

    +

    ST

    +

    int

    +

    Backup service type. 0: disk backup; 1: VM backup; 4: disk backup copy, 5: VM backup copy. If this tag does not exist, disk backup is specified.

    +

    BT

    +

    int

    +

    Backup storage type

    +

    SS

    +

    int

    +

    Space saving rate

    +

    BP

    +

    string

    +

    Storage unit path

    +

    CMKID

    +

    string

    +

    CMK ID of an encrypted volume. The content is UUID and contains 36 characters.

    +

    progress

    +

    int

    +

    Backup progress

    +

    CS

    +

    int

    +

    Total backup data of the chain where the backup is located. The unit is MB.

    +

    VT

    +

    string

    +

    Production storage disk type

    +

    OMID

    +

    string

    +

    Host ID of the job execution node

    +

    Type

    +

    int

    +

    Backup type. 0: full backup; 1: incremental backup

    +

    ebk_T_I

    +

    string

    +

    Job ID of the backup system

    +

    AT

    +

    float

    +

    Average rate (Average Throughput). The unit is MB/s. One digit is reserved after the decimal point.

    +
    +
    +
  • description parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    DESC

    +

    string

    +

    Backup description

    +

    INC

    +

    int

    +

    Whether the backup request was an incremental backup call. 1: incremental backup; 0: full backup

    +
    +
    +
  • Example response
    {
+"backup": {
+"status": "error",
+"description": null,
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "bookmark"
+}
+],
+"availability_zone": null,
+"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
+"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
+"id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"size": 1,
+"object_count": null,
+"container": "volumebackups",
+"name": null,
+"created_at": "2013-06-27T08:48:03.000000",
+"os-bak-tenant-attr:tenant_id": "b23b579f08c84228b9b4673c46f0c442",
+"service_metadata": " {\"bootable\": false, \"backupurl\": \"58d94782-6509-45ad-9442-970d2a005050\", \"BackupSize\": 0, \"progress\": \"0\", \"snap_id\": \"665e411f5d87431ca98c199fbd4a64fd\", \"Type\": 0} "
+}
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0022472082.html b/docs/vbs/api-ref/en-us_topic_0022472082.html new file mode 100644 index 000000000..9fa261ff7 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0022472082.html @@ -0,0 +1,14 @@ + + +

Appendix

+

+
+
+ +
+ diff --git a/docs/vbs/api-ref/en-us_topic_0022472083.html b/docs/vbs/api-ref/en-us_topic_0022472083.html new file mode 100644 index 000000000..b1741929c --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0022472083.html @@ -0,0 +1,719 @@ + + +

Error Codes

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

Module

+

Error Code

+

Description

+

Shared

+

common.0011

+

Failed to query the task.

+

VolumeBackup.0014

+

Failed to submit the task.

+

VolumeBackup.0041

+

Failed to check user rights.

+

VolumeBackup.0042

+

The user does not have the rights to perform operations.

+

VolumeBackup.0044

+

User rights are invalid.

+

Creating a Backup

+

VolumeBackup.0002

+

The request format is incorrect.

+

VolumeBackup.0003

+

Parameter name in the request is too long.

+

VolumeBackup.0004

+

Parameter name in the request contains invalid characters.

+

VolumeBackup.0005

+

Parameter name in the request starts with auto.

+

VolumeBackup.0006

+

Parameter description in the request is too long or contains invalid characters.

+

VolumeBackup.0007

+

Parameter name in the request is empty.

+

VolumeBackup.0008

+

Failed to obtain the permission.

+

VolumeBackup.0009

+

Failed to obtain the key.

+

VolumeBackup.0010

+

Parameter volume_id in the request is empty.

+

VolumeBackup.0011

+

The format of parameter volume_id in the request is incorrect.

+

VolumeBackup.0012

+

The disk status is not available or in_use.

+

VolumeBackup.0013

+

The previous backup creation task is not complete.

+

VolumeBackup.0017

+

Failed to create the snapshot.

+

VolumeBackup.0018

+

The snapshot creation result is empty.

+

VolumeBackup.0019

+

Failed to query the snapshot during backup creation.

+

VolumeBackup.0020

+

The snapshot query result is empty.

+

VolumeBackup.0021

+

The EVS disk does not exist or has been deleted.

+

VolumeBackup.0022

+

Failed to create the temporary disk.

+

VolumeBackup.0023

+

The result of creating the temporary disk is empty.

+

VolumeBackup.0024

+

Failed to query the temporary disk.

+

VolumeBackup.0025

+

The result of querying the temporary disk is empty.

+

VolumeBackup.0026

+

Parameter name in the request is too short.

+

VolumeBackup.0027

+

Failed to create the backup.

+

VolumeBackup.0028

+

The backup creation result is empty.

+

VolumeBackup.0029

+

Failed to query the backup result.

+

VolumeBackup.0030

+

The backup query result is empty.

+

VolumeBackup.0035

+

Failed to query all disks of a user.

+

VolumeBackup.0036

+

Failed to query all backups of a user.

+

VolumeBackup.0037

+

Failed to query the snapshot status.

+

VolumeBackup.0038

+

Failed to query the status of the temporary disk.

+

VolumeBackup.0039

+

Failed to query the backup status.

+

VolumeBackup.0040

+

The number of backups for the disk has reached the upper limit (20).

+

VolumeBackup.0043

+

Failed to query the disk or backup.

+

VolumeBackup.0049

+

The tag parameter is invalid.

+

VolumeBackup.0050

+

The number of tags has reached the upper limit.

+

VolumeBackup.0053

+

DESS disks do not support backup.

+

VolumeBackup.0062

+

The snapshot status is error.

+

VolumeBackup.0063

+

The status of the temporary disk is error.

+

VolumeBackup.0064

+

The backup status is error.

+

VolumeBackup.0070

+

Failed to query the quota information.

+

VolumeBackup.0071

+

The quota for the number of SAS disks has been used up.

+

VolumeBackup.0072

+

The quota for the capacity of SAS disks has been used up.

+

VolumeBackup.0073

+

The quota for the number of SATA disks has been used up.

+

VolumeBackup.0074

+

The quota for the capacity of SATA disks has been used up.

+

VolumeBackup.0075

+

The quota for the number of SSD disks has been used up.

+

VolumeBackup.0076

+

The quota for the capacity of SSD disks has been used up.

+

VolumeBackup.0077

+

The quota for the number of SAS disk snapshots has been used up.

+

VolumeBackup.0078

+

The quota for the number of SATA disk snapshots has been used up.

+

VolumeBackup.0079

+

The quota for the number of SSD disk snapshots has been used up.

+

VolumeBackup.0080

+

The quota for the number of backups has been used up.

+

VolumeBackup.0081

+

The quota for the capacity of backups has been used up.

+

VolumeBackup.0082

+

The quota for the number of disks has been used up.

+

VolumeBackup.0083

+

The quota for the capacity of disks has been used up.

+

VolumeBackup.0084

+

The quota for the number of snapshots has been used up.

+

Deleting a Backup

+

+

+

+

+

+

+

+

+

+

+

+

+

VolumeBackup.0100

+

Failed to submit the subtask.

+

VolumeBackup.0101

+

Failed to delete the snapshot.

+

VolumeBackup.0102

+

Failed to delete the backup.

+

VolumeBackup.0103

+

Failed to query the backup details.

+

VolumeBackup.0104

+

Failed to obtain the image information.

+

VolumeBackup.0105

+

The format of the backup deletion request is incorrect.

+

VolumeBackup.0109

+

Failed to query the snapshot during backup deletion.

+

VolumeBackup.0110

+

Failed to query the backup.

+

VolumeBackup.0113

+

The backup has already been used to create an image and cannot be deleted.

+

VolumeBackup.0123

+

Failed to query all backups.

+

VolumeBackup.0125

+

Failed to perform the backup deletion operation.

+

VolumeBackup.0900

+

The service is unavailable.

+

Restoring a Disk Using a Backup

+

+

+

+

+

+

+

+

+

+

+

+

+

VolumeBackup.0111

+

The disk to be restored or the backup used to restore the disk does not exist.

+

VolumeBackup.0200

+

Failed to restore data.

+

VolumeBackup.0201

+

The data restoration result is empty.

+

VolumeBackup.0202

+

The disk status is error.

+

VolumeBackup.0203

+

Parameter backup_id in the request is empty.

+

VolumeBackup.0204

+

The format of parameter backup_id in the request is incorrect.

+

VolumeBackup.0205

+

The disk status is unavailable.

+

VolumeBackup.0206

+

A backup is being created for the disk.

+

VolumeBackup.0207

+

The disk to be queried does not exist.

+

VolumeBackup.0208

+

Parameter volume_id in the request is incorrect.

+

VolumeBackup.0209

+

The capacity of the disk must be greater than or equal to that of the backup.

+

VolumeBackup.0210

+

The format of the disk restoration request is incorrect.

+

VolumeBackup.0211

+

Cloud disks at the disaster recovery site cannot be restored.

+

VolumeBackup.0089

+

The disk backup status is unavailable.

+

Backup Policy

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

+

AutoBackup.0000

+

The request is empty.

+

AutoBackup.0001

+

The object contained in the request is empty.

+

AutoBackup.0002

+

The token contained in the request header is empty.

+

AutoBackup.0003

+

The token contained in the request header has expired.

+

AutoBackup.0005

+

Failed to obtain the domain ID from the token contained in the request header.

+

AutoBackup.0006

+

The policy ID contained in the request is empty.

+

AutoBackup.0008

+

Failed to convert the request into a JSON object.

+

AutoBackup.0009

+

An exception occurred in internal system processing.

+

AutoBackup.0100

+

The tenant cannot modify the default backup policy.

+

AutoBackup.0101

+

The length of the backup policy name is invalid.

+

AutoBackup.0102

+

The parameter of the backup policy name is invalid.

+

AutoBackup.0103

+

The parameter of the backup job start time is invalid.

+

AutoBackup.0104

+

The parameter of the backup policy status is invalid.

+

AutoBackup.0105

+

The parameter of whether to retain the first backup in the current month is invalid.

+

AutoBackup.0106

+

The parameter of the backup job interval is invalid.

+

AutoBackup.0107

+

The parameter of the number of retained backups is invalid.

+

AutoBackup.0203

+

The number of existing backup policies has reached the upper limit.

+

AutoBackup.0204

+

The number of associated volumes has reached the upper limit.

+

AutoBackup.0205

+

The policy does not exist.

+

AutoBackup.1100

+

The queried policy does not exist.

+

AutoBackup.1300

+

Failed to delete the policy.

+

AutoBackup.1400

+

The resource to be associated is invalid.

+

AutoBackup.1700

+

Failed to execute the backup policy.

+

AutoBackup.0206

+

The status of the disk to be associated is invalid.

+

AutoBackup.0207

+

The resource to be associated is empty.

+

AutoBackup.0208

+

An exception occurred when you were obtaining details about the associated resource.

+

AutoBackup.0209

+

The resource ID or name is empty.

+

AutoBackup.0210

+

HANA disks cannot be associated with the backup policy.

+

AutoBackup.0211

+

The resource type is invalid.

+

AutoBackup.0213

+

The request is not authorized.

+

AutoBackup.0214

+

The tag parameter is invalid.

+

AutoBackup.0215

+

The number of tags has reached the upper limit.

+

AutoBackup.0216

+

The tag does not exist.

+

AutoBackup.0217

+

The snapshot quota is insufficient.

+

AutoBackup.0218

+

The backup quota is insufficient.

+

AutoBackup.0220

+

DESS disks cannot be associated with the backup policy.

+

AutoBackup.0221

+

The request cannot contain less-than signs (<) or greater-than signs (>).

+

AutoBackup.0222

+

Only specified actions are supported.

+

AutoBackup.0225

+

The policy is being executed.

+

AutoBackup.0226

+

The time zone parameter is invalid.

+

AutoBackup.9002

+

An internal exception occurred in system authentication.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0024723797.html b/docs/vbs/api-ref/en-us_topic_0024723797.html new file mode 100644 index 000000000..eee831a44 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0024723797.html @@ -0,0 +1,163 @@ + + +

Change History

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

Release Date

+

What's New

+

2022-06-02

+

Updated the following content:

+

Optimized the descriptions of the Type and INC parameters in sections "Querying Details About VBS Backups (Native OpenStack API)" and "Querying Details About a VBS Backup (Native OpenStack API)."

+

2021-09-24

+

Updated the following content:

+

Added section "Querying Quotas."

+

2018-12-30

+

Updated the following content:

+

Added the following sections: Creating a VBS Backup (Native OpenStack V3 API), Querying Summary Information About VBS Backups (Native OpenStack V3 API), Querying Details About VBS Backups (Native OpenStack V3 API), Querying Details About a VBS Backup (Native OpenStack V3 API), Deleting a VBS Backup (Native OpenStack V3 API), and Restoring a Disk Using a VBS Backup (Native OpenStack V3 API).

+

2018-09-07

+

Accepted in OTC-3.2.

+

2018-08-15

+

Updated the following content:

+
  • Modified descriptions of parameters week_frequency and rentention_day in section "Creating a Backup Policy".
  • Modified descriptions of parameters week_frequency and rentention_day in section " Modifying a Backup Policy ".
+

2018-07-30

+

Updated the following content:

+
  • Added descriptions of parameters week_frequency and rentention_day to section "Creating a Backup Policy".
  • Added descriptions of parameters week_frequency and rentention_day to section "Querying Backup Policies".
  • Added descriptions of parameters week_frequency and rentention_day to section "Modifying a Backup Policy".
+

2018-06-11

+

Accepted in OTC 3.1.

+

2018-05-30

+

Updated the following content:

+

Modified the description of parameter "key" in section "Deleting a Tag of a Backup Policy".

+

2018-04-30

+

Updated the following content:

+
  • Deleted section "Querying Tenant Tags".
  • Added section "Adding a Tag for a Backup Policy".
  • Added section "Deleting a Tag of a Backup Policy.
  • Added section "Querying All Backup Policy Tags".
  • Added section "Batch Updating or Deleting Tags of a Backup Policy".
  • Added error codes AutoBackup.0220, AutoBackup.0221, and AutoBackup.0222 to the list of error codes in the appendix.
+

2018-01-23

+

Updated the following content:

+
  • Modified request parameters in the section "Creating a Backup Policy".
  • Modified request parameters in the section "Modifying a Backup Policy".
  • Modified request parameters in the section "Querying Backup Policies".
  • Modified the example request in the section of "Token Authentication".
  • Added response parameters to the section "Querying Backup Jobs Triggered by a Backup Policy".
  • Added a request example to the section "Querying a Backup Policy Using Tags".
  • Added the sections "Creating a Backup Share", "Deleting a Backup Share", "Querying Backup Shares", "Counting Backup Shares", and "Querying Details About a Backup Share".
+

2017-09-22

+

Updated the following content:

+
  • Added a request example in section "Querying a Backup Policy Using Tags."
  • Added five interfaces for sharing backups.
+

2017-07-30

+

Updated the following content:

+
  • Added the tags parameter in sections "Creating a VBS Backup" and "Creating a Backup Policy."
  • Added response parameters in section "Querying Detailed Information About VBS Backups (Native OpenStack API)."
  • Added response parameters in section "Querying Details About a VBS Backup (Native OpenStack API)."
  • Added section "Restoring a Disk Using a VBS Backup (Native OpenStack API)."
  • Added section "Querying Tenant Tags."
  • Added section "Querying Tags of a Backup Policy."
  • Added section "Updating or Deleting Tags of a Backup Policy."
  • Added section "Querying a Backup Policy Using Tags."
+

2017-05-26

+

Updated the following content:

+
  • Added section "Creating a VBS Backup (Native OpenStack API)."
+

2017-04-28

+

Updated the following content:

+
  • Added the snapshot_id parameter in section "Creating a VBS Backup."
  • Deleted the limitations on shared and SCSI EVS disks.
  • Deleted the limitation that backup data of encrypted EVS disks cannot be stored in encrypted mode.
+

2017-03-30

+

Updated the following content:

+
  • Added a description about shared disks and the EVS disks whose Device Type is SCSI.
+

2017-02-28

+

This issue is the tenth official release.

+

Updated the following content:

+
  • Modified sections "Querying Detailed Information About VBS Backups" and "Querying Details About a VBS Backup." Added the content of os-bak-tenant-attr:tenant_id to the parameter description and example response.
  • Updated the title of section "Deleting a VBS Backup (Deprecated)."
  • Added section "Deleting a VBS Backup."
+

2017-02-22

+

Updated the following content:

+
  • Updated the title of section "Deleting a VBS Backup (Deprecated)."
  • Added section "Deleting a VBS Backup."
+

2017-01-20

+

Updated the following content:

+
  • Added error codes AutoBackup.0008 and AutoBackup.0213 to the list of error codes in the appendix.
  • Added the description of encrypted EVS disks in sections 4.1, 5.5, and 5.8.
+

2016-12-30

+

Updated the following content:

+
  • Added section "Backup Policy."
  • Added the description of backup policy APIs in appendix "Error Codes."
+

2016-11-24

+

Updated the following content:

+
  • Modified the operation for generating the AK and SK.
+

2016-09-30

+

Updated the following content:

+
  • Modified section "Regions and Endpoints."
  • Added the "Workspace" row in the table.
+

2016-08-25

+

Updated the following content:

+
  • Modified section "Querying the Job Status."
  • Updated the parameter description.
+

2016-06-02

+

Updated the following content:

+
  • Modified the error code description in "Error Code Description."
  • Modified sections "Querying Summary Information About VBS Backups" and "Querying Detailed Information About VBS Backups." Added the content of backups_links to the parameter description and example response.
+

2016-04-14

+

Updated the following content:

+
  • Modified parameter descriptions in URL in section "Service Usage."
  • Modified steps for invoking interfaces in "Token Authentication."
+

2016-03-09

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043410516.html b/docs/vbs/api-ref/en-us_topic_0043410516.html new file mode 100644 index 000000000..896243955 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043410516.html @@ -0,0 +1,44 @@ + + +

Backup Policies

+

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043410517.html b/docs/vbs/api-ref/en-us_topic_0043410517.html new file mode 100644 index 000000000..c8f94a9ee --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043410517.html @@ -0,0 +1,320 @@ + + +

Creating a Backup Policy

+

Function

This API is used to create a backup policy. A tenant can create a maximum of 10 backup policies.

+
+

URI

  • URI format

    POST /v2/{project_id}/backuppolicy

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    backup_policy_name

    +

    Yes

    +

    string

    +

    Backup policy name

    +

    The name is a string of 1 to 64 characters consisting of letters, digits, underscores (_), and hyphens (-). It cannot start with default.

    +

    scheduled_policy

    +

    Yes

    +

    dict

    +

    Details about the scheduling policy

    +

    start_time

    +

    Yes

    +

    string

    +

    Backup execution time (UTC), in the format of HH:mm

    +

    You need to set the execution time to a full hour. You can set multiple execution times, and use commas (,) to separate one time from another. To set multiple backup execution times, enter them in ascending order by local time. For example, if your local time is 2 hours ahead of UTC and you want to perform backups at the local times 00:00, 02:00, and 04:00, set this parameter to 22:00,00:00,02:00 (UTC times) and time_zone to UTC+02:00.

    +

    frequency

    +

    No (Either this field or week_frequency must be specified.)

    +

    integer

    +

    Backup interval (1 to 14 days). Set either this parameter or week_frequency. If you set both, this parameter is used.

    +

    week_frequency

    +

    No (Either this field or frequency must be specified.)

    +

    list<string>

    +

    Defines on which days of each week backup jobs are executed. The value can be one or more of the following:

    +

    SUN, MON, TUE, WED, THU, FRI, SAT

    +

    rentention_num

    +

    No (Either this field or rentention_day must be specified.)\

    +

    integer

    +

    Number (from 2 to 14) of retained backups. Set either this parameter or rentention_day. If you set both, this parameter is used.

    +

    rentention_day

    +

    No (Either this field or rentention_num must be specified.)

    +

    integer

    +

    Retention days of backups. The value is an integer ranging from 2 to 99999. If you enter a floating point number, the number will be rounded down to the nearest integer when you send the request.

    +

    remain_first_backup_of_curMonth

    +

    No

    +

    string

    +

    Whether to retain the first backup in the current month

    +
    • Y
    • N
    +

    status

    +

    Yes

    +

    string

    +

    Backup policy status

    +
    • ON
    • OFF
    +

    tags

    +

    No

    +

    list<dict>

    +

    Tags to be configured for the backup policy

    +

    key

    +

    Yes

    +

    string

    +

    Tag key. It contains 1 to 36 characters, A tag key can contain only letters, digits, hyphens (-), and underscores (_).

    +

    value

    +

    Yes

    +

    string

    +

    Tag value. A tag value consists of 0 to 43 characters. A tag value can contain only letters, digits, hyphens (-), and underscores (_).

    +

    time_zone

    +

    No

    +

    string

    +

    Time zone. The value is in the UTC+/-HH:mm format.

    +

    This parameter specifies the time zone of the local time with the Daylight Saving Time (DST) offset, for example, UTC+08:00 or UTC-02:00. If execution times are in different days after converting into UTC times, this parameter must be used with week_frequency and start_time.

    +
    +
    +
+
  • Example request
    {
+    "backup_policy_name": "policy_01",
+    "scheduled_policy" : {
+        "remain_first_backup_of_curMonth" : "Y",
+        "rentention_day" : 30,
+        "week_frequency" : ["SUN","WED"],
+        "start_time" : "12:00",
+        "status" : "ON"
+    },
+    "tags":[{
+      "key":"key",
+      "value":"value"
+    }],
+    "time_zone": "UTC+08:00"
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backup_policy_id

    +

    string

    +

    Backup policy ID returned if the operation is successful

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+  "backup_policy_id": "af8a20b0-117d-4fc3-ae53-aa3968a4f870"
+}
    +

    or

    +
    {
+    "error": {
+        "code": "XXXX",
+        "message": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043410558.html b/docs/vbs/api-ref/en-us_topic_0043410558.html new file mode 100644 index 000000000..d7d70e296 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043410558.html @@ -0,0 +1,277 @@ + + +

Querying Backup Policies

+

Function

This API is used to query all backup policies of a tenant.

+
+

URI

  • URI format

    GET /v2/{project_id}/backuppolicy

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backup_policies

    +

    list<dict>

    +

    List of backup policies

    +

    backup_policy_name

    +

    string

    +

    Backup policy name

    +

    scheduled_policy

    +

    dict

    +

    Details about the scheduling policy

    +

    start_time

    +

    string

    +

    Backup execution time (on a full hour), which is expressed in the UTC format. If you want to set multiple execution times, separate them using commas (,).

    +

    frequency

    +

    integer

    +

    Backup interval (1 to 14 days)

    +

    week_frequency

    +

    list<string>

    +

    Week information list

    +

    rentention_num

    +

    integer

    +

    Number of retained backups. The value must be an integer from 2 to 14.

    +

    rentention_day

    +

    integer

    +

    Retention days of backups. The value is an integer ranging from 2 to 99999. If you enter a floating point number, the number will be rounded down to the nearest integer when you send the request.

    +

    remain_first_backup_of_curMonth

    +

    string

    +

    Whether to retain the first backup in the current month

    +
    • Y
    • N
    +

    status

    +

    string

    +

    Backup policy status

    +
    • ON
    • OFF
    +

    backup_policy_id

    +

    string

    +

    Backup policy ID

    +

    policy_resource_count

    +

    integer

    +

    Number of volumes associated with the backup policy

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +

    time_zone

    +

    string

    +

    Time zone for the backup execution time

    +
    +
    +
  • Example response
    {
+    "backup_policies" : [
+    {
+        "backup_policy_id" : "XX",
+        "backup_policy_name": "plan01",
+        "scheduled_policy" : {
+            "remain_first_backup_of_curMonth" : "Y",
+            "rentention_num" : 10,
+            "frequency" : 1,
+            "start_time" : "12:00",
+            "status" : "ON"
+        },
+        "policy_resource_count": 0
+    },
+    {
+        "backup_policy_id" : "YY",
+        "backup_policy_name ": "plan02",
+        "scheduled_policy" : {
+            "remain_first_backup_of_curMonth" : "Y",
+            "rentention_num" : 10,
+            "frequency" : 1,
+            "start_time" : "14:00",
+            "status" : "ON"
+        },
+        "policy_resource_count": 10
+    }]
+}
    +

    or

    +
    {
+    "error": {
+        "code": "XXXX",
+        "message": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043410559.html b/docs/vbs/api-ref/en-us_topic_0043410559.html new file mode 100644 index 000000000..301dc41b2 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043410559.html @@ -0,0 +1,297 @@ + + +

Modifying a Backup Policy

+

Function

This API is used to modify a backup policy.

+
+

URI

  • URI format

    PUT /v2/{project_id}/backuppolicy/{policy_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    Backup policy ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    backup_policy_name

    +

    No

    +

    string

    +

    Backup policy name

    +

    The name is a string of 1 to 64 characters consisting of letters, digits, underscores (_), and hyphens (-). It cannot start with default.

    +

    The default backup policy cannot be renamed.

    +

    scheduled_policy

    +

    No

    +

    dict

    +

    Details about the scheduling policy

    +

    start_time

    +

    No

    +

    string

    +

    Backup execution time (UTC), in the format of HH:mm

    +

    You need to set the execution time to a full hour. You can set multiple execution times, and use commas (,) to separate one time from another. To set multiple backup execution times, enter them in ascending order by local time. For example, if your local time is 2 hours ahead of UTC and you want to perform backups at the local times 00:00, 02:00, and 04:00, set this parameter to 22:00,00:00,02:00 (UTC times) and time_zone to UTC+02:00.

    +

    frequency

    +

    No (Either this field or week_frequency must be specified.)

    +

    integer

    +

    Backup interval (1 to 14 days). Set either this parameter or week_frequency. If you set both, this parameter is used.

    +

    week_frequency

    +

    No (Either this field or frequency must be specified.)

    +

    list<string>

    +

    Defines on which days of each week backup jobs are executed. The value can be one or more of the following:

    +

    SUN, MON, TUE, WED, THU, FRI, SAT

    +

    rentention_num

    +

    No

    +

    integer

    +

    Number of retained backups. The value must be an integer from 2 to 14. If you set this parameter and rentention_day at the same time, this parameter is used.

    +

    rentention_day

    +

    No

    +

    integer

    +

    Retention days of backups. The value is an integer ranging from 2 to 99999. If you enter a floating point number, the number will be rounded down to the nearest integer when you send the request.

    +

    remain_first_backup_of_curMonth

    +

    No

    +

    string

    +

    Whether to retain the first backup in the current month

    +
    • Y
    • N
    +

    status

    +

    No

    +

    string

    +

    Backup policy status

    +
    • ON
    • OFF
    +

    time_zone

    +

    No

    +

    string

    +

    Time zone. The value is in the UTC+/-HH:mm format.

    +

    This parameter specifies the time zone of the local time with the DST offset, for example, UTC+08:00 or UTC-02:00. If execution times are in different days after converting into UTC times, this parameter must be used with week_frequency and start_time.

    +
    +
    +
+
  • Example request
    {
+    "backup_policy_name": "policy_01",
+    "scheduled_policy" : {
+        "remain_first_backup_of_curMonth" : "Y",
+        "rentention_num" : 10,
+        "week_frequency" : ["MON"],
+        "start_time" : "12:00",
+        "status" : "ON"
+    },
+    "time_zone": "UTC+08:00"
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backup_policy_id

    +

    string

    +

    Backup policy ID returned if the operation is successful

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+  "backup_policy_id": "af8a20b0-117d-4fc3-ae53-aa3968a4f870"
+}
    +

    or

    +
    {
+    "error": {
+        "code": "XXXX",
+        "message": "XXX"
+    }
+}
    +
+
+

Status Code

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043410560.html b/docs/vbs/api-ref/en-us_topic_0043410560.html new file mode 100644 index 000000000..a3be01840 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043410560.html @@ -0,0 +1,165 @@ + + +

Deleting a Backup Policy

+

Function

This API is used to delete a backup policy.

+
+

URI

  • URI format

    DELETE /v2/{project_id}/backuppolicy/{policy_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    Backup policy ID

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response

    None

    +

    or

    +
    {
+    "error": {
+        "code": "XXXX",
+        "message": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    204

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043410561.html b/docs/vbs/api-ref/en-us_topic_0043410561.html new file mode 100644 index 000000000..03f526ec3 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043410561.html @@ -0,0 +1,300 @@ + + +

Associating Resources with a Backup Policy

+

Function

This API is used to associate one or more resources with a backup policy.

+
+

URI

  • URI format

    POST /v2/{project_id}/backuppolicyresources

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    backup_policy_id

    +

    Yes

    +

    string

    +

    Backup policy ID

    +

    resources

    +

    Yes

    +

    list<dict>

    +

    Information about the associated resource

    +

    resource_id

    +

    Yes

    +

    string

    +

    Resource ID

    +

    resource_type

    +

    Yes

    +

    string

    +

    Resource type. The options are as follows:

    +
    • volume
    +
    +
    +
+
  • Example request
    {
+    "backup_policy_id":"915d1fd8-63cb-4054-a2b0-2778210e3a75",
+    "resources":[{
+        "resource_id":"0f187b65-8d0e-4fc0-9096-3b55d330531e",
+        "resource_type":"volume"
+        },{
+        "resource_id":"0f187b65-8d0e-4fc0-9096-3b55d330531d",
+        "resource_type":"volume"
+    }]
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    success_resources

    +

    list<dict>

    +

    List of successfully associated resources

    +

    resource_id

    +

    string

    +

    Resource ID

    +

    resource_type

    +

    string

    +

    Resource type

    +

    availability_zone

    +

    string

    +

    AZ to which the resource belongs

    +

    os_vol_host_attr

    +

    string

    +

    Point of delivery (POD) to which the resource belongs

    +

    fail_resources

    +

    list<dict>

    +

    List of the resources that fail to be associated

    +

    resource_id

    +

    string

    +

    Resource ID

    +

    resource_type

    +

    string

    +

    Resource type

    +

    availability_zone

    +

    string

    +

    AZ to which the resource belongs

    +

    os_vol_host_attr

    +

    string

    +

    POD to which the resource belongs

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+    "success_resources": [
+        {
+            "resource_id": "bce8d47a-af17-4169-901f-4c7ae9f29c2c",
+            "os_vol_host_attr": "pod01.eu-de-01",
+            "availability_zone": "eu-de-01",
+            "resource_type": "volume"
+        }
+    ], 
+    "fail_resources": [ ]
+}
    +

    or

    +
    {
+    "error": {
+        "code": "XXXX",
+        "message": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043410562.html b/docs/vbs/api-ref/en-us_topic_0043410562.html new file mode 100644 index 000000000..cf070b1c3 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043410562.html @@ -0,0 +1,239 @@ + + +

Disassociating Resources from a Backup Policy

+

Function

This API is used to disassociate one or more resources from a backup policy.

+
+

URI

  • URI format

    POST /v2/{project_id}/backuppolicyresources/{policy_id}/deleted_resources

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    Backup policy ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    resources

    +

    Yes

    +

    list<dict>

    +

    Information about the associated resource

    +

    resource_id

    +

    Yes

    +

    string

    +

    Resource ID

    +
    +
    +
+
  • Example request
    {
+    "resources": [
+        {
+            "resource_id": "bce8d47a-af17-4169-901f-4c7ae9f29c2c"
+        }
+    ]
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    success_resources

    +

    list<dict>

    +

    List of successfully disassociated resources

    +

    resource_id

    +

    string

    +

    Resource ID

    +

    fail_resources

    +

    list<dict>

    +

    List of the resources that fail to be disassociated

    +

    resource_id

    +

    string

    +

    Resource ID

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    { 
+    "success_resources": [],
+    "fail_resources": [ 
+    { 
+         "resource_id": "bbba7509-f457-4732-97f1-a8e24b6ed9bc" 
+    }] 
+}
    +

    or

    +
    {
+    "error": {
+        "code": "XXXX",
+        "message": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043410563.html b/docs/vbs/api-ref/en-us_topic_0043410563.html new file mode 100644 index 000000000..43b6bf241 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043410563.html @@ -0,0 +1,165 @@ + + +

Executing a Backup Policy At Once

+

Function

This API is used to back up resources associated with a backup policy at once.

+
+

URI

  • URI format

    POST /v2/{project_id}/backuppolicy/{policy_id}/action

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    Backup policy ID

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response

    None

    +

    or

    +
    {
+    "error": {
+        "message": "XXXX",
+        "code": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    204

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043410564.html b/docs/vbs/api-ref/en-us_topic_0043410564.html new file mode 100644 index 000000000..3f8c5980e --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043410564.html @@ -0,0 +1,37 @@ + + +

Enabling or Disabling a Backup Policy

+

Function

This API is used to enable or disable a backup policy. After a backup policy is enabled, it will be scheduled based on the specified time. After a backup policy is disabled, it will not be scheduled.

+

Set the backup policy status to ON or OFF. For details, see Modifying a Backup Policy.

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

Parameter

+

Mandatory

+

Type

+

Description

+

status

+

Yes

+

string

+

Backup policy status

+
  • ON
  • OFF
+
+
+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0043430177.html b/docs/vbs/api-ref/en-us_topic_0043430177.html new file mode 100644 index 000000000..e71260686 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0043430177.html @@ -0,0 +1,336 @@ + + +

Querying Backup Jobs Triggered by a Backup Policy

+

Function

This API is used to query the status of backup jobs triggered by a backup policy.

+
+

URI

  • URI format

    GET /v2/{project_id}/backuppolicy/{policy_id}/backuptasks

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    Backup policy ID

    +
    +
    +
  • Request filter parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    sort_dir

    +

    No

    +

    string

    +

    Sorting order. Possible values are asc (ascending) and desc (descending).

    +

    limit

    +

    No

    +

    integer

    +

    Maximum number of query results that can be returned. The default value is 20.

    +

    marker

    +

    No

    +

    string

    +

    Start number from which backup jobs are queried. The value is the backup job ID.

    +

    job_id

    +

    No

    +

    string

    +

    Backup job ID

    +

    status

    +

    No

    +

    string

    +

    Backup job status

    +
    • RUNNING
    • EXECUTE_TIMEOUT
    • WAITING
    • EXECUTE_FAIL
    • EXECUTE_SUCCESS
    • SKIP
    +

    sort_key

    +

    No

    +

    string

    +

    Keyword for sorting query results. The value must be created_at.

    +

    offset

    +

    No

    +

    integer

    +

    Query offset. The default value is 0.

    +
    +
    +
  • Example request
    GET /v2/{project_id}/backuppolicy/{policy_id}/backuptasks?limit=10
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    count

    +

    integer

    +

    Total number of queried jobs

    +

    tasks

    +

    list<dict>

    +

    Details about the backup jobs

    +

    status

    +

    string

    +

    Backup job status

    +
    • RUNNING
    • EXECUTE_TIMEOUT
    • WAITING
    • EXECUTE_FAIL
    • EXECUTE_SUCCESS
    • SKIP
    +

    job_id

    +

    string

    +

    Backup job ID

    +

    created_at

    +

    string

    +

    Time the backup job was created. The time is in UTC format, for example, 2016-12-02T09:06:46.706.

    +

    finished_at

    +

    string

    +

    Time the backup job was completed. The time is in UTC format, for example, 2016-12-02T13:00:00.121.

    +

    backup_name

    +

    string

    +

    Backup name

    +

    resource_id

    +

    string

    +

    Resource ID

    +

    resource_type

    +

    string

    +

    Resource type

    +

    vbs_job_id

    +

    string

    +

    VBS backup job ID

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+  "tasks": [
+    {
+      "status": "RUNNING",
+      "job_id": "0781095c-b8ab-4ce5-99f3-4c5f6ff75319",
+      "created_at": "2016-12-03T06:24:34.467",
+      "backup_name": "autobk_a61d",
+      "resource_id": "f47a4ab5-11f5-4509-97f5-80ce0dd74e37",
+      "resource_type": "volume"
+    },
+    {
+      "status": "EXECUTE_SUCCESS",
+      "job_id": "c11b5a18-4559-4731-b7b3-58e2bd89cdb9",
+      "created_at": "2016-12-02T09:06:46.706",
+      "finished_at": "2016-12-02T13:00:00.121",
+      "backup_name": "autobk_e6d2",
+      "resource_id": "f47a4ab5-11f5-4509-97f5-80ce0dd74e37",
+      "resource_type": "volume"
+    }
+  ],
+  "count": 2
+}
    +

    or

    +
    {
+    "error": {
+        "message": "XXXX",
+        "code": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0049453221.html b/docs/vbs/api-ref/en-us_topic_0049453221.html new file mode 100644 index 000000000..1301def89 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0049453221.html @@ -0,0 +1,164 @@ + + +

Deleting a VBS Backup (Native OpenStack API)

+

Function

This API is used to delete a VBS backup.

+
+

URI

  • URI format

    DELETE /v2/{project_id}/backups/{backup_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    backup_id

    +

    Yes

    +

    ID of the backup to be deleted

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    int

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response

    None

    +

    or

    +
    { 
+"itemNotFound": { 
+"message": "Backup 592a0c4d-65a3-4051-8d51-1e2b6401b2d8 could not be found.", 
+"code": 404 } 
+}
    +
+
+

Status Codes

  • Normal

    202

    +
  • 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 requested page.

    +

    404 Not Found

    +

    The server could not find the requested page or resources.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0060614329.html b/docs/vbs/api-ref/en-us_topic_0060614329.html new file mode 100644 index 000000000..c6a1a606f --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0060614329.html @@ -0,0 +1,318 @@ + + +

Creating a VBS Backup (Native OpenStack API)

+

Function

This API is used to create a VBS backup.

+
+

URI

  • URI format

    POST /v2/{project_id}/backups

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    backup

    +

    Yes

    +

    dict

    +

    Backup to be created. For details, see the backup field description.

    +
    +
    +
  • backup field description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    volume_id

    +

    Yes

    +

    string

    +

    ID of the disk to be backed up

    +

    snapshot_id

    +

    Yes

    +

    string

    +

    Snapshot ID of the disk to be backed up

    +

    name

    +

    No

    +

    string

    +

    Backup name. The value is a string of 1 to 64 characters that can contain digits, letters, underscores (_), and hyphens (-), not starting with auto.

    +

    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 (<).

    +

    container

    +

    No

    +

    string

    +

    Backup container. This parameter is reserved and will be skipped.

    +

    incremental

    +

    No

    +

    boolean

    +

    Whether it is an incremental backup. The value true indicates an incremental backup and false indicates a full backup. By default, VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter is skipped.

    +

    force

    +

    No

    +

    boolean

    +

    Whether to forcibly back up the attached disks. true indicates a forcible backup and false indicates a non-forcible backup. The value defaults to false.

    +

    project_id

    +

    No

    +

    string

    +

    Project ID

    +
    +
    +
+
  • Example request
    {
+    "backup": {
+        "volume_id": "c68ae7fb-0aa5-4a97-ab01-ed02c5b7e768",
+        "snapshot_id": "2bb856e1-b3d8-4432-a858-09e4ce939389",
+        "name": "backup1",
+        "description": "Backup_Demo"
+    }
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backup

    +

    dict

    +

    Information about the created backup

    +

    id

    +

    string

    +

    Backup ID

    +

    name

    +

    string

    +

    Backup name

    +

    links

    +

    list<dict>

    +

    Information about the backup URL

    +

    href

    +

    string

    +

    Backup URL

    +

    rel

    +

    string

    +

    Relationship between the query result and href

    +
    +
    +
  • Example response
    {
+  "backup": {
+    "id": "54ba0e69-48a0-4a77-9cdf-a7979a7e2648",
+    "links": [
+      {
+        "href": "https://volume.Region.dc1.domainname.com/v2/5751d8c3f2f6415993ee4326b41630ec/backups/54ba0e69-48a0-4a77-9cdf-a7979a7e2648",
+        "rel": "self"
+      },
+      {
+        "href": "https://volume.Region.dc1.domainname.com/5751d8c3f2f6415993ee4326b41630ec/backups/54ba0e69-48a0-4a77-9cdf-a7979a7e2648",
+        "rel": "bookmark"
+      }
+    ],
+    "name": "backup1"
+  }
+}
    +

    or

    +
    {
+"badRequest": {
+"code": "XXXX",
+"message": "XXX"
+}
+}
    +
+
+

Status Codes

  • Normal

    202

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0061309333.html b/docs/vbs/api-ref/en-us_topic_0061309333.html new file mode 100644 index 000000000..fbdc15504 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0061309333.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/vbs/api-ref/en-us_topic_0067142129.html b/docs/vbs/api-ref/en-us_topic_0067142129.html new file mode 100644 index 000000000..c71fd040c --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0067142129.html @@ -0,0 +1,208 @@ + + +

Restoring a Disk Using a VBS Backup (Native OpenStack API)

+

Function

This API is used to restore a disk using a VBS backup.

+
+

URI

  • URI format

    POST /v2/{project_id}/backups/{backup_id}/restore

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    backup_id

    +

    Yes

    +

    ID of the backup used to restore a disk

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    restore

    +

    Yes

    +

    dict

    +

    Information about the disk to be restored

    +

    volume_id

    +

    Yes

    +

    string

    +

    ID of the disk to be restored

    +
    +
    +
+
  • Example request
    {
+    "restore": {
+        "volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024"
+    }
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backup_id

    +

    String

    +

    Backup ID

    +

    volume_id

    +

    String

    +

    Disk ID

    +

    volume_name

    +

    String

    +

    Disk name

    +
    +
    +
  • Example response
    {
+    "restore": {
+        "backup_id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2", 
+        "volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
+        "volume_name": "test_volume"
+    }
+}
    +
+
+

Status Codes

  • Normal

    202

    +
  • 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 requested page.

    +

    404 Not Found

    +

    The server could not find the requested page or resources.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0067142130.html b/docs/vbs/api-ref/en-us_topic_0067142130.html new file mode 100644 index 000000000..e785a1612 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0067142130.html @@ -0,0 +1,197 @@ + + +

Querying All Backup Policy Tags

+

Function

This API is used to query tags of all backup policies.

+
+

URI

  • URI format

    GET /v2/{project_id}/backuppolicy/tags

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
  • Example request
    GET /v2/{project_id}/backuppolicy/tags
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    list<dict>

    +

    List of tag details

    +

    key

    +

    string

    +

    Tag key

    +

    values

    +

    list<string>

    +

    List of tag values

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+  "tags": [
+    {
+      "key": "RUNNING",
+      "values":[
+      "0781095c-b8ab-4ce5-99f3-4c5f6ff75319",
+      "2016-12-03T06:24:34.467"
+      ]
+    },
+    {
+      "key": "WAITING",
+      "values":[
+      "0781095c-b8ab-4ce5-99f3-4c5f6ff75319",
+      "2016-12-03T06:24:34.467"
+      ]
+    }
+  ]
+}
    +

    or

    +
    {
+    "error": {
+        "code": "XXXX",
+        "message": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0067142131.html b/docs/vbs/api-ref/en-us_topic_0067142131.html new file mode 100644 index 000000000..cf33515b5 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0067142131.html @@ -0,0 +1,198 @@ + + +

Querying Tags of a Backup Policy

+

Function

This API is used to query the tags of a specific backup policy.

+
+

URI

  • URI format

    GET /v2/{project_id}/backuppolicy/{policy_id}/tags

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    Backup policy ID

    +
    +
    +
  • Example request
    GET /v2/{project_id}/backuppolicy/{policy_id}/tags
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    list<dict>

    +

    List of tag details

    +

    key

    +

    string

    +

    Tag key

    +

    value

    +

    string

    +

    Tag value

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+  "tags": [
+    {
+      "key": "RUNNING",
+      "value":"0781095c-b8ab-4ce5-99f3-4c5f6ff75319"
+    },
+    {
+      "key": "WAITING",
+      "values":"2016-12-03T06:24:34.467"
+    }
+  ]
+}
    +

    or

    +
    {
+    "error": {
+        "message": "XXXX",
+        "code": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0067142132.html b/docs/vbs/api-ref/en-us_topic_0067142132.html new file mode 100644 index 000000000..136d7f801 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0067142132.html @@ -0,0 +1,227 @@ + + +

Batch Updating or Removing Tags of a Backup Policy

+

Function

This API is used to update or remove the tags of a backup policy.

+
+

URI

  • URI format

    POST /v2/{project_id}/backuppolicy/{policy_id}/tags/action

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    Backup policy ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    action

    +

    Yes

    +

    string

    +

    Operator (case-sensitive). Possible values are:

    +

    create: indicates creating tags. A tag will be created when no tag with the same key exists.

    +

    update: indicates updating tags. A tag will be created when no tag with the same key exists.

    +

    delete: indicates deleting tags.

    +

    tags

    +

    No

    +

    list<dict>

    +

    List of tags you want to operate

    +

    key

    +

    Yes

    +

    string

    +

    Tag key. It cannot be left null. When action is create or update, the maximum length of a tag key is 36 characters; when action is delete, that is 127 characters. A tag key cannot contain non-printable ASCII characters (0-31) and the following special characters: =*<>\,|/

    +

    value

    +

    No (mandatory when action is set to create and optional when action is set to delete)

    +

    string

    +

    Tag value. When action is create or update, the maximum length of a tag value is 43 characters; when action is delete, that is 255 characters. A tag value can contain only letters, digits, hyphens (-), and underscores (_).

    +
    +
    +
+
  • Example request
    {
+    "action":"delete",
+    "tags":[{
+        "key":"0f187b65-8d0e-4fc0-9096-3b55d330531e",
+        "value":"volume"
+        },{
+        "key":"0f187b65-8d0e-4fc0-9096-3b55d330531d",
+        "value":"volume"
+    }]
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+    "error": {
+        "message": "XXXX",
+        "code": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    204

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0067142133.html b/docs/vbs/api-ref/en-us_topic_0067142133.html new file mode 100644 index 000000000..c4289eddb --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0067142133.html @@ -0,0 +1,430 @@ + + +

Querying Backup Policies by Tag

+

Function

This API is used to query backup policies by tag.

+
+

URI

  • URI format

    POST /v2/{project_id}/backuppolicy/resource_instances/action

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    No

    +

    list<dict>

    +

    List of tags. Backup policies with these tags will be filtered. This list can have a maximum of 10 tags.

    +

    key

    +

    Yes

    +

    string

    +

    Tag key. Tag keys must be unique.

    +

    values

    +

    Yes

    +

    list<string>

    +

    List of tag values. This list can have a maximum of 10 tag values and these values must be unique.

    +

    tags_any

    +

    No

    +

    list<dict>

    +

    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.

    +

    key

    +

    Yes

    +

    string

    +

    Tag key

    +

    values

    +

    Yes

    +

    list<string>

    +

    List of tag values

    +

    not_tags

    +

    No

    +

    list<dict>

    +

    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.

    +

    key

    +

    Yes

    +

    string

    +

    Tag key

    +

    values

    +

    Yes

    +

    list<string>

    +

    List of tag values

    +

    not_tags_any

    +

    No

    +

    list<dict>

    +

    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.

    +

    key

    +

    Yes

    +

    string

    +

    Tag key

    +

    values

    +

    Yes

    +

    list<string>

    +

    List of tag values

    +

    matches

    +

    No

    +

    list<dict>

    +

    Search criteria. Fuzzy search is supported.

    +

    key

    +

    Yes

    +

    string

    +

    Field for searching. Currently, only resource_name is supported.

    +

    value

    +

    Yes

    +

    string

    +

    Search value

    +

    limit

    +

    No

    +

    string

    +

    Number of queried records. This parameter is not displayed if action is set to count. The default value is 1000 if action is set to filter. The value must be an integer ranging from 1000.

    +

    offset

    +

    No

    +

    string

    +

    Query index. (This parameter is not displayed if action is set to count.) The query starts from the next piece of data indexed by this parameter. If action is set to filter, the default value is 0 which indicates the query starts from the first piece of data. The value must be a non-negative integer.

    +

    action

    +

    Yes

    +

    string

    +

    Operator. Possible values are:

    +

    filter: queries backup policies by specifying filtering conditions.

    +

    count: queries backup policies by specifying the total number.

    +
    +
    +
+
  • Example request
    {
+  "limit": "10",
+  "offset": "0",
+  "tags":
+      [
+        {
+           "key": "Tag001",
+           "values":["Value001","Value002"]
+         }
+       ],
+  "action":"filter"
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    total_count

    +

    integer

    +

    Total number of resources

    +

    resources

    +

    list<dict>

    +

    List of resources

    +

    resource_id

    +

    string

    +

    Resource ID

    +

    resouce_detail

    +

    object

    +

    Resource details, used for extension

    +

    resource_name

    +

    string

    +

    Resource name

    +

    tags

    +

    list<dict>

    +

    List of tags

    +

    key

    +

    string

    +

    Tag key

    +

    value

    +

    string

    +

    Tag value

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+  "total_count":10,
+  "resources":[
+    {
+      "resource_name": "name",
+      "resource_id": "0781095c-b8ab-4ce5-99f3-4c5f6ff75319",
+      "resource_detail": null,
+      "tags": [{
+          "key":"key",
+          "value":"value"
+       }]
+    }
+  ]
+}
    +

    or

    +
    {
+    "error": {
+        "message": "XXXX",
+        "code": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0078214151.html b/docs/vbs/api-ref/en-us_topic_0078214151.html new file mode 100644 index 000000000..7feae1a68 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0078214151.html @@ -0,0 +1,284 @@ + + +

Sharing a Backup

+

Function

This API is used to share a backup to another project.

+
+

URI

  • URI format

    POST /v2/{project_id}/os-vendor-backup-sharing

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    shared

    +

    Yes

    +

    dict

    +

    Information about the backup sharing

    +

    backup_id

    +

    Yes

    +

    string

    +

    ID of the backup to be shared

    +

    to_project_ids

    +

    Yes

    +

    list<string>

    +

    IDs of projects with which the backup is shared

    +
    +
    +
+
  • Example request
    {
+    "shared": {
+        "to_project_ids": [
+            "722513ed0a324dadaabe5b2d0fe848c9",
+            "722513ed0a324dadaabe5b2d0fe84919"
+        ],
+        "backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d"
+    }
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    shared

    +

    Yes

    +

    dict

    +

    Information about the backup sharing

    +

    backup_id

    +

    Yes

    +

    string

    +

    Backup ID

    +

    id

    +

    Yes

    +

    string

    +

    Backup sharing ID

    +

    to_project_id

    +

    Yes

    +

    string

    +

    ID of the project to which the backup is shared

    +

    from_project_id

    +

    Yes

    +

    string

    +

    ID of the project that shares the backup

    +

    created_at

    +

    Yes

    +

    string

    +

    Creation time of the backup sharing

    +

    updated_at

    +

    Yes

    +

    string

    +

    Update time of the backup sharing

    +

    deleted

    +

    Yes

    +

    string

    +

    Whether the backup sharing has been canceled

    +

    deleted_at

    +

    Yes

    +

    string

    +

    Deletion time

    +
    +
    +
+
  • Example response
    {
+    "shared": [
+        {
+            "backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
+            "deleted": null,
+            "created_at": null,
+            "updated_at": null,
+            "to_project_id": "722513ed0a324dadaabe5b2d0fe848c9",
+            "from_project_id": "c13f5220dc1949b0b741ea81a7cd5554",
+            "deleted_at": null,
+            "id": "8332443e-9866-41d8-8a58-a898cf5db030"
+        }
+    ]
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0078214152.html b/docs/vbs/api-ref/en-us_topic_0078214152.html new file mode 100644 index 000000000..d05754dbb --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0078214152.html @@ -0,0 +1,158 @@ + + +

Canceling Sharing of a Backup

+

Function

This API is used to cancel the sharing of a backup.

+
+

URI

  • URI format

    DELETE /v2/{project_id}/os-vendor-backup-sharing/{id}

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    id

    +

    Yes

    +

    Backup ID or backup sharing ID

    +
    +
    +
+
  • Request filter parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    is_backup_id

    +

    No

    +

    boolean

    +

    Whether the ID in the URL is a backup sharing ID or a backup ID. The value true indicates a backup ID, and all backup sharings of this backup will be canceled. The value false indicates a backup sharing ID.

    +
    +
    +
  • Example request
    Canceling a specific backup sharing:
+DELETE /v2/{project_id}/os-vendor-backup-sharing/e842bf23-1e05-4c2c-b0f9-25222f4686da
+Canceling sharing of a backup:
+DELETE /v2/{project_id}/os-vendor-backup-sharing
    +
+
+

Request

None

+
+

Response

None

+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0078214153.html b/docs/vbs/api-ref/en-us_topic_0078214153.html new file mode 100644 index 000000000..57aeba8f3 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0078214153.html @@ -0,0 +1,492 @@ + + +

Querying Backup Sharings

+

Function

This API is used to query backup sharings.

+
+

URI

  • URI format

    GET /v2/{project_id}/os-vendor-backup-sharing/detail

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
  • Request filter parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    share_to_me

    +

    No

    +

    boolean

    +

    If this parameter is set to true, this API will list the backups shared with the current project. Or, this API will list the backups shared by the current project.

    +

    volume_id

    +

    No

    +

    string

    +

    Disk ID

    +

    name

    +

    No

    +

    string

    +

    Backup name. Fuzzy match is supported.

    +

    status

    +

    No

    +

    string

    +

    Backup status

    +

    backup_id

    +

    No

    +

    string

    +

    Backup ID

    +

    from_project_id

    +

    No

    +

    string

    +

    ID of the project that shares the backup

    +

    to_project_id

    +

    No

    +

    string

    +

    ID of the project to which the backup is shared

    +

    avalilability_zone

    +

    No

    +

    string

    +

    AZ name

    +

    sort_dir

    +

    No

    +

    string

    +

    Sorting direction

    +

    sort_key

    +

    No

    +

    string

    +

    Sorts by attribute. Possible values are name, status, container_format, disk_format, size, id, created_at, and updated_at. The default value is created_at.

    +

    limit

    +

    No

    +

    int

    +

    Number of sharings to be queried

    +

    offset

    +

    No

    +

    int

    +

    Offset of the query

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    shared

    +

    list<dict>

    +

    Backup sharing list

    +

    backup_id

    +

    string

    +

    Backup ID

    +

    created_at

    +

    string

    +

    Creation time of the backup sharing

    +

    from_project_id

    +

    string

    +

    ID of the project that shares the backup

    +

    id

    +

    string

    +

    Backup sharing ID

    +

    to_project_id

    +

    string

    +

    ID of the project to which the backup is shared

    +

    updated_at

    +

    string

    +

    Update time of the backup sharing

    +

    backup

    +

    dict

    +

    Details about the source backup

    +

    availability_zone

    +

    string

    +

    AZ where the backup resides

    +

    container

    +

    string

    +

    Container of the backup

    +

    created_at

    +

    string

    +

    Backup creation time

    +

    data_timestamp

    +

    string

    +

    Current time

    +

    description

    +

    string

    +

    Backup description

    +

    fail_reason

    +

    string

    +

    Cause of the backup failure

    +

    has_dependent_backup

    +

    boolean

    +

    Whether a dependent backup exists. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.

    +

    id

    +

    string

    +

    Backup ID

    +

    is_incremental

    +

    boolean

    +

    Whether the backup is an incremental backup. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.

    +

    name

    +

    string

    +

    Backup name

    +

    object_count

    +

    int

    +

    Number of objects on OBS for the disk data

    +

    size

    +

    int

    +

    Backup size

    +

    snapshot_id

    +

    string

    +

    ID of the snapshot associated with the backup

    +

    status

    +

    string

    +

    Backup status

    +

    updated_at

    +

    string

    +

    Update time of the backup

    +

    volume_id

    +

    string

    +

    Source disk ID of the backup

    +

    service_metadata

    +

    string

    +

    Backup metadata

    +
    +
    +
+
  • Example response
    {
+    "shared": [
+        {
+            "backup": {
+                "availability_zone": "AZ1",
+                "container": null,
+                "created_at": "2017-08-08T04:03:27.456859",
+                "data_timestamp": "2017-08-08T04:03:27.456859",
+                "description": null,
+                "fail_reason": "Invalid InitiatorConnector protocol specified DSWARE",
+                "has_dependent_backups": null,
+                "id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
+                "is_incremental": null,
+                "name": "lbf",
+                "object_count": null,
+                "size": 1,
+                "snapshot_id": null,
+                "status": "available",
+                "updated_at": "2017-08-08T04:03:35.109308",
+                "volume_id": "a7d7783f-02b7-4645-b0e3-61df63f0ba10",
+                "service_metadata": null
+            },
+            "backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
+            "created_at": "2017-08-10T12:25:40.480424",
+            "from_project_id": "c13f5220dc1949b0b741ea81a7cd5554",
+            "id": "e842bf23-1e05-4c2c-b0f9-25222f4686da",
+            "to_project_id": "722513ed0a324dadaabe5b2d0fe848b9",
+            "updated_at": "2017-08-14T06:41:49.381069"
+        },
+        {
+            "backup": {
+                "availability_zone": "AZ1",
+                "container": null,
+                "created_at": "2017-08-08T04:03:27.456859",
+                "data_timestamp": "2017-08-08T04:03:27.456859",
+                "description": null,
+                "fail_reason": "Invalid InitiatorConnector protocol specified DSWARE",
+                "has_dependent_backups": null,
+                "id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
+                "is_incremental": null,
+                "name": "lbf",
+                "object_count": null,
+                "size": 1,
+                "snapshot_id": null,
+                "status": "available",
+                "updated_at": "2017-08-08T04:03:35.109308",
+                "volume_id": "a7d7783f-02b7-4645-b0e3-61df63f0ba10",
+                "service_metadata": null
+            },
+            "backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
+            "created_at": "2017-08-10T12:19:37.318031",
+            "from_project_id": "c13f5220dc1949b0b741ea81a7cd5554",
+            "id": "f842bf23-1e05-4c2c-b0f9-25222f4686da",
+            "to_project_id": "722513ed0a324dadaabe5b2d0fe848a9",
+            "updated_at": null
+        }
+    ]
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0078214154.html b/docs/vbs/api-ref/en-us_topic_0078214154.html new file mode 100644 index 000000000..d78c455b4 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0078214154.html @@ -0,0 +1,233 @@ + + +

Counting Backup Sharings

+

Function

This API is used to count backup sharings with conditions.

+
+

URI

  • URI format

    GET /v2/{project_id}/os-vendor-backup-sharing/count

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
  • Request filter parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    share_to_me

    +

    No

    +

    boolean

    +

    If this parameter is set to true, this API will list the backups shared with the current project. Or, this API will list the backups shared by the current project.

    +

    volume_id

    +

    No

    +

    string

    +

    Disk ID

    +

    name

    +

    No

    +

    string

    +

    Backup name. Fuzzy match is supported.

    +

    status

    +

    No

    +

    string

    +

    Backup status

    +

    backup_id

    +

    No

    +

    string

    +

    Backup ID

    +

    from_project_id

    +

    No

    +

    string

    +

    ID of the project that shares the backup

    +

    to_project_id

    +

    No

    +

    string

    +

    ID of the project to which the backup is shared

    +

    avalilability_zone

    +

    No

    +

    string

    +

    AZ name

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    count

    +

    int

    +

    Total count

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

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0078214155.html b/docs/vbs/api-ref/en-us_topic_0078214155.html new file mode 100644 index 000000000..97d038364 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0078214155.html @@ -0,0 +1,347 @@ + + +

Querying Details About a Backup Sharing

+

Function

This API is used to query details about a backup sharing.

+
+

URI

  • URI format

    GET /v2/{project_id}/os-vendor-backup-sharing/{id}

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    id

    +

    Yes

    +

    Backup sharing ID

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    shared

    +

    dict

    +

    Information about the backup sharing

    +

    backup_id

    +

    string

    +

    Backup ID

    +

    created_at

    +

    string

    +

    Creation time of the backup sharing

    +

    from_project_id

    +

    string

    +

    ID of the project that shares the backup

    +

    id

    +

    string

    +

    Backup sharing ID

    +

    to_project_id

    +

    string

    +

    ID of the project to which the backup is shared

    +

    updated_at

    +

    string

    +

    Update time of the backup sharing

    +

    backup

    +

    dict

    +

    Details about the source backup

    +

    availability_zone

    +

    string

    +

    AZ where the backup resides

    +

    container

    +

    string

    +

    Container of the backup

    +

    created_at

    +

    string

    +

    Backup creation time

    +

    data_timestamp

    +

    string

    +

    Current time

    +

    description

    +

    string

    +

    Backup description

    +

    fail_reason

    +

    string

    +

    Cause of the backup failure

    +

    has_dependent_backup

    +

    boolean

    +

    Whether a dependent backup exists. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.

    +

    id

    +

    string

    +

    Backup ID

    +

    is_incremental

    +

    boolean

    +

    Whether the backup is an incremental backup. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.

    +

    name

    +

    string

    +

    Backup name

    +

    object_count

    +

    int

    +

    Number of objects on OBS for the disk data

    +

    size

    +

    int

    +

    Backup size

    +

    snapshot_id

    +

    string

    +

    ID of the snapshot associated with the backup

    +

    status

    +

    string

    +

    Backup status

    +

    updated_at

    +

    string

    +

    Update time of the backup

    +

    volume_id

    +

    string

    +

    Source disk ID of the backup

    +

    service_metadata

    +

    string

    +

    Backup metadata

    +
    +
    +
+
  • Example response
    {
+    "shared": {
+        "backup": {
+            "availability_zone": "AZ1",
+            "container": null,
+            "created_at": "2017-08-08T04:03:27.000000",
+            "data_timestamp": "2017-08-08T04:03:27.000000",
+            "description": null,
+            "fail_reason": "Invalid InitiatorConnector protocol specified DSWARE",
+            "has_dependent_backups": null,
+            "id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
+            "is_incremental": null,
+            "name": "lbf",
+            "object_count": 0,
+            "size": 1,
+            "snapshot_id": null,
+            "status": "available",
+            "updated_at": "2017-08-16T07:24:24.786297",
+            "volume_id": "a7d7783f-02b7-4645-b0e3-61df63f0ba10",
+            "service_metadata": null
+        },
+        "backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
+        "created_at": "2017-08-22T08:43:16.699374",
+        "from_project_id": "c13f5220dc1949b0b741ea81a7cd5554",
+        "id": "8332443e-9866-41d8-8a58-a898cf5db030",
+        "to_project_id": "722513ed0a324dadaabe5b2d0fe848c9",
+        "updated_at": null
+    }
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0098527676.html b/docs/vbs/api-ref/en-us_topic_0098527676.html new file mode 100644 index 000000000..41a01111f --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0098527676.html @@ -0,0 +1,211 @@ + + +

Adding a Tag to a Backup Policy

+

Function

This API is used to add a tag to a backup policy.

+
+

URI

  • URI format

    POST /v2/{project_id}/backuppolicy/{policy_id}/tags

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    Backup policy ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tag

    +

    Yes

    +

    dict

    +

    Tag to be added

    +

    key

    +

    Yes

    +

    string

    +

    Tag key. It contains 1 to 36 characters, chosen from letters, digits, hyphens (-), and underscores (_).

    +

    value

    +

    Yes

    +

    string

    +

    Tag value. A tag value consists of 0 to 43 characters, chosen from letters, digits, hyphens (-), and underscores (_).

    +
    +
    +
+
  • Example request
    {
+    "tag":{
+        "key":"0f187b65-8d0e-4fc0-9096-3b55d330531e",
+        "value":"volume"
+    }
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+    "error": {
+        "message": "XXXX",
+        "code": "XXX"
+    }
+}
    +
+
+

Status Code

  • Normal

    204

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0098527677.html b/docs/vbs/api-ref/en-us_topic_0098527677.html new file mode 100644 index 000000000..93bc30b3e --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0098527677.html @@ -0,0 +1,174 @@ + + +

Removing a Tag from a Backup Policy

+

Function

This API is used to remove a tag from a backup policy.

+
+

URI

  • URI format

    DELETE /v2/{project_id}/backuppolicy/{policy_id}/tags/{key}

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    policy_id

    +

    Yes

    +

    Backup policy ID

    +

    key

    +

    Yes

    +

    Tag key

    +
    NOTE:

    If the key contains special characters, encode it using ASCII first.

    +

    For example, the number sign (#) will be displayed as %23 after encoding.

    +
    +
    +
    +
+
+

Request

  • Example request
    DELETE /v2/{project_id}/backuppolicy/{policy_id}/tags/{key}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    string

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response
    {
+    "error": {
+        "message": "XXXX",
+        "code": "XXX"
+    }
+}
    +
+
+

Status Codes

  • Normal

    204

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Backup Policies
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0113236392.html b/docs/vbs/api-ref/en-us_topic_0113236392.html new file mode 100644 index 000000000..d852d5724 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0113236392.html @@ -0,0 +1,241 @@ + + +

Querying Quotas

+

Function

This API is used to query tenant quotas.

+
+

URI

  • URI

    GET /v2/{project_id}/cloudbackups/quota

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    tenant _id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description
+

None

+
  • Example request
+
  GET /v2/{project_id}/cloudbackups/quota
+
+

Response

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    quotas

    +

    Yes

    +

    map<string, string>

    +

    Quota resource information

    +
    +
    +
+
  • Parameter description of field quota +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    resources

    +

    Yes

    +

    List<resource_resp>

    +

    Quota resources

    +
    +
    +
+
  • Parameter description of field resource_resp +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    reserved

    +

    Yes

    +

    Integer

    +

    Reserved amount

    +

    used

    +

    Yes

    +

    Integer

    +

    Used amount

    +

    quota

    +

    Yes

    +

    Integer

    +

    Quota size. -1 indicates no restriction on the quota size.

    +

    type

    +

    Yes

    +

    String

    +

    Type

    +

    Enum:[ backup_gigabytes ,backups]

    +
    +
    +
+
  • Example response
    {
+    "quotas": {
+        "resources":[{
+            "type" :"backups",
+            "used" : 114,
+            "reserved" : 0,
+            "quota" : 5014
+         },
+         {
+             "type": "backup_ gigabytes",
+             "used" : 4838,
+             "reserved" : 0,
+             "quota" : -1
+          }]
+     }
+}
    +
+
+

Return Values

  • Normal
+

200

+
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0134476439.html b/docs/vbs/api-ref/en-us_topic_0134476439.html new file mode 100644 index 000000000..c88a4234d --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0134476439.html @@ -0,0 +1,13 @@ + + +

API Description

+
+
+ +
+ diff --git a/docs/vbs/api-ref/en-us_topic_0134480835.html b/docs/vbs/api-ref/en-us_topic_0134480835.html new file mode 100644 index 000000000..6466f8696 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0134480835.html @@ -0,0 +1,121 @@ + + +

Status Codes

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

    Status Code

    +

    Description

    +

    200 OK

    +

    Specifies the normal response for the GET and PUT operations.

    +

    201 Created

    +

    Specifies the normal response for the POST operation.

    +

    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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0143705534.html b/docs/vbs/api-ref/en-us_topic_0143705534.html new file mode 100644 index 000000000..797d2bcbb --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0143705534.html @@ -0,0 +1,319 @@ + + +

Creating a VBS Backup (Native OpenStack V3 API)

+

Function

This API is used to create a VBS backup.

+
+

URI

  • URI format

    POST /v3/{project_id}/backups

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    backup

    +

    Yes

    +

    dict

    +

    Backup to be created

    +

    For details, see the backup field description.

    +
    +
    +
  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    volume_id

    +

    Yes

    +

    string

    +

    ID of the disk to be backed up

    +

    snapshot_id

    +

    Yes

    +

    string

    +

    Snapshot ID of the disk to be backed up

    +

    name

    +

    No

    +

    string

    +

    Backup name. The value is a string of 1 to 64 characters that can contain digits, letters, underscores (_), and hyphens (-), not starting with auto.

    +

    description

    +

    No

    +

    string

    +

    Backup description

    +

    container

    +

    No

    +

    string

    +

    Backup container. This parameter will be skipped.

    +

    incremental

    +

    No

    +

    boolean

    +

    Whether it is an incremental backup. The value true indicates an incremental backup and false indicates a full backup. By default, VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter is skipped.

    +

    force

    +

    No

    +

    boolean

    +

    Whether to forcibly back up the attached disks. The value true indicates a forcible backup and false indicates a non-forcible backup.

    +

    project_id

    +

    No

    +

    string

    +

    Project ID

    +
    +
    +
+
  • Example request
    {    
+	"backup": {        
+		"volume_id": "c5834fe1-577f-462e-9bf3-1b158e1dde9c",        
+		"snapshot_id": "251f910a-a2bd-443e-a77a-90a3dbd26b7b",        
+		"name": "backup1",        
+		"description": "Backup_Demo"    
+	}
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backup

    +

    dict

    +

    Information about the created backup

    +

    id

    +

    string

    +

    Backup ID

    +

    name

    +

    string

    +

    Backup name

    +

    links

    +

    list<dict>

    +

    Information about the backup URL

    +

    href

    +

    string

    +

    Backup URL

    +

    rel

    +

    string

    +

    Relationship between the query result and href

    +
    +
    +
  • Example response
    {
+    "backup": {
+        "id": "bb089eba-6b38-41c8-85a4-2b94fad7d570",
+        "links": [
+            {
+                "href": "https://volume.Region.dc1.domainname.com/v3/648bba9ba87e4b3f8484d0fc60e2e6cc/backups/bb089eba-6b38-41c8-85a4-2b94fad7d570",
+                "rel": "self"
+            },
+            {
+                "href": "https://volume.Region.dc1.domainname.com/648bba9ba87e4b3f8484d0fc60e2e6cc/backups/bb089eba-6b38-41c8-85a4-2b94fad7d570",
+                "rel": "bookmark"
+            }
+        ],
+        "name": "backup1"
+    }
+}
    +

    or

    +
    {
+"badRequest": {
+"code": "XXXX",
+"message": "XXX"
+}
+}
    +
+
+

Status Codes

  • Normal

    202

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0143705535.html b/docs/vbs/api-ref/en-us_topic_0143705535.html new file mode 100644 index 000000000..bf1ca846a --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0143705535.html @@ -0,0 +1,345 @@ + + +

Querying Summary Information About VBS Backups (Native OpenStack V3 API)

+

Function

This API is used to query summary information about VBS backups.

+
+

URI

  • URI format

    GET /v3/{project_id}/backups

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
  • Request filter parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    No

    +

    string

    +

    Name of the backups to be queried. This parameter is used to query the backups whose names are specified character strings.

    +

    status

    +

    No

    +

    string

    +

    Status of the backups to be queried. This parameter is used to query the backups in a specified state. The value can be available, error, restoring, creating, deleting, or error_restoring.

    +

    offset

    +

    No

    +

    int

    +

    Offset of the queried information

    +

    limit

    +

    No

    +

    int

    +

    Maximum number of query results that can be returned

    +

    volume_id

    +

    No

    +

    string

    +

    Disk ID of the backups to be queried. It is used to query the backups for specific disks.

    +

    with_count

    +

    No

    +

    boolean

    +

    The query result contains the count field whose default value is False. This field is first available in version 3.45.

    +

    name~

    +

    No

    +

    string

    +

    Fuzzy query by backup name. This parameter is added in version 3.31.

    +

    status~

    +

    No

    +

    string

    +

    Fuzzy query by backup status. This parameter is added in version 3.31.

    +

    volume_id~

    +

    No

    +

    string

    +

    Fuzzy query by disk ID. This parameter is added in version 3.31.

    +
    +
    +

    If the version features such as with_count, name~, status~, and volume_id~ are used, add Openstack-Api-Version": volume 3.45 (3.45 is the version number) to the header when requesting the URL.

    +
    +
  • Example request
    GET /v3/{project_id}/backups?name=backup&status=error&limit=10&volume_id=7d7c6fbe-d7ee-4b4d-8bae-bdd08b5604bb
    +

    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backups

    +

    list<dict>

    +

    Backup list returned by the query request. For details, see the backup field description.

    +
    +
    +
  • backup field description +
    + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    string

    +

    Backup ID

    +

    links

    +

    list<dict>

    +

    Backup URL. For details, see the links field description.

    +

    name

    +

    string

    +

    Backup name

    +

    backups_links

    +

    list<dict>

    +

    Only part of a tenant's backup information is queried, such as query by page with the limit specified and when the number of backups exceeds 1000.

    +
    +
    +
  • links field description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    string

    +

    URL of the last backup queried

    +

    rel

    +

    string

    +

    Relationship between the query result and href. The value next indicates that some backups are not obtained.

    +
    +
    +
  • Example response
    {
+"backups": [
+{
+"id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "bookmark"
+}
+],
+"name": null
+},
+{
+"id": "b3cf7a16-decc-4beb-8077-682737d94a58",
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+"rel": "bookmark"
+}
+],
+"name": null
+}
+],
+"backups_links": [
+    {
+      "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups?limit=1&offset=1&marker=b3cf7a16-decc-4beb-8077-682737d94a58",
+      "rel": "next"
+    }
+  ]
+}
    +
+
+

Status Codes

  • Normal

    200

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

    Status Codes

    +

    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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0143705536.html b/docs/vbs/api-ref/en-us_topic_0143705536.html new file mode 100644 index 000000000..f44eac3da --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0143705536.html @@ -0,0 +1,514 @@ + + +

Querying Details About VBS Backups (Native OpenStack V3 API)

+

Function

This API is used to query the details about VBS backups.

+
+

URI

  • URI format

    GET /v3/{project_id}/backups/detail

    +
  • Parameter description +
    + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +
    +
    +
  • Request filter parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    No

    +

    string

    +

    Name of the backups to be queried. This parameter is used to query the backups whose names are specified character strings.

    +

    status

    +

    No

    +

    string

    +

    Status of the backups to be queried. This parameter is used to query the backups in a specified state. The value can be available, error, restoring, creating, deleting, or error_restoring.

    +

    offset

    +

    No

    +

    int

    +

    Offset of the queried information

    +

    limit

    +

    No

    +

    int

    +

    Maximum number of query results that can be returned

    +

    volume_id

    +

    No

    +

    string

    +

    Disk ID of the backups to be queried. It is used to query the backups for specific disks.

    +

    with_count

    +

    No

    +

    boolean

    +

    The query result contains the count field whose default value is False. This field is first available in version 3.45.

    +

    name~

    +

    No

    +

    string

    +

    Fuzzy query by backup name. This parameter is added in version 3.31.

    +

    status~

    +

    No

    +

    string

    +

    Fuzzy query by backup status. This parameter is added in version 3.31.

    +

    volume_id~

    +

    No

    +

    string

    +

    Fuzzy query by disk ID. This parameter is added in version 3.31.

    +
    +
    +

    If the version features such as with_count, name~, status~, and volume_id~ are used, add Openstack-Api-Version": volume 3.45 (3.45 is the version number) to the header when requesting the URL.

    +
    +
  • Example request
    GET /v3/{project_id}/backups/detail?name=backup&status=error&limit=10&volume_id=7d7c6fbe-d7ee-4b4d-8bae-bdd08b5604bb
    +

    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backups

    +

    list<dict>

    +

    List of queried backups

    +

    status

    +

    string

    +

    Backup status

    +

    description

    +

    string

    +

    Backup description

    +

    links

    +

    list<link>

    +

    Backup URL

    +

    availability_zone

    +

    string

    +

    AZ where the backup resides

    +

    volume_id

    +

    string

    +

    Source disk ID of the backup

    +

    fail_reason

    +

    string

    +

    Cause of the backup failure

    +

    id

    +

    string

    +

    Backup ID

    +

    size

    +

    int

    +

    Backup size

    +

    object_count

    +

    int

    +

    Number of objects on OBS for the disk data

    +

    container

    +

    string

    +

    Container of the backup

    +

    name

    +

    string

    +

    Backup name

    +

    created_at

    +

    string

    +

    Backup creation time

    +

    os-backup-project-attr:project_id

    +

    string

    +

    ID of the project that owns the VBS backup

    +

    updated_at

    +

    string

    +

    Time when the backup was updated

    +

    data_timestamp

    +

    string

    +

    Current time

    +

    has_dependent_backups

    +

    boolean

    +

    Whether a dependent backup exists

    +

    snapshot_id

    +

    string

    +

    ID of the snapshot associated with the backup

    +

    is_incremental

    +

    boolean

    +

    Whether the backup is an incremental backup. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.

    +

    count

    +

    int

    +

    Number of returned items. This parameter is first available in the 3.45 version.

    +
    +
    +
  • description parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    DESC

    +

    string

    +

    Backup description

    +

    INC

    +

    int

    +

    Whether the backup request was an incremental backup call. 1: incremental backup; 0: full backup

    +
    +
    +
  • link parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    string

    +

    URL of the last backup queried

    +

    rel

    +

    string

    +

    Relationship between the query result and href. The value next indicates that some backups are not obtained.

    +
    +
    +
  • Example response
    {
+"backups": [
+{
+"status": "error",
+"description": null,
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"rel": "bookmark"
+}
+],
+"availability_zone": null,
+"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
+"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
+"id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+"size": 1,
+"object_count": null,
+"container": "volumebackups",
+"name": null,
+"created_at": "2013-06-27T08:48:03.000000",
+"os-backup-project-attr:project_id": "b23b579f08c84228b9b4673c46f0c442",
+"snapshot_id": "66a574c0-4415-499e-b0b1-3f340d7f7932",
+"updated_at": "2019-03-27T12:36:17.596602",
+"data_timestamp": "2019-03-16T11:56:00.917245",
+"has_dependent_backups": false,
+"is_incremental": false
+},
+{
+"status": "error",
+"description": null,
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/80e17946-6e56-46e0-9547-e9ba4f1619bd",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/80e17946-6e56-46e0-9547-e9ba4f1619bd",
+"rel": "bookmark"
+}
+],
+"availability_zone": null,
+"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
+"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
+"id": "80e17946-6e56-46e0-9547-e9ba4f1619bd",
+"size": 1,
+"object_count": null,
+"container": "volumebackups",
+"name": null,
+"created_at": "2013-06-27T08:56:58.000000",
+"os-backup-project-attr:project_id": "b23b579f08c84228b9b4673c46f0c442",
+"snapshot_id": "66a574c0-4415-499e-b0b1-3f340d7f7932",
+"updated_at": "2019-03-27T12:36:17.596602",
+"data_timestamp": "2019-03-16T11:56:00.917245",
+"has_dependent_backups": false,
+"is_incremental": false
+},
+{
+"status": "error",
+"description": null,
+"links": [
+{
+"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+"rel": "self"
+},
+{
+"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
+"rel": "bookmark"
+}
+],
+"availability_zone": null,
+"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
+"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
+"id": "b3cf7a16-decc-4beb-8077-682737d94a58",
+"size": 1,
+"object_count": null,
+"container": "volumebackups",
+"name": null,
+"created_at": "2013-06-27T08:46:31.000000",
+"snapshot_id": "66a574c0-4415-499e-b0b1-3f340d7f7932",
+"updated_at": "2019-03-27T12:36:17.596602",
+"data_timestamp": "2019-03-16T11:56:00.917245",
+"has_dependent_backups": false,
+"is_incremental": false
+}
+]
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0143705537.html b/docs/vbs/api-ref/en-us_topic_0143705537.html new file mode 100644 index 000000000..dabaacb70 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0143705537.html @@ -0,0 +1,356 @@ + + +

Querying Details About a VBS Backup (Native OpenStack V3 API)

+

Function

This API is used to query details about a VBS backup.

+
+

URI

  • URI format

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

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    backup_id

    +

    Yes

    +

    Backup ID

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backup

    +

    dict

    +

    List of queried backups

    +

    status

    +

    string

    +

    Backup status

    +

    description

    +

    string

    +

    Backup description

    +

    links

    +

    list<link>

    +

    Backup URL

    +

    availability_zone

    +

    string

    +

    AZ where the backup resides

    +

    volume_id

    +

    string

    +

    Source disk ID of the backup

    +

    fail_reason

    +

    string

    +

    Cause of the backup failure

    +

    id

    +

    string

    +

    Backup ID

    +

    size

    +

    int

    +

    Backup size

    +

    object_count

    +

    int

    +

    Number of objects on OBS for the disk data

    +

    container

    +

    string

    +

    Container of the backup

    +

    name

    +

    string

    +

    Backup name

    +

    created_at

    +

    string

    +

    Backup creation time

    +

    os-backup-project-attr:tenant_id

    +

    string

    +

    ID of the project that owns the VBS backup

    +

    updated_at

    +

    string

    +

    Update time of the backup

    +

    data_timestamp

    +

    string

    +

    Current time

    +

    has_dependent_backups

    +

    boolean

    +

    Whether a dependent backup exists

    +

    snapshot_id

    +

    string

    +

    ID of the snapshot associated with the backup

    +

    is_incremental

    +

    boolean

    +

    Whether the backup is an incremental backup

    +
    +
    +
  • description parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    DESC

    +

    string

    +

    Backup description

    +

    INC

    +

    int

    +

    Whether the backup request was an incremental backup call. 1: incremental backup; 0: full backup

    +
    +
    +
  • link parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    string

    +

    URL of the last backup queried

    +

    rel

    +

    string

    +

    Relationship between the query result and href. The value next indicates that some backups are not obtained.

    +
    +
    +
  • Example response
    {
+	"backup": {
+		"status": "error",
+		"description": null,
+		"links": [{
+			"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+			"rel": "self"
+		},
+		{
+			"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+			"rel": "bookmark"
+		}],
+		"availability_zone": null,
+		"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
+		"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
+		"id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
+		"size": 1,
+		"object_count": null,
+		"container": "volumebackups",
+		"name": null,
+		"created_at": "2013-06-27T08:48:03.000000",
+		"os-backup-project-attr:project_id": "b23b579f08c84228b9b4673c46f0c442",
+		"snapshot_id": "66a574c0-4415-499e-b0b1-3f340d7f7932",
+		"updated_at": "2019-03-27T12:36:17.596602",
+		"data_timestamp": "2019-03-16T11:56:00.917245",
+		"has_dependent_backups": false,
+		"is_incremental": false
+	}
+}
    +
+
+

Status Codes

  • Normal

    200

    +
  • 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 requested page.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0143705538.html b/docs/vbs/api-ref/en-us_topic_0143705538.html new file mode 100644 index 000000000..8c6baea91 --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0143705538.html @@ -0,0 +1,164 @@ + + +

Deleting a VBS Backup (Native OpenStack V3 API)

+

Function

This API is used to delete a VBS backup.

+
+

URI

  • URI format

    DELETE /v3/{project_id}/backups/{backup_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    backup_id

    +

    Yes

    +

    ID of the backup to be deleted

    +
    +
    +
+
+

Request

None

+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    message

    +

    string

    +

    Error message returned after an error occurs

    +

    code

    +

    int

    +

    Error code returned after an error occurs

    +

    For details about error codes, see Error Codes.

    +
    +
    +
  • Example response

    None

    +

    or

    +
    { 
+"itemNotFound": { 
+"message": "Backup 592a0c4d-65a3-4051-8d51-1e2b6401b2d8 could not be found.", 
+"code": 404 } 
+}
    +
+
+

Status Codes

  • Normal

    202

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

    Status Codes

    +

    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 requested page.

    +

    404 Not Found

    +

    The server could not find the requested page or resources.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/en-us_topic_0143705539.html b/docs/vbs/api-ref/en-us_topic_0143705539.html new file mode 100644 index 000000000..efa705b3d --- /dev/null +++ b/docs/vbs/api-ref/en-us_topic_0143705539.html @@ -0,0 +1,208 @@ + + +

Restoring a Disk Using a VBS Backup (Native OpenStack V3 API)

+

Function

This API is used to restore a disk using a VBS backup.

+
+

URI

  • URI format

    POST /v3/{project_id}/backups/{backup_id}/restore

    +
  • Parameter description +
    + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Description

    +

    project_id

    +

    Yes

    +

    Project ID

    +

    backup_id

    +

    Yes

    +

    ID of the backup used to restore a disk

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    restore

    +

    Yes

    +

    dict

    +

    Information about the disk to be restored

    +

    volume_id

    +

    Yes

    +

    string

    +

    ID of the disk to be restored

    +
    +
    +
+
  • Example request
    {
+    "restore": {
+        "volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024"
+    }
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    backup_id

    +

    String

    +

    Backup ID

    +

    volume_id

    +

    String

    +

    Disk ID

    +

    volume_name

    +

    String

    +

    Disk name

    +
    +
    +
  • Example response
    {
+    "restore": {
+        "backup_id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2", 
+        "volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024"
+        "volume_name": "test_volume"
+    }
+}
    +
+
+

Status Codes

  • Normal

    202

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

    Status Codes

    +

    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 requested page.

    +

    404 Not Found

    +

    The server could not find the requested page or resources.

    +

    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 could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

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

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the service is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: VBS Backups
+
+
+ diff --git a/docs/vbs/api-ref/public_sys-resources/ExpandCollapse.js b/docs/vbs/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 000000000..116ddaabf --- /dev/null +++ b/docs/vbs/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/vbs/api-ref/public_sys-resources/avgCompile.js b/docs/vbs/api-ref/public_sys-resources/avgCompile.js new file mode 100644 index 000000000..327822688 --- /dev/null +++ b/docs/vbs/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/vbs/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/vbs/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/vbs/api-ref/public_sys-resources/commonltr_print.css b/docs/vbs/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 000000000..a59823141 --- /dev/null +++ b/docs/vbs/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/vbs/api-ref/public_sys-resources/commonrtl.css b/docs/vbs/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 000000000..f261da752 --- /dev/null +++ b/docs/vbs/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/vbs/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/vbs/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/vbs/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/vbs/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/vbs/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/vbs/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/vbs/api-ref/public_sys-resources/icon-danger.gif b/docs/vbs/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/vbs/api-ref/public_sys-resources/icon-huawei.gif b/docs/vbs/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/vbs/api-ref/public_sys-resources/icon-notice.gif b/docs/vbs/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/vbs/api-ref/public_sys-resources/icon-tip.gif b/docs/vbs/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/vbs/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/vbs/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/vbs/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/vbs/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