From daef1357e6715f1ee79bb90b2b5ea657a0533f36 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Tue, 25 Oct 2022 09:38:20 +0000 Subject: [PATCH] manually adding BMS content due to bug in gitea Reviewed-by: Kucerak, Kristian Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- docs/bms/api-ref/.placeholder | 0 docs/bms/api-ref/ALL_META.TXT.json | 532 +++++++ docs/bms/api-ref/CLASS.TXT.json | 479 +++++++ docs/bms/api-ref/PARAMETERS.txt | 3 + docs/bms/api-ref/en-us_topic_0053158611.html | 82 ++ docs/bms/api-ref/en-us_topic_0053158613.html | 21 + docs/bms/api-ref/en-us_topic_0053158614.html | 218 +++ docs/bms/api-ref/en-us_topic_0053158658.html | 148 ++ docs/bms/api-ref/en-us_topic_0053158659.html | 100 ++ docs/bms/api-ref/en-us_topic_0053158662.html | 142 ++ docs/bms/api-ref/en-us_topic_0053158665.html | 156 +++ docs/bms/api-ref/en-us_topic_0053158668.html | 19 + docs/bms/api-ref/en-us_topic_0053158674.html | 256 ++++ docs/bms/api-ref/en-us_topic_0053158678.html | 197 +++ docs/bms/api-ref/en-us_topic_0053158679.html | 406 ++++++ docs/bms/api-ref/en-us_topic_0053158680.html | 23 + docs/bms/api-ref/en-us_topic_0053158682.html | 475 +++++++ docs/bms/api-ref/en-us_topic_0053158683.html | 80 ++ docs/bms/api-ref/en-us_topic_0053158684.html | 286 ++++ docs/bms/api-ref/en-us_topic_0053158685.html | 129 ++ docs/bms/api-ref/en-us_topic_0053158687.html | 201 +++ docs/bms/api-ref/en-us_topic_0053158688.html | 17 + docs/bms/api-ref/en-us_topic_0053158690.html | 121 ++ docs/bms/api-ref/en-us_topic_0053158693.html | 324 +++++ docs/bms/api-ref/en-us_topic_0053158695.html | 190 +++ docs/bms/api-ref/en-us_topic_0053158696.html | 161 +++ docs/bms/api-ref/en-us_topic_0053158703.html | 21 + docs/bms/api-ref/en-us_topic_0053158707.html | 907 ++++++++++++ docs/bms/api-ref/en-us_topic_0053158710.html | 521 +++++++ docs/bms/api-ref/en-us_topic_0053158711.html | 17 + docs/bms/api-ref/en-us_topic_0053158712.html | 185 +++ docs/bms/api-ref/en-us_topic_0053158713.html | 71 + docs/bms/api-ref/en-us_topic_0053158716.html | 133 ++ docs/bms/api-ref/en-us_topic_0060323087.html | 13 + docs/bms/api-ref/en-us_topic_0060384657.html | 21 + docs/bms/api-ref/en-us_topic_0060384658.html | 170 +++ docs/bms/api-ref/en-us_topic_0060384659.html | 196 +++ docs/bms/api-ref/en-us_topic_0060384660.html | 221 +++ docs/bms/api-ref/en-us_topic_0060384661.html | 71 + docs/bms/api-ref/en-us_topic_0060402469.html | 123 ++ docs/bms/api-ref/en-us_topic_0060410925.html | 25 + docs/bms/api-ref/en-us_topic_0060410926.html | 107 ++ docs/bms/api-ref/en-us_topic_0060410927.html | 148 ++ docs/bms/api-ref/en-us_topic_0060410928.html | 75 + docs/bms/api-ref/en-us_topic_0060410929.html | 85 ++ docs/bms/api-ref/en-us_topic_0060410930.html | 95 ++ docs/bms/api-ref/en-us_topic_0060424486.html | 85 ++ docs/bms/api-ref/en-us_topic_0107541808.html | 1241 +++++++++++++++++ docs/bms/api-ref/en-us_topic_0114885743.html | 123 ++ docs/bms/api-ref/en-us_topic_0131054288.html | 73 + docs/bms/api-ref/en-us_topic_0134720581.html | 17 + docs/bms/api-ref/en-us_topic_0134720582.html | 150 ++ docs/bms/api-ref/en-us_topic_0134720583.html | 192 +++ docs/bms/api-ref/en-us_topic_0143138428.html | 8 + docs/bms/api-ref/en-us_topic_0171226370.html | 31 + docs/bms/api-ref/en-us_topic_0171226371.html | 12 + docs/bms/api-ref/en-us_topic_0173933989.html | 21 + .../public_sys-resources/ExpandCollapse.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 .../bms/api-ref/public_sys-resources/popup.js | 1 + .../api-ref/public_sys-resources/pygments.css | 1 + .../warning_3.0-en-us.png | Bin 0 -> 3164 bytes 79 files changed, 9931 insertions(+) delete mode 100644 docs/bms/api-ref/.placeholder create mode 100644 docs/bms/api-ref/ALL_META.TXT.json create mode 100644 docs/bms/api-ref/CLASS.TXT.json create mode 100644 docs/bms/api-ref/PARAMETERS.txt create mode 100644 docs/bms/api-ref/en-us_topic_0053158611.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158613.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158614.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158658.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158659.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158662.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158665.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158668.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158674.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158678.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158679.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158680.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158682.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158683.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158684.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158685.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158687.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158688.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158690.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158693.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158695.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158696.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158703.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158707.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158710.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158711.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158712.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158713.html create mode 100644 docs/bms/api-ref/en-us_topic_0053158716.html create mode 100644 docs/bms/api-ref/en-us_topic_0060323087.html create mode 100644 docs/bms/api-ref/en-us_topic_0060384657.html create mode 100644 docs/bms/api-ref/en-us_topic_0060384658.html create mode 100644 docs/bms/api-ref/en-us_topic_0060384659.html create mode 100644 docs/bms/api-ref/en-us_topic_0060384660.html create mode 100644 docs/bms/api-ref/en-us_topic_0060384661.html create mode 100644 docs/bms/api-ref/en-us_topic_0060402469.html create mode 100644 docs/bms/api-ref/en-us_topic_0060410925.html create mode 100644 docs/bms/api-ref/en-us_topic_0060410926.html create mode 100644 docs/bms/api-ref/en-us_topic_0060410927.html create mode 100644 docs/bms/api-ref/en-us_topic_0060410928.html create mode 100644 docs/bms/api-ref/en-us_topic_0060410929.html create mode 100644 docs/bms/api-ref/en-us_topic_0060410930.html create mode 100644 docs/bms/api-ref/en-us_topic_0060424486.html create mode 100644 docs/bms/api-ref/en-us_topic_0107541808.html create mode 100644 docs/bms/api-ref/en-us_topic_0114885743.html create mode 100644 docs/bms/api-ref/en-us_topic_0131054288.html create mode 100644 docs/bms/api-ref/en-us_topic_0134720581.html create mode 100644 docs/bms/api-ref/en-us_topic_0134720582.html create mode 100644 docs/bms/api-ref/en-us_topic_0134720583.html create mode 100644 docs/bms/api-ref/en-us_topic_0143138428.html create mode 100644 docs/bms/api-ref/en-us_topic_0171226370.html create mode 100644 docs/bms/api-ref/en-us_topic_0171226371.html create mode 100644 docs/bms/api-ref/en-us_topic_0173933989.html create mode 100644 docs/bms/api-ref/public_sys-resources/ExpandCollapse.js create mode 100644 docs/bms/api-ref/public_sys-resources/caution_3.0-en-us.png create mode 100644 docs/bms/api-ref/public_sys-resources/commonltr.css create mode 100644 docs/bms/api-ref/public_sys-resources/commonltr_print.css create mode 100644 docs/bms/api-ref/public_sys-resources/commonrtl.css create mode 100644 docs/bms/api-ref/public_sys-resources/danger_3.0-en-us.png create mode 100644 docs/bms/api-ref/public_sys-resources/delta.gif create mode 100644 docs/bms/api-ref/public_sys-resources/deltaend.gif create mode 100644 docs/bms/api-ref/public_sys-resources/icon-arrowdn.gif create mode 100644 docs/bms/api-ref/public_sys-resources/icon-arrowrt.gif create mode 100644 docs/bms/api-ref/public_sys-resources/icon-caution.gif create mode 100644 docs/bms/api-ref/public_sys-resources/icon-danger.gif create mode 100644 docs/bms/api-ref/public_sys-resources/icon-huawei.gif create mode 100644 docs/bms/api-ref/public_sys-resources/icon-note.gif create mode 100644 docs/bms/api-ref/public_sys-resources/icon-notice.gif create mode 100644 docs/bms/api-ref/public_sys-resources/icon-tip.gif create mode 100644 docs/bms/api-ref/public_sys-resources/icon-warning.gif create mode 100644 docs/bms/api-ref/public_sys-resources/note_3.0-en-us.png create mode 100644 docs/bms/api-ref/public_sys-resources/notice_3.0-en-us.png create mode 100644 docs/bms/api-ref/public_sys-resources/popup.js create mode 100644 docs/bms/api-ref/public_sys-resources/pygments.css create mode 100644 docs/bms/api-ref/public_sys-resources/warning_3.0-en-us.png diff --git a/docs/bms/api-ref/.placeholder b/docs/bms/api-ref/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/bms/api-ref/ALL_META.TXT.json b/docs/bms/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..f68420567 --- /dev/null +++ b/docs/bms/api-ref/ALL_META.TXT.json @@ -0,0 +1,532 @@ +[ + { + "uri":"en-us_topic_0143138428.html", + "product_code":"bms", + "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_0171226370.html", + "product_code":"bms", + "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":"Native OpenStack Nova V2.1 APIs", + "title":"Native OpenStack Nova V2.1 APIs", + "githuburl":"" + }, + { + "uri":"en-us_topic_0171226371.html", + "product_code":"bms", + "code":"3", + "des":"BMS does not have independent endpoints. When API calls are made to the BMS service, ECS APIs are used. Therefore, ensure that you use the ECS service endpoints when you ", + "doc_type":"api", + "kw":"API Use Instructions,Native OpenStack Nova V2.1 APIs,API Reference", + "title":"API Use Instructions", + "githuburl":"" + }, + { + "uri":"en-us_topic_0134720581.html", + "product_code":"bms", + "code":"4", + "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 Version Query", + "title":"API Version Query", + "githuburl":"" + }, + { + "uri":"en-us_topic_0134720582.html", + "product_code":"bms", + "code":"5", + "des":"This interface is used to query all available Nova versions.GET /Request parametersNoneNoneExample requestGET https://{ECS Endpoint}/Response parametersParameterTypeDescr", + "doc_type":"api", + "kw":"Querying API Versions (Native OpenStack API),API Version Query,API Reference", + "title":"Querying API Versions (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0134720583.html", + "product_code":"bms", + "code":"6", + "des":"This API is used to query a specified API version.GET /{api_version}Table 1 lists the parameters.Request parametersNoneNoneExample requestGET https://{ECS Endpoint}/v2Res", + "doc_type":"api", + "kw":"Querying an API Version (Native OpenStack API),API Version Query,API Reference", + "title":"Querying an API Version (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158680.html", + "product_code":"bms", + "code":"7", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"BMS Lifecycle Management", + "title":"BMS Lifecycle Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158682.html", + "product_code":"bms", + "code":"8", + "des":"This interface is used to create a BMS.This interface cannot be used to create BMSs in batches.When you create a BMS using an image that supports Cloud-Init or Cloudbase-", + "doc_type":"api", + "kw":"Creating a BMS (Native OpenStack API),BMS Lifecycle Management,API Reference", + "title":"Creating a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158713.html", + "product_code":"bms", + "code":"9", + "des":"This interface is used to delete a BMS.DELETE /v2.1/{project_id}/servers/{server_id}Table 1 lists the parameters.Request parametersNoneNoneExample requestDELETE https://{", + "doc_type":"api", + "kw":"Deleting a BMS (Native OpenStack API),BMS Lifecycle Management,API Reference", + "title":"Deleting a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158707.html", + "product_code":"bms", + "code":"10", + "des":"This API is used to query details about a BMS based on the BMS ID.GET /v2.1/{project_id}/servers/{server_id}Table 1 lists the parameters.Request parametersNoneNoneExample", + "doc_type":"api", + "kw":"Querying Details About a BMS (Native OpenStack API),BMS Lifecycle Management,API Reference", + "title":"Querying Details About a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158693.html", + "product_code":"bms", + "code":"11", + "des":"This API is used to query BMSs.The query result returned by this interface includes both ECSs and BMSs. You need to filter out the BMSs using the flavor used to create th", + "doc_type":"api", + "kw":"Querying BMSs (Native OpenStack API),BMS Lifecycle Management,API Reference", + "title":"Querying BMSs (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158679.html", + "product_code":"bms", + "code":"12", + "des":"This API is used to query details about BMSs.The query result returned by this interface includes both ECS and BMS details. You need to filter out the BMS details using t", + "doc_type":"api", + "kw":"Querying Details About BMSs (Native OpenStack API),BMS Lifecycle Management,API Reference", + "title":"Querying Details About BMSs (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158613.html", + "product_code":"bms", + "code":"13", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"BMS Status Management", + "title":"BMS Status Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158710.html", + "product_code":"bms", + "code":"14", + "des":"This interface is used to modify BMS information. Currently, only the name of the BMS can be changed.PUT /v2.1/{project_id}/servers/{server_id}Table 1 lists the parameter", + "doc_type":"api", + "kw":"Changing the Name of a BMS (Native OpenStack API),BMS Status Management,API Reference", + "title":"Changing the Name of a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158659.html", + "product_code":"bms", + "code":"15", + "des":"This API is used to start a single BMS.POST /v2.1/{project_id}/servers/{server_id}/actionTable 1 lists the parameters.Request parametersParameterMandatoryTypeDescriptiono", + "doc_type":"api", + "kw":"Starting a BMS (Native OpenStack API),BMS Status Management,API Reference", + "title":"Starting a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158716.html", + "product_code":"bms", + "code":"16", + "des":"This API is used to restart a single BMS.Currently, only forcible restart is supported.POST /v2.1/{project_id}/servers/{server_id}/actionTable 1 lists the parameters.Requ", + "doc_type":"api", + "kw":"Restarting a BMS (Native OpenStack API),BMS Status Management,API Reference", + "title":"Restarting a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158685.html", + "product_code":"bms", + "code":"17", + "des":"This API is used to stop a single BMS.The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active or error.Currently, only forcible stopping is supported.POST /v2.1", + "doc_type":"api", + "kw":"Stopping a BMS (Native OpenStack API),BMS Status Management,API Reference", + "title":"Stopping a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0173933989.html", + "product_code":"bms", + "code":"18", + "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":"BMS Metadata Management", + "title":"BMS Metadata Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060402469.html", + "product_code":"bms", + "code":"19", + "des":"The BMS metadata includes BMS basic information on the cloud platform, such as the BMS ID, hostname, and network information. This API is used to query the BMS metadata.P", + "doc_type":"api", + "kw":"Querying BMS Metadata (Native OpenStack API),BMS Metadata Management,API Reference", + "title":"Querying BMS Metadata (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158712.html", + "product_code":"bms", + "code":"20", + "des":"This API is used to update BMS metadata.If the metadata does not contain the target field, the field is automatically added to the field.If the metadata contains the targ", + "doc_type":"api", + "kw":"Updating BMS Metadata (Native OpenStack API),BMS Metadata Management,API Reference", + "title":"Updating BMS Metadata (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158695.html", + "product_code":"bms", + "code":"21", + "des":"This API is used to modify specified BMS metadata.The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, paused, or suspended.PUT /v2.1/{project_id}/", + "doc_type":"api", + "kw":"Modifying Specified BMS Metadata (Native OpenStack API),BMS Metadata Management,API Reference", + "title":"Modifying Specified BMS Metadata (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158683.html", + "product_code":"bms", + "code":"22", + "des":"This API is used to delete specified BMS metadata.The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, paused, or suspended.DELETE /v2.1/{project_i", + "doc_type":"api", + "kw":"Deleting Specified BMS Metadata (Native OpenStack API),BMS Metadata Management,API Reference", + "title":"Deleting Specified BMS Metadata (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158688.html", + "product_code":"bms", + "code":"23", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"BMS IP Address Query", + "title":"BMS IP Address Query", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158696.html", + "product_code":"bms", + "code":"24", + "des":"This API is used to query private IP addresses of a BMS.Pagination query is not supported.GET /v2.1/{project_id}/servers/{server_id}/ipsTable 1 lists the parameters.Reque", + "doc_type":"api", + "kw":"Querying IP Addresses of a BMS (Native OpenStack API),BMS IP Address Query,API Reference", + "title":"Querying IP Addresses of a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158662.html", + "product_code":"bms", + "code":"25", + "des":"This API is used to query the specified IP address of a BMS based on the network name.GET /v2.1/{project_id}/servers/{server_id}/ips/{vpc_id}Table 1 lists the parameters.", + "doc_type":"api", + "kw":"Querying the Specified IP Address of a BMS (Native OpenStack API),BMS IP Address Query,API Reference", + "title":"Querying the Specified IP Address of a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158668.html", + "product_code":"bms", + "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":"BMS Flavor Query", + "title":"BMS Flavor Query", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158684.html", + "product_code":"bms", + "code":"27", + "des":"This API is used to query BMS flavors.The flavors you obtained using this API are all the flavors in the system. The flavors whose names starting with physical are BMS fl", + "doc_type":"api", + "kw":"Querying BMS Flavors (Native OpenStack API),BMS Flavor Query,API Reference", + "title":"Querying BMS Flavors (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158674.html", + "product_code":"bms", + "code":"28", + "des":"This API is used to query details about a BMS flavor, such as the flavor name, CPU cores, and memory.GET /v2.1/{project_id}/flavors/{flavor_id}Table 1 lists the parameter", + "doc_type":"api", + "kw":"Querying Details About a BMS Flavor (Native OpenStack API),BMS Flavor Query,API Reference", + "title":"Querying Details About a BMS Flavor (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0114885743.html", + "product_code":"bms", + "code":"29", + "des":"extra_specs parameters specify the key-value pair of a BMS flavor. For example, baremetal:extBootType specifies the boot device of the BMS. Its value can be LocalDisk (lo", + "doc_type":"api", + "kw":"Querying Details About extra_specs Parameters of a BMS Flavor (Native OpenStack API),BMS Flavor Quer", + "title":"Querying Details About extra_specs Parameters of a BMS Flavor (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158711.html", + "product_code":"bms", + "code":"30", + "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":"BMS NIC Management", + "title":"BMS NIC Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158678.html", + "product_code":"bms", + "code":"31", + "des":"This API is used to query information about BMS NICs, such as the MAC addresses and private IP addresses.GET /v2.1/{project_id}/servers/{server_id}/os-interfaceTable 1 li", + "doc_type":"api", + "kw":"Querying Information About BMS NICs (Native OpenStack API),BMS NIC Management,API Reference", + "title":"Querying Information About BMS NICs (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158687.html", + "product_code":"bms", + "code":"32", + "des":"This API is used to query information about a specified BMS NIC based on the NIC ID.GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id}Table 1 lists the paramete", + "doc_type":"api", + "kw":"Querying Information About a Specified BMS NIC (Native OpenStack API),BMS NIC Management,API Referen", + "title":"Querying Information About a Specified BMS NIC (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158703.html", + "product_code":"bms", + "code":"33", + "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":"BMS Disk Management", + "title":"BMS Disk Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158658.html", + "product_code":"bms", + "code":"34", + "des":"This API is used to query information about the EVS disks attached to a BMS.GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachmentsTable 1 lists the parameters.R", + "doc_type":"api", + "kw":"Querying Information About the Disks Attached to a BMS (Native OpenStack API),BMS Disk Management,AP", + "title":"Querying Information About the Disks Attached to a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158665.html", + "product_code":"bms", + "code":"35", + "des":"This API is used to query information about a single disk attached to a BMS based on the disk ID.GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_", + "doc_type":"api", + "kw":"Querying Information About a Disk Attached to a BMS (Native OpenStack API),BMS Disk Management,API R", + "title":"Querying Information About a Disk Attached to a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158614.html", + "product_code":"bms", + "code":"36", + "des":"This API is used to attach an EVS disk to a BMS.A bootable disk cannot be attached to a BMS.A disk cannot be attached to a BMS when the BMS is in the SUSPENDED or PAUSED ", + "doc_type":"api", + "kw":"Attaching an EVS Disk to a BMS (Native OpenStack API),BMS Disk Management,API Reference", + "title":"Attaching an EVS Disk to a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158611.html", + "product_code":"bms", + "code":"37", + "des":"This API is used to detach an EVS disk from a BMS.If a BMS is stopped, disks can be detached from it without any limitation on the OS. If a BMS is in running state, the c", + "doc_type":"api", + "kw":"Detaching an EVS Disk from a BMS (Native OpenStack API),BMS Disk Management,API Reference", + "title":"Detaching an EVS Disk from a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060384657.html", + "product_code":"bms", + "code":"38", + "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":"BMS SSH Key Pair Management", + "title":"BMS SSH Key Pair Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060384658.html", + "product_code":"bms", + "code":"39", + "des":"This interface is used to query SSH key pairs and to display the query results in a list.Pagination query is not supported.GET /v2.1/{project_id}/os-keypairsTable 1 lists", + "doc_type":"api", + "kw":"Querying SSH Key Pairs (Native OpenStack API),BMS SSH Key Pair Management,API Reference", + "title":"Querying SSH Key Pairs (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060384659.html", + "product_code":"bms", + "code":"40", + "des":"This interface is used to query a specified SSH key pair based on the key pair name.GET /v2.1/{project_id}/os-keypairs/{keypair_name}Table 1 lists the parameters.Request ", + "doc_type":"api", + "kw":"Querying an SSH Key Pair (Native OpenStack API),BMS SSH Key Pair Management,API Reference", + "title":"Querying an SSH Key Pair (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060384660.html", + "product_code":"bms", + "code":"41", + "des":"This interface is used to create an SSH key pair or import a public key to generate a key pair.After an SSH key is created, download the private key to a local directory.", + "doc_type":"api", + "kw":"Creating and Importing an SSH Key Pair (Native OpenStack API),BMS SSH Key Pair Management,API Refere", + "title":"Creating and Importing an SSH Key Pair (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060384661.html", + "product_code":"bms", + "code":"42", + "des":"This interface is used to delete a specified SSH key pair based on the key pair name.DELETE /v2.1/{project_id}/os-keypairs/{keypair_name}Table 1 lists the parameters.Requ", + "doc_type":"api", + "kw":"Deleting an SSH Key Pair (Native OpenStack API),BMS SSH Key Pair Management,API Reference", + "title":"Deleting an SSH Key Pair (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060410925.html", + "product_code":"bms", + "code":"43", + "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":"BMS 1D Tag Management", + "title":"BMS 1D Tag Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060410926.html", + "product_code":"bms", + "code":"44", + "des":"This API is used to query all tags of a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.GET /v2.", + "doc_type":"api", + "kw":"Querying BMS Tags (Native OpenStack API),BMS 1D Tag Management,API Reference", + "title":"Querying BMS Tags (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060410927.html", + "product_code":"bms", + "code":"45", + "des":"This API is used to add tags to a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.A BMS can have", + "doc_type":"api", + "kw":"Adding Tags to a BMS (Native OpenStack API),BMS 1D Tag Management,API Reference", + "title":"Adding Tags to a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060410928.html", + "product_code":"bms", + "code":"46", + "des":"This API is used to delete all tags of a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.Tag __t", + "doc_type":"api", + "kw":"Deleting Tags of a BMS (Native OpenStack API),BMS 1D Tag Management,API Reference", + "title":"Deleting Tags of a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060410929.html", + "product_code":"bms", + "code":"47", + "des":"This API is used to add a tag to a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.A BMS can hav", + "doc_type":"api", + "kw":"Adding a Tag to a BMS (Native OpenStack API),BMS 1D Tag Management,API Reference", + "title":"Adding a Tag to a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060410930.html", + "product_code":"bms", + "code":"48", + "des":"This API is used to check whether a BMS has a specified tag.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the", + "doc_type":"api", + "kw":"Checking for Tags of a BMS (Native OpenStack API),BMS 1D Tag Management,API Reference", + "title":"Checking for Tags of a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060424486.html", + "product_code":"bms", + "code":"49", + "des":"This API is used to delete a tag of a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.The tag co", + "doc_type":"api", + "kw":"Deleting a Tag of a BMS (Native OpenStack API),BMS 1D Tag Management,API Reference", + "title":"Deleting a Tag of a BMS (Native OpenStack API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0060323087.html", + "product_code":"bms", + "code":"50", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Public Parameters", + "title":"Public Parameters", + "githuburl":"" + }, + { + "uri":"en-us_topic_0053158690.html", + "product_code":"bms", + "code":"51", + "des":"NormalReturned ValueDescription200 OKThe request has been successfully processed.201 CreatedThe request has been successfully processed and a resource has been created.20", + "doc_type":"api", + "kw":"Status Codes,Public Parameters,API Reference", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"en-us_topic_0107541808.html", + "product_code":"bms", + "code":"52", + "des":"An error code returned by an API does not correspond to one error message. The following table lists only common error messages.Most BMS APIs are asynchronous. Some error", + "doc_type":"api", + "kw":"Error Codes,Public Parameters,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"en-us_topic_0131054288.html", + "product_code":"bms", + "code":"53", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/bms/api-ref/CLASS.TXT.json b/docs/bms/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..efe67c7d0 --- /dev/null +++ b/docs/bms/api-ref/CLASS.TXT.json @@ -0,0 +1,479 @@ +[ + { + "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":"bms", + "title":"API Usage Guidelines", + "uri":"en-us_topic_0143138428.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":"bms", + "title":"Native OpenStack Nova V2.1 APIs", + "uri":"en-us_topic_0171226370.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "desc":"BMS does not have independent endpoints. When API calls are made to the BMS service, ECS APIs are used. Therefore, ensure that you use the ECS service endpoints when you ", + "product_code":"bms", + "title":"API Use Instructions", + "uri":"en-us_topic_0171226371.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "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":"bms", + "title":"API Version Query", + "uri":"en-us_topic_0134720581.html", + "doc_type":"api", + "p_code":"2", + "code":"4" + }, + { + "desc":"This interface is used to query all available Nova versions.GET /Request parametersNoneNoneExample requestGET https://{ECS Endpoint}/Response parametersParameterTypeDescr", + "product_code":"bms", + "title":"Querying API Versions (Native OpenStack API)", + "uri":"en-us_topic_0134720582.html", + "doc_type":"api", + "p_code":"4", + "code":"5" + }, + { + "desc":"This API is used to query a specified API version.GET /{api_version}Table 1 lists the parameters.Request parametersNoneNoneExample requestGET https://{ECS Endpoint}/v2Res", + "product_code":"bms", + "title":"Querying an API Version (Native OpenStack API)", + "uri":"en-us_topic_0134720583.html", + "doc_type":"api", + "p_code":"4", + "code":"6" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"bms", + "title":"BMS Lifecycle Management", + "uri":"en-us_topic_0053158680.html", + "doc_type":"api", + "p_code":"2", + "code":"7" + }, + { + "desc":"This interface is used to create a BMS.This interface cannot be used to create BMSs in batches.When you create a BMS using an image that supports Cloud-Init or Cloudbase-", + "product_code":"bms", + "title":"Creating a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158682.html", + "doc_type":"api", + "p_code":"7", + "code":"8" + }, + { + "desc":"This interface is used to delete a BMS.DELETE /v2.1/{project_id}/servers/{server_id}Table 1 lists the parameters.Request parametersNoneNoneExample requestDELETE https://{", + "product_code":"bms", + "title":"Deleting a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158713.html", + "doc_type":"api", + "p_code":"7", + "code":"9" + }, + { + "desc":"This API is used to query details about a BMS based on the BMS ID.GET /v2.1/{project_id}/servers/{server_id}Table 1 lists the parameters.Request parametersNoneNoneExample", + "product_code":"bms", + "title":"Querying Details About a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158707.html", + "doc_type":"api", + "p_code":"7", + "code":"10" + }, + { + "desc":"This API is used to query BMSs.The query result returned by this interface includes both ECSs and BMSs. You need to filter out the BMSs using the flavor used to create th", + "product_code":"bms", + "title":"Querying BMSs (Native OpenStack API)", + "uri":"en-us_topic_0053158693.html", + "doc_type":"api", + "p_code":"7", + "code":"11" + }, + { + "desc":"This API is used to query details about BMSs.The query result returned by this interface includes both ECS and BMS details. You need to filter out the BMS details using t", + "product_code":"bms", + "title":"Querying Details About BMSs (Native OpenStack API)", + "uri":"en-us_topic_0053158679.html", + "doc_type":"api", + "p_code":"7", + "code":"12" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"bms", + "title":"BMS Status Management", + "uri":"en-us_topic_0053158613.html", + "doc_type":"api", + "p_code":"2", + "code":"13" + }, + { + "desc":"This interface is used to modify BMS information. Currently, only the name of the BMS can be changed.PUT /v2.1/{project_id}/servers/{server_id}Table 1 lists the parameter", + "product_code":"bms", + "title":"Changing the Name of a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158710.html", + "doc_type":"api", + "p_code":"13", + "code":"14" + }, + { + "desc":"This API is used to start a single BMS.POST /v2.1/{project_id}/servers/{server_id}/actionTable 1 lists the parameters.Request parametersParameterMandatoryTypeDescriptiono", + "product_code":"bms", + "title":"Starting a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158659.html", + "doc_type":"api", + "p_code":"13", + "code":"15" + }, + { + "desc":"This API is used to restart a single BMS.Currently, only forcible restart is supported.POST /v2.1/{project_id}/servers/{server_id}/actionTable 1 lists the parameters.Requ", + "product_code":"bms", + "title":"Restarting a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158716.html", + "doc_type":"api", + "p_code":"13", + "code":"16" + }, + { + "desc":"This API is used to stop a single BMS.The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active or error.Currently, only forcible stopping is supported.POST /v2.1", + "product_code":"bms", + "title":"Stopping a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158685.html", + "doc_type":"api", + "p_code":"13", + "code":"17" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"bms", + "title":"BMS Metadata Management", + "uri":"en-us_topic_0173933989.html", + "doc_type":"api", + "p_code":"2", + "code":"18" + }, + { + "desc":"The BMS metadata includes BMS basic information on the cloud platform, such as the BMS ID, hostname, and network information. This API is used to query the BMS metadata.P", + "product_code":"bms", + "title":"Querying BMS Metadata (Native OpenStack API)", + "uri":"en-us_topic_0060402469.html", + "doc_type":"api", + "p_code":"18", + "code":"19" + }, + { + "desc":"This API is used to update BMS metadata.If the metadata does not contain the target field, the field is automatically added to the field.If the metadata contains the targ", + "product_code":"bms", + "title":"Updating BMS Metadata (Native OpenStack API)", + "uri":"en-us_topic_0053158712.html", + "doc_type":"api", + "p_code":"18", + "code":"20" + }, + { + "desc":"This API is used to modify specified BMS metadata.The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, paused, or suspended.PUT /v2.1/{project_id}/", + "product_code":"bms", + "title":"Modifying Specified BMS Metadata (Native OpenStack API)", + "uri":"en-us_topic_0053158695.html", + "doc_type":"api", + "p_code":"18", + "code":"21" + }, + { + "desc":"This API is used to delete specified BMS metadata.The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, paused, or suspended.DELETE /v2.1/{project_i", + "product_code":"bms", + "title":"Deleting Specified BMS Metadata (Native OpenStack API)", + "uri":"en-us_topic_0053158683.html", + "doc_type":"api", + "p_code":"18", + "code":"22" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"bms", + "title":"BMS IP Address Query", + "uri":"en-us_topic_0053158688.html", + "doc_type":"api", + "p_code":"2", + "code":"23" + }, + { + "desc":"This API is used to query private IP addresses of a BMS.Pagination query is not supported.GET /v2.1/{project_id}/servers/{server_id}/ipsTable 1 lists the parameters.Reque", + "product_code":"bms", + "title":"Querying IP Addresses of a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158696.html", + "doc_type":"api", + "p_code":"23", + "code":"24" + }, + { + "desc":"This API is used to query the specified IP address of a BMS based on the network name.GET /v2.1/{project_id}/servers/{server_id}/ips/{vpc_id}Table 1 lists the parameters.", + "product_code":"bms", + "title":"Querying the Specified IP Address of a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158662.html", + "doc_type":"api", + "p_code":"23", + "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":"bms", + "title":"BMS Flavor Query", + "uri":"en-us_topic_0053158668.html", + "doc_type":"api", + "p_code":"2", + "code":"26" + }, + { + "desc":"This API is used to query BMS flavors.The flavors you obtained using this API are all the flavors in the system. The flavors whose names starting with physical are BMS fl", + "product_code":"bms", + "title":"Querying BMS Flavors (Native OpenStack API)", + "uri":"en-us_topic_0053158684.html", + "doc_type":"api", + "p_code":"26", + "code":"27" + }, + { + "desc":"This API is used to query details about a BMS flavor, such as the flavor name, CPU cores, and memory.GET /v2.1/{project_id}/flavors/{flavor_id}Table 1 lists the parameter", + "product_code":"bms", + "title":"Querying Details About a BMS Flavor (Native OpenStack API)", + "uri":"en-us_topic_0053158674.html", + "doc_type":"api", + "p_code":"26", + "code":"28" + }, + { + "desc":"extra_specs parameters specify the key-value pair of a BMS flavor. For example, baremetal:extBootType specifies the boot device of the BMS. Its value can be LocalDisk (lo", + "product_code":"bms", + "title":"Querying Details About extra_specs Parameters of a BMS Flavor (Native OpenStack API)", + "uri":"en-us_topic_0114885743.html", + "doc_type":"api", + "p_code":"26", + "code":"29" + }, + { + "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":"bms", + "title":"BMS NIC Management", + "uri":"en-us_topic_0053158711.html", + "doc_type":"api", + "p_code":"2", + "code":"30" + }, + { + "desc":"This API is used to query information about BMS NICs, such as the MAC addresses and private IP addresses.GET /v2.1/{project_id}/servers/{server_id}/os-interfaceTable 1 li", + "product_code":"bms", + "title":"Querying Information About BMS NICs (Native OpenStack API)", + "uri":"en-us_topic_0053158678.html", + "doc_type":"api", + "p_code":"30", + "code":"31" + }, + { + "desc":"This API is used to query information about a specified BMS NIC based on the NIC ID.GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id}Table 1 lists the paramete", + "product_code":"bms", + "title":"Querying Information About a Specified BMS NIC (Native OpenStack API)", + "uri":"en-us_topic_0053158687.html", + "doc_type":"api", + "p_code":"30", + "code":"32" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"bms", + "title":"BMS Disk Management", + "uri":"en-us_topic_0053158703.html", + "doc_type":"api", + "p_code":"2", + "code":"33" + }, + { + "desc":"This API is used to query information about the EVS disks attached to a BMS.GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachmentsTable 1 lists the parameters.R", + "product_code":"bms", + "title":"Querying Information About the Disks Attached to a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158658.html", + "doc_type":"api", + "p_code":"33", + "code":"34" + }, + { + "desc":"This API is used to query information about a single disk attached to a BMS based on the disk ID.GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_", + "product_code":"bms", + "title":"Querying Information About a Disk Attached to a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158665.html", + "doc_type":"api", + "p_code":"33", + "code":"35" + }, + { + "desc":"This API is used to attach an EVS disk to a BMS.A bootable disk cannot be attached to a BMS.A disk cannot be attached to a BMS when the BMS is in the SUSPENDED or PAUSED ", + "product_code":"bms", + "title":"Attaching an EVS Disk to a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158614.html", + "doc_type":"api", + "p_code":"33", + "code":"36" + }, + { + "desc":"This API is used to detach an EVS disk from a BMS.If a BMS is stopped, disks can be detached from it without any limitation on the OS. If a BMS is in running state, the c", + "product_code":"bms", + "title":"Detaching an EVS Disk from a BMS (Native OpenStack API)", + "uri":"en-us_topic_0053158611.html", + "doc_type":"api", + "p_code":"33", + "code":"37" + }, + { + "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":"bms", + "title":"BMS SSH Key Pair Management", + "uri":"en-us_topic_0060384657.html", + "doc_type":"api", + "p_code":"2", + "code":"38" + }, + { + "desc":"This interface is used to query SSH key pairs and to display the query results in a list.Pagination query is not supported.GET /v2.1/{project_id}/os-keypairsTable 1 lists", + "product_code":"bms", + "title":"Querying SSH Key Pairs (Native OpenStack API)", + "uri":"en-us_topic_0060384658.html", + "doc_type":"api", + "p_code":"38", + "code":"39" + }, + { + "desc":"This interface is used to query a specified SSH key pair based on the key pair name.GET /v2.1/{project_id}/os-keypairs/{keypair_name}Table 1 lists the parameters.Request ", + "product_code":"bms", + "title":"Querying an SSH Key Pair (Native OpenStack API)", + "uri":"en-us_topic_0060384659.html", + "doc_type":"api", + "p_code":"38", + "code":"40" + }, + { + "desc":"This interface is used to create an SSH key pair or import a public key to generate a key pair.After an SSH key is created, download the private key to a local directory.", + "product_code":"bms", + "title":"Creating and Importing an SSH Key Pair (Native OpenStack API)", + "uri":"en-us_topic_0060384660.html", + "doc_type":"api", + "p_code":"38", + "code":"41" + }, + { + "desc":"This interface is used to delete a specified SSH key pair based on the key pair name.DELETE /v2.1/{project_id}/os-keypairs/{keypair_name}Table 1 lists the parameters.Requ", + "product_code":"bms", + "title":"Deleting an SSH Key Pair (Native OpenStack API)", + "uri":"en-us_topic_0060384661.html", + "doc_type":"api", + "p_code":"38", + "code":"42" + }, + { + "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":"bms", + "title":"BMS 1D Tag Management", + "uri":"en-us_topic_0060410925.html", + "doc_type":"api", + "p_code":"2", + "code":"43" + }, + { + "desc":"This API is used to query all tags of a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.GET /v2.", + "product_code":"bms", + "title":"Querying BMS Tags (Native OpenStack API)", + "uri":"en-us_topic_0060410926.html", + "doc_type":"api", + "p_code":"43", + "code":"44" + }, + { + "desc":"This API is used to add tags to a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.A BMS can have", + "product_code":"bms", + "title":"Adding Tags to a BMS (Native OpenStack API)", + "uri":"en-us_topic_0060410927.html", + "doc_type":"api", + "p_code":"43", + "code":"45" + }, + { + "desc":"This API is used to delete all tags of a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.Tag __t", + "product_code":"bms", + "title":"Deleting Tags of a BMS (Native OpenStack API)", + "uri":"en-us_topic_0060410928.html", + "doc_type":"api", + "p_code":"43", + "code":"46" + }, + { + "desc":"This API is used to add a tag to a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.A BMS can hav", + "product_code":"bms", + "title":"Adding a Tag to a BMS (Native OpenStack API)", + "uri":"en-us_topic_0060410929.html", + "doc_type":"api", + "p_code":"43", + "code":"47" + }, + { + "desc":"This API is used to check whether a BMS has a specified tag.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the", + "product_code":"bms", + "title":"Checking for Tags of a BMS (Native OpenStack API)", + "uri":"en-us_topic_0060410930.html", + "doc_type":"api", + "p_code":"43", + "code":"48" + }, + { + "desc":"This API is used to delete a tag of a BMS.You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.The tag co", + "product_code":"bms", + "title":"Deleting a Tag of a BMS (Native OpenStack API)", + "uri":"en-us_topic_0060424486.html", + "doc_type":"api", + "p_code":"43", + "code":"49" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"bms", + "title":"Public Parameters", + "uri":"en-us_topic_0060323087.html", + "doc_type":"api", + "p_code":"", + "code":"50" + }, + { + "desc":"NormalReturned ValueDescription200 OKThe request has been successfully processed.201 CreatedThe request has been successfully processed and a resource has been created.20", + "product_code":"bms", + "title":"Status Codes", + "uri":"en-us_topic_0053158690.html", + "doc_type":"api", + "p_code":"50", + "code":"51" + }, + { + "desc":"An error code returned by an API does not correspond to one error message. The following table lists only common error messages.Most BMS APIs are asynchronous. Some error", + "product_code":"bms", + "title":"Error Codes", + "uri":"en-us_topic_0107541808.html", + "doc_type":"api", + "p_code":"50", + "code":"52" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"bms", + "title":"Change History", + "uri":"en-us_topic_0131054288.html", + "doc_type":"api", + "p_code":"", + "code":"53" + } +] \ No newline at end of file diff --git a/docs/bms/api-ref/PARAMETERS.txt b/docs/bms/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/bms/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/bms/api-ref/en-us_topic_0053158611.html b/docs/bms/api-ref/en-us_topic_0053158611.html new file mode 100644 index 000000000..28a5d98b4 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158611.html @@ -0,0 +1,82 @@ + + +

Detaching an EVS Disk from a BMS (Native OpenStack API)

+

Function

This API is used to detach an EVS disk from a BMS.

+
+

Constraints

If a BMS is stopped, disks can be detached from it without any limitation on the OS. If a BMS is in running state, the constraints are as follows:

+
  • Before detaching an EVS disk from a Linux BMS, log in to the BMS, run the unmount command to disassociate the disk to be detached from the file system, and ensure that no program is reading data from or writing data to the disk. Otherwise, the disk will fail to be detached.
  • Before detaching an EVS disk from a running Windows BMS, ensure that no program is reading data from or writing data to the disk. Otherwise, data will be lost.
+
+

URI

DELETE /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+

volume_id

+

Yes

+

Specifies the EVS disk ID.

+

You can query attached EVS disks attached to a BMS using the Querying Information About the Disks Attached to a BMS (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    DELETE https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments/b53f23bd-ee8f-49ec-9420-d1acfeaf91d6
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Disk Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158613.html b/docs/bms/api-ref/en-us_topic_0053158613.html new file mode 100644 index 000000000..89a6049f3 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158613.html @@ -0,0 +1,21 @@ + + +

BMS Status Management

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158614.html b/docs/bms/api-ref/en-us_topic_0053158614.html new file mode 100644 index 000000000..7be1befd5 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158614.html @@ -0,0 +1,218 @@ + + +

Attaching an EVS Disk to a BMS (Native OpenStack API)

+

Function

This API is used to attach an EVS disk to a BMS.

+
+

Constraints

  • A bootable disk cannot be attached to a BMS.
  • A disk cannot be attached to a BMS when the BMS is in the SUSPENDED or PAUSED state, which is specified using the OS-EXT-STS:vm_state parameter.
  • Only a shared disk or a disk in the available state can be attached to a BMS.
  • Only EVS disks whose device type is SCSI can be attached to a BMS.
+
+

URI

POST /v2.1/{project_id}/servers/{server_id}/os-volume_attachments

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    volumeAttachment

    +

    Yes

    +

    Object

    +

    Specifies the disks to be attached. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 2 volumeAttachment field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    volumeId

    +

    Yes

    +

    String

    +

    Specifies the ID of the disk to be attached to a BMS.

    +

    device

    +

    No

    +

    String

    +

    Specifies the mount point, such as /dev/sda and /dev/sdb.

    +

    The new disk mount point cannot be the same as an existing one.

    +

    The mount point must be specified based on the sequence of existing device names. Otherwise, the system automatically generates a mount point.

    +
    +
    +
  • Example request
    1
    POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments
+
    +
    +
    1
+2
+3
+4
+5
+6
    {
+    "volumeAttachment": {
+        "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6",
+        "device": "/dev/sdb"
+    }
+}
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    volumeAttachment

    +

    Object

    +

    Specifies the disks attached to a BMS. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 volumeAttachment field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    device

    +

    String

    +

    Specifies the device name, for example, /dev/vdb.

    +

    serverId

    +

    String

    +

    Specifies the ID of the BMS to which the disk is to be attached. The ID is in UUID format.

    +

    id

    +

    String

    +

    Specifies the disk UUID.

    +

    volumeId

    +

    String

    +

    Specifies the attaching ID, which is the same as the UUID.

    +
    +
    +
  • Example response
    1
+2
+3
+4
+5
+6
+7
+8
    {
+    "volumeAttachment": {
+        "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6",
+        "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6",
+        "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa",
+        "device": "/dev/vdb"
+    }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Disk Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158658.html b/docs/bms/api-ref/en-us_topic_0053158658.html new file mode 100644 index 000000000..5ae8f8de8 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158658.html @@ -0,0 +1,148 @@ + + +

Querying Information About the Disks Attached to a BMS (Native OpenStack API)

+

Function

This API is used to query information about the EVS disks attached to a BMS.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    volumeAttachments

    +

    Object

    +

    Specifies information about the disks attached to the BMS. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 volumeAttachments field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    device

    +

    String

    +

    Specifies the mount directory, for example, /dev/vdb.

    +

    id

    +

    String

    +

    Specifies the ID of the attached resource.

    +

    serverId

    +

    String

    +

    Specifies the ID of the BMS to which the disks are attached.

    +

    volumeId

    +

    String

    +

    Specifies the IDs of the EVS disks attached to the BMS.

    +
    +
    +
+
  • Example response
    1
+2
+3
+4
+5
+6
+7
+8
    {
+    "volumeAttachment": {
+        "device": "/dev/vdb",
+        "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa",
+        "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6",
+        "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6"
+    }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Disk Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158659.html b/docs/bms/api-ref/en-us_topic_0053158659.html new file mode 100644 index 000000000..1e7303156 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158659.html @@ -0,0 +1,100 @@ + + +

Starting a BMS (Native OpenStack API)

+

Function

This API is used to start a single BMS.

+
+

URI

POST /v2.1/{project_id}/servers/{server_id}/action

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    os-start

    +

    Yes

    +

    null

    +

    Specifies the operation of starting the BMS. The data structure is empty.

    +
    +
    +
  • Example request
    1
    POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action
+
    +
    +
    1
+2
+3
    {
+    "os-start": {}
+                    }
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Status Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158662.html b/docs/bms/api-ref/en-us_topic_0053158662.html new file mode 100644 index 000000000..4b91afd02 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158662.html @@ -0,0 +1,142 @@ + + +

Querying the Specified IP Address of a BMS (Native OpenStack API)

+

Function

This API is used to query the specified IP address of a BMS based on the network name.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}/ips/{vpc_id}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+

vpc_id

+

Yes

+

Specifies the ID of the VPC where the BMS is located.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/ips/{vpc_id}
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    VPC where the BMS is located

    +

    Array of objects

    +

    Specifies the ID of the VPC where the BMS is located. For details about the format, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 2 Network parameter structure description

    Parameter

    +

    Type

    +

    Description

    +

    version

    +

    Integer

    +

    Specifies the IP address version. The value can be:

    +
    • 4: IPv4 address
    • 6: IPv6 address
    +

    addr

    +

    String

    +

    Specifies the IP address.

    +
    +
    +
+
  • Example response
    1
+2
+3
+4
+5
+6
+7
+8
    {
+    "5849fdf1-9d79-4589-80c2-fe557990c417": [
+        {
+            "version": 4,
+            "addr": "192.168.1.159"
+        }
+    ]
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS IP Address Query
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158665.html b/docs/bms/api-ref/en-us_topic_0053158665.html new file mode 100644 index 000000000..b0db116c0 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158665.html @@ -0,0 +1,156 @@ + + +

Querying Information About a Disk Attached to a BMS (Native OpenStack API)

+

Function

This API is used to query information about a single disk attached to a BMS based on the disk ID.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+

volume_id

+

Yes

+

Specifies the EVS disk ID.

+

You can query attached EVS disks attached to a BMS using the Querying Information About the Disks Attached to a BMS (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments/b53f23bd-ee8f-49ec-9420-d1acfeaf91d6
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    volumeAttachment

    +

    Object

    +

    Specifies information about the disk attached to the BMS. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 volumeAttachment field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    device

    +

    String

    +

    Specifies the mount directory, for example, /dev/vdb.

    +

    id

    +

    String

    +

    Specifies the ID of the attached resource.

    +

    serverId

    +

    String

    +

    Specifies the ID of the BMS to which the disks are attached.

    +

    volumeId

    +

    String

    +

    Specifies the ID of the disk attached to the BMS.

    +
    +
    +
+
  • Example response
    1
+2
+3
+4
+5
+6
+7
+8
    {
+    "volumeAttachment": {
+        "device": "/dev/vdb",
+        "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa",
+        "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6",
+        "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6"
+    }
+                }
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Disk Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158668.html b/docs/bms/api-ref/en-us_topic_0053158668.html new file mode 100644 index 000000000..88b9eca09 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158668.html @@ -0,0 +1,19 @@ + + +

BMS Flavor Query

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158674.html b/docs/bms/api-ref/en-us_topic_0053158674.html new file mode 100644 index 000000000..e0328805d --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158674.html @@ -0,0 +1,256 @@ + + +

Querying Details About a BMS Flavor (Native OpenStack API)

+

Function

This API is used to query details about a BMS flavor, such as the flavor name, CPU cores, and memory.

+
+

URI

GET /v2.1/{project_id}/flavors/{flavor_id}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

flavor_id

+

Yes

+

Specifies the flavor ID.

+

You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    flavor

    +

    Object

    +

    Specifies the BMS flavor. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 flavor field description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the BMS flavor ID.

    +

    name

    +

    String

    +

    Specifies the BMS flavor name.

    +

    vcpus

    +

    Integer

    +

    Specifies the number of CPU cores in the BMS flavor.

    +

    ram

    +

    Integer

    +

    Specifies the memory size (MB) in the BMS flavor.

    +

    disk

    +

    Integer

    +

    Specifies the disk size (GB) in the BMS flavor.

    +

    swap

    +

    String

    +

    This is a reserved attribute.

    +

    OS-FLV-EXT-DATA:ephemeral

    +

    Integer

    +

    This is a reserved attribute.

    +

    OS-FLV-DISABLED:disabled

    +

    Boolean

    +

    This is a reserved attribute.

    +

    rxtx_factor

    +

    Float

    +

    This is a reserved attribute.

    +

    os-flavor-access:is_public

    +

    Boolean

    +

    This is a reserved attribute.

    +

    links

    +

    Array of objects

    +

    Specifies shortcut links of the BMS flavor. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 links field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    rel

    +

    String

    +

    Specifies the shortcut link marker name.

    +
    • self: resource link that contains the version number. It is used when immediate tracing is required.
    • bookmark: resource link that can be stored for a long time.
    +

    href

    +

    String

    +

    Specifies the corresponding shortcut link.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
    {
+    "flavor": {
+        "name": "physical.o2.medium",
+        "links": [
+            {
+                "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium",
+                "rel": "self"
+            },
+            {
+                "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium",
+                "rel": "bookmark"
+            }
+        ],
+        "ram": 192705,
+        "OS-FLV-DISABLED:disabled": false,
+        "vcpus": 24,
+        "swap": "",
+        "os-flavor-access:is_public": true,
+        "rxtx_factor": 1,
+        "OS-FLV-EXT-DATA:ephemeral": 0,
+        "disk": 1862,
+        "id": "physical.o2.medium"
+    }
+                }
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Flavor Query
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158678.html b/docs/bms/api-ref/en-us_topic_0053158678.html new file mode 100644 index 000000000..b0aae33eb --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158678.html @@ -0,0 +1,197 @@ + + +

Querying Information About BMS NICs (Native OpenStack API)

+

Function

This API is used to query information about BMS NICs, such as the MAC addresses and private IP addresses.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}/os-interface

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    interfaceAttachments

    +

    Array of objects

    +

    Specifies information about NICs of the BMS. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 interfaceAttachments field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    port_state

    +

    String

    +

    Specifies the status of the NIC port. The value can be ACTIVE, BUILD, or DOWN.

    +

    fixed_ips

    +

    Array of objects

    +

    Specifies the NIC private IP address. For details, see Table 3.

    +

    net_id

    +

    String

    +

    Specifies the ID of the subnet (network_id) to which the NIC ports belong.

    +

    port_id

    +

    String

    +

    Specifies the ID of the NIC port.

    +

    mac_addr

    +

    String

    +

    Specifies the MAC address of the NIC.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 fixed_ips field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    subnet_id

    +

    String

    +

    Specifies the ID of the subnet (subnet_id) corresponding to the private IP address of the NIC.

    +

    ip_address

    +

    String

    +

    Specifies the NIC private IP address.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
    {
+    "interfaceAttachments": [
+        {
+            "port_state": "ACTIVE",
+            "fixed_ips": [
+                {
+                    "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef",
+                    "ip_address": "192.168.1.3"
+                }
+            ],
+            "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6",
+            "port_id": "ce531f90-199f-48c0-816c-13e38010b442",
+            "mac_addr": "fa:16:3e:4c:2c:30"
+        }
+    ]
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS NIC Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158679.html b/docs/bms/api-ref/en-us_topic_0053158679.html new file mode 100644 index 000000000..16faf342d --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158679.html @@ -0,0 +1,406 @@ + + +

Querying Details About BMSs (Native OpenStack API)

+

Function

This API is used to query details about BMSs.

+
+

Constraints

  • The query result returned by this interface includes both ECS and BMS details. You need to filter out the BMS details using the flavor used to create the BMSs or the tags added to the BMSs during BMS creation.
  • If the image is used as the search criteria, other search criteria and pagination criteria are not supported. If both the image and other search criteria are used, the BMS details are filtered out by image. If the image is not used as the search criteria, this interface has no restrictions.
+
+

URI

GET /v2.1/{project_id}/servers/detail{?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&tags={tags}&not-tags={not-tags}&reservation_id={reservation_id}&sort_key={sort_key}&sort_dir={sort_dir}}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    changes-since

    +

    No

    +

    String

    +

    Specifies the timestamp of the last BMS status update. The parameter is in ISO 8601 time format, for example, 2013-06-09T06:42:18Z.

    +

    image

    +

    No

    +

    String

    +

    Specifies the image ID.

    +
    NOTE:

    If the image is used as the search criteria, other search criteria and pagination criteria are not supported. If both the image and other search criteria are used, the BMS details are filtered out by image. If the image is not used as the search criteria, this interface has no restrictions.

    +
    +

    flavor

    +

    No

    +

    String

    +

    Specifies the flavor ID.

    +

    You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.

    +

    name

    +

    No

    +

    String

    +

    Specifies the BMS name. This parameter supports fuzzy matching.

    +

    For example, the regular expression ?name=bob will return both bob and bobb. To obtain only bob, you can use a regular expression matching the basic database syntax, such as MySQL or PostgreSQL (official website: https://www.postgresql.org/docs/9.2/static/functions-matching.html).

    +

    status

    +

    No

    +

    String

    +

    Specifies the BMS status.

    +

    Value range:

    +
    • ACTIVE: Running, Stopping, Deleting
    • BUILD: Creating
    • ERROR: Faulty
    • HARD_REBOOT: Forcibly Restarting
    • REBOOT: Restarting
    • DELETED: Deleted
    +

    limit

    +

    No

    +

    Integer

    +

    Specifies the number of BMSs displayed on each page.

    +

    marker

    +

    No

    +

    String

    +

    Specifies the BMS ID to which the marker corresponds. The query will start from the next ID.

    +

    tags

    +

    No

    +

    String

    +

    Queries the BMSs with specified tags.

    +

    Added in micro version 2.26.

    +

    not-tags

    +

    No

    +

    String

    +

    Queries the BMSs with tags not containing the specified value. The value is a list of tag keys.

    +
    NOTE:

    If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

    +

    For example, an existing tag is a.b. After the tag function upgrade, query the tag using "not-tags=a".

    +
    +

    Added in micro version 2.26.

    +

    reservation_id

    +

    No

    +

    String

    +

    Specifies the reserved ID, which can be used to query BMSs created in a batch.

    +

    Added in micro version 2.26.

    +

    sort_key

    +

    No

    +

    String

    +

    Specifies the BMS sorting attribute, which can be the BMS UUID (uuid), BMS status (vm_state), BMS name (display_name), BMS task status (task_state), power status (power_state), creation time (created_at), last time when the BMS is updated (updated_at), and AZ (availability_zone). You can specify multiple sort_key and sort_dir pairs.

    +

    The default sorting is the reverse order by created_at.

    +

    sort_dir

    +

    No

    +

    String

    +

    Specifies the sorting direction.

    +
    • asc: The query results are displayed in ascending order.
    • desc (default value): The query results are displayed in descending order.
    +
    +
    +
  • Example request
    • With no optional parameter
      1
      https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail
+
      +
      +
    • With an optional parameter
      1
      https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal
+
      +
      +
    • With multiple optional parameters
      1
      https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal&name=bms-test01
+
      +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    servers

    +

    Array of objects

    +

    Specifies details about the BMS. For details, see Table 2.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
    {
+    "servers": [
+{
+            "tenant_id": "c685484a8cc2416b97260938705deb64",
+            "addresses": {
+                "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
+{
+                        "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77",
+                        "OS-EXT-IPS:type": "fixed",
+                        "addr": "192.168.0.107",
+                        "version": 4
+                    }
+                ]
+            },
+            "metadata": {
+                "op_svc_userid": "1311c433dd9b408886f57d695c229cbe"
+            },
+            "OS-EXT-STS:task_state": null,
+            "OS-DCF:diskConfig": "MANUAL",
+            "OS-EXT-AZ:availability_zone": "az-dc-1",
+            "links": [
+{
+                    "rel": "self",
+                    "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
+                },
+{
+                    "rel": "bookmark",
+                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
+                    }
+            ],
+            "OS-EXT-STS:power_state": 1,
+            "id": "95bf2490-5428-432c-ad9b-5e3406f869dd",
+            "os-extended-volumes:volumes_attached": [
+{
+                    "id": "dfa375b5-9856-44ad-a937-a4802b6434c3"
+                },
+{
+                    "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417"
+                },
+{
+                    "id": "86e801c3-acc6-465d-890c-d43ba493f553"
+                },
+{
+                    "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6"
+                    }
+            ],
+            "OS-EXT-SRV-ATTR:host": "bms.az1",
+            "image": {
+                "links": [
+{
+                        "rel": "bookmark",
+                        "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319"
+                    }
+                ],
+                "id": "1a6635d8-afea-4f2b-abb6-27a202bad319"
+            },
+            "OS-SRV-USG:terminated_at": null,
+            "accessIPv4": "",
+            "accessIPv6": "",
+            "created": "2017-05-24T06:14:05Z",
+            "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e",
+            "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2",
+            "key_name": "KeyPair-JX",
+            "flavor": {
+                "links": [
+{
+                        "rel": "bookmark",
+                        "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium"
+                    }
+                ],
+                "id": "physical.83.medium"
+            },
+            "security_groups": [
+{
+                    "name": "0011b620-4982-42e4-ad12-47c95ca495c4"
+                    }
+            ],
+            "config_drive": "",
+            "OS-EXT-STS:vm_state": "active",
+            "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3",
+            "user_id": "1311c433dd9b408886f57d695c229cbe",
+            "name": "bms",
+            "progress": 0, 
+            "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078",
+            "updated": "2017-05-25T03:40:25Z",
+            "status": "ACTIVE"
+                    }
+    ]
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Lifecycle Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158680.html b/docs/bms/api-ref/en-us_topic_0053158680.html new file mode 100644 index 000000000..db46ee233 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158680.html @@ -0,0 +1,23 @@ + + +

BMS Lifecycle Management

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158682.html b/docs/bms/api-ref/en-us_topic_0053158682.html new file mode 100644 index 000000000..1d1b14f98 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158682.html @@ -0,0 +1,475 @@ + + +

Creating a BMS (Native OpenStack API)

+

Function

This interface is used to create a BMS.

+
+

Constraints

  • This interface cannot be used to create BMSs in batches.
  • When you create a BMS using an image that supports Cloud-Init or Cloudbase-Init, only parameter key_name can be configured. (Parameter adminPass is invalid.) The password of a Linux BMS can be injected only using parameter user_data. The password of a Windows BMS can be injected only using metadata admin_pass.
  • When you create a BMS using an image that does not support Cloud-Init or Cloudbase-Init, both parameters adminPass and key_name are invalid. You need to use the password or certificate of the image to log in to the BMS.
  • File injection is not supported.
  • BMS creation from a system volume is not supported.
  • Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
  • After a BMS is created, it is recommended that you attach the __type_baremetal tag to the BMS. This tag specifies that the created server is a BMS. Otherwise, the BMS may not be displayed in the BMS list on the management console.
  • A BMS can have a maximum of two VPCs, in which case the first VPC will be used by the primary NIC.
+
+

URI

POST /v2.1/{project_id}/servers

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    server

    +

    Yes

    +

    Object

    +

    Specifies the BMS information, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 server field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    imageRef

    +

    Yes

    +

    String

    +

    Specifies the ID of the image used by the BMS or the image resource uniform resource locator (URL).

    +
    • Example image ID: 3b8d6fef-af77-42ab-b8b7-5a7f0f0af8f2
    • Example image URL: http://glance.openstack.example.com/images/3b8d6fef-af77-42ab-b8b7-5a7f0f0af8f2
    +
    NOTE:
    • BMSs using certain flavors do not support all public images provided by the cloud service platform. To obtain the images supported by a BMS flavor, log in to the management console, view the images displayed on the Create ECS page, and obtain the image IDs on the Image Management Service page.
    • If the creation fails, modify the parameter settings.
    +
    +

    flavorRef

    +

    Yes

    +

    String

    +

    Specifies the ID or URL of the flavor used by the BMS.

    +

    name

    +

    Yes

    +

    String

    +

    Specifies the BMS name. It contains a maximum of 255 characters and cannot be left blank.

    +

    metadata

    +

    No

    +

    Object

    +

    Specifies the BMS metadata. The maximum size for both the metadata key and value is 255 characters. For details, see Table 3.

    +

    user_data

    +

    No

    +

    String

    +

    Specifies the user data to be injected during the BMS creation.

    +

    Text, text files, and .gzip files can be injected. The content to be injected cannot be greater than 32 KB in size. The content to be injected must be encoded with base64.

    +

    adminPass

    +

    No

    +

    String

    +

    Specifies the initial login password of the BMS administrator account. This parameter is invalid for a Linux BMS. The administrator account of a Windows BMS is Administrator.

    +

    Password complexity requirements:

    +
    • The password contains 8 to 26 characters.
    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?).
    • The password cannot contain the username or the username in reverse.
    • The Windows BMS password cannot contain the username, the username in reverse order, or more than two consecutive characters in the username.
    +

    Note: If this parameter is not specified, a random password will be generated.

    +

    Special characters: !@$%^-_=+[{}]:,./?

    +

    security_groups

    +

    No

    +

    Array of objects

    +

    Specifies the security group of a BMS. The default value is default. This parameter is valid when you specify parameter network. You are not allowed to specify multiple security groups. For details, see Table 4.

    +

    networks

    +

    Yes

    +

    Array of objects

    +

    Specifies the BMS NICs. For details, see Table 5.

    +

    You can specify a maximum of four networks for a BMS, including two VXLAN networks and two GENEVE networks. The first network in the parameter must be a VXLAN network. The network is used as by the primary NIC of the BMS. If multiple groups of network parameters are specified, ensure that the parameters of each group belong to the same VPC.

    +

    key_name

    +

    No

    +

    String

    +

    Specifies the name of a key pair. This is an extended attribute.

    +

    availability_zone

    +

    Yes

    +

    String

    +

    Specifies information about the AZ to which the BMS belongs. You are not allowed to specify host information.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 3 metadata field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    User-defined field key and value pair

    +

    No

    +

    String

    +

    Specifies the key and value pair of the metadata.

    +

    Each key or value contains a maximum of 255 characters.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 4 security_groups field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

    Specifies the name of the security group to which the BMS belongs.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 5 networks field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    port

    +

    No

    +

    String

    +

    Specifies the UUID of the network port.

    +

    uuid

    +

    No

    +

    String

    +

    Specifies the network UUID.

    +

    fixed_ip

    +

    No

    +

    String

    +

    Specifies the fixed IP address.

    +
    +
    +
+
  • Example request
    1
    POST https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers
+
    +
    +
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
    {
+    "server": {
+        "imageRef": "1a6635d8-afea-4f2b-abb6-27a202bad319",
+        "flavorRef": "physical.o2.medium",
+        "name": "bms_name01",
+        "availability_zone": "az-dc-1",
+        "networks": [
+            {
+                "uuid": "8470310b-bfa2-4edf-8f64-d15196b2b2c9"
+            }
+        ]
+    }
+}
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    server

    +

    Object

    +

    Specifies the BMS information. For details, see Table 6.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6 server field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    security_groups

    +

    Array of objects

    +

    Specifies information about the BMS security group. For details, see Table 7.

    +

    OS-DCF:diskConfig

    +

    String

    +

    Specifies the disk configuration. The value can be:

    +
    • MANUAL: The API uses the partitioning scheme in the image and the file system to create a BMS. If the target flavor has a large disk, the API does not partition the remaining disk space.
    • AUTO: The API uses a single partition with the same size as the disk of the target flavor to create a BMS. The API automatically adjusts the file system to adapt to the entire partition.
    +

    id

    +

    String

    +

    Specifies the BMS ID.

    +

    links

    +

    Array of objects

    +

    Specifies the shortcut links of the BMS. For details, see Table 8.

    +

    adminPass

    +

    String

    +

    Specifies the initial login password of the BMS administrator account.

    +
    +
    + +
    + + + + + + + + + +
    Table 7 security_groups field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    Specifies the name of the security group to which the BMS belongs.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 8 links field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    rel

    +

    String

    +

    Specifies the shortcut link marker name. The value can be:

    +
    • self: resource link that contains the version number. It is used when immediate tracing is required.
    • bookmark: resource link that can be stored for a long time.
    +

    href

    +

    String

    +

    Specifies the corresponding shortcut link.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
    {
+    "server": {
+        "security_groups": [
+            {
+                "name": "default"
+            }
+        ],
+        "OS-DCF:diskConfig": "MANUAL",
+        "links": [
+            {
+                "rel": "self",
+                "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/servers/9ab74d89-61e7-4259-8546-465fdebe4944"
+            },
+            {
+                "rel": "bookmark",
+                "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/9ab74d89-61e7-4259-8546-465fdebe4944"
+            }
+        ],
+        "id": "9ab74d89-61e7-4259-8546-465fdebe4944",
+        "adminPass": "RjdD3h8U2DBe"
+    }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Lifecycle Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158683.html b/docs/bms/api-ref/en-us_topic_0053158683.html new file mode 100644 index 000000000..f7f527070 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158683.html @@ -0,0 +1,80 @@ + + +

Deleting Specified BMS Metadata (Native OpenStack API)

+

Function

This API is used to delete specified BMS metadata.

+
+

Constraints

The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, paused, or suspended.

+
+

URI

DELETE /v2.1/{project_id}/servers/{server_id}/metadata/{key}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+

key

+

Yes

+

Specifies the BMS metadata key value to be deleted.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    DELETE https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key}
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Metadata Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158684.html b/docs/bms/api-ref/en-us_topic_0053158684.html new file mode 100644 index 000000000..6618dfe9d --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158684.html @@ -0,0 +1,286 @@ + + +

Querying BMS Flavors (Native OpenStack API)

+

Function

This API is used to query BMS flavors.

+
+

Constraints

The flavors you obtained using this API are all the flavors in the system. The flavors whose names starting with physical are BMS flavors and can be used to create BMSs.

+
+

URI

GET /v2.1/{project_id}/flavors/detail{?minDisk={minDisk}&minRam={minRam}&sort_key={sort_key}&sort_dir={sort_dir}}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+
+
+

Table 2 lists the optional parameters that can be used to query BMS flavors.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Optional parameters

Parameter

+

Mandatory

+

Type

+

Description

+

minDisk

+

No

+

String

+

Specifies the minimum disk size in GB. Only the BMSs with a disk size greater than or equal to the minimum size can be queried.

+

minRam

+

No

+

String

+

Specifies the minimum memory size in MB. Only the BMSs with the memory size greater than or equal to the minimum size can be queried.

+

sort_key

+

No

+

String

+

Specifies the sorting field. The default value is flavorid. The value of this parameter can also be name, memory_mb, vcpus, root_gb, or flavorid.

+

sort_dir

+

No

+

String

+

Specifies the sorting of BMS flavors.

+

The value can be asc or desc, and is asc by default.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    • With no optional parameter
      1
      GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail
+
      +
      +
    • With an optional parameter
      1
      GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail?minDisk=3725
+
      +
      +
    • With multiple optional parameters
      1
      GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail?minDisk=3725&is_public=true
+
      +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    flavors

    +

    Array of objects

    +

    Specifies BMS flavors. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 flavors field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the BMS flavor ID.

    +

    name

    +

    String

    +

    Specifies the BMS flavor name.

    +

    vcpus

    +

    Integer

    +

    Specifies the number of CPU cores in the BMS flavor.

    +

    ram

    +

    Integer

    +

    Specifies the memory size (MB) in the BMS flavor.

    +

    disk

    +

    Integer

    +

    Specifies the disk size (GB) in the BMS flavor.

    +

    swap

    +

    String

    +

    This is a reserved attribute.

    +

    OS-FLV-EXT-DATA:ephemeral

    +

    Integer

    +

    This is a reserved attribute.

    +

    OS-FLV-DISABLED:disabled

    +

    Boolean

    +

    This is a reserved attribute.

    +

    rxtx_factor

    +

    Float

    +

    This is a reserved attribute.

    +

    os-flavor-access:is_public

    +

    Boolean

    +

    This is a reserved attribute.

    +

    links

    +

    Array of objects

    +

    Specifies shortcut links of the BMS flavor. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 4 links field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    rel

    +

    String

    +

    Specifies the shortcut link marker name.

    +
    • self: resource link that contains the version number. It is used when immediate tracing is required.
    • bookmark: resource link that can be stored for a long time.
    +

    href

    +

    String

    +

    Specifies the corresponding shortcut link.

    +
    +
    +
+
  • Example response
    {
+    "flavors": [
+        {
+            "name": "physical.o2.medium",
+            "links": [
+                {
+                    "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium",
+                    "rel": "self"
+                },
+                {
+                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium",
+                    "rel": "bookmark"
+                 }
+            ],
+            "ram": 321725,
+            "OS-FLV-DISABLED:disabled": false,
+            "vcpus": 56,
+            "swap": "",
+            "os-flavor-access:is_public": true,
+            "rxtx_factor": 1,
+            "OS-FLV-EXT-DATA:ephemeral": 0,
+            "disk": 3725,
+            "id": "physical.o2.medium"
+        }
+    ]
+                }
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Flavor Query
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158685.html b/docs/bms/api-ref/en-us_topic_0053158685.html new file mode 100644 index 000000000..e45de3ed1 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158685.html @@ -0,0 +1,129 @@ + + +

Stopping a BMS (Native OpenStack API)

+

Function

This API is used to stop a single BMS.

+
+

Constraints

  • The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active or error.
  • Currently, only forcible stopping is supported.
+
+

URI

POST /v2.1/{project_id}/servers/{server_id}/action

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    os-stop

    +

    Yes

    +

    Object

    +

    Specifies the operation of stopping the BMS. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 2 os-stop field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    type

    +

    No

    +

    String

    +

    Specifies the type of the BMS stopping operation.

    +
    • SOFT: normal BMS stopping
    • HARD: Forcible BMS stopping
      NOTE:

      Currently, this parameter is invalid. All BMS stopping operations are forcible stopping.

      +
      +
    +
    +
    +
+
  • Example request
    1
    POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action
+
    +
    +
    1
+2
+3
    {
+    "os-stop": {}
+}
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Status Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158687.html b/docs/bms/api-ref/en-us_topic_0053158687.html new file mode 100644 index 000000000..0b834f0c4 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158687.html @@ -0,0 +1,201 @@ + + +

Querying Information About a Specified BMS NIC (Native OpenStack API)

+

Function

This API is used to query information about a specified BMS NIC based on the NIC ID.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+

id

+

Yes

+

Specifies the ID of the NIC.

+

You can obtain the NIC ID from the NICs tab page on the BMS details page or by calling the Querying Information About BMS NICs (Native OpenStack API) API. (The NIC ID is the value of port_id).

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface/ce531f90-199f-48c0-816c-13e38010b442
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    interfaceAttachment

    +

    Object

    +

    Specifies information about the specified BMS NIC. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 interfaceAttachment field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    port_state

    +

    String

    +

    Specifies the status of the NIC port. The value can be ACTIVE, BUILD, or DOWN.

    +

    fixed_ips

    +

    Array of objects

    +

    Specifies the IP addresses of NICs. For details, see Table 3.

    +

    net_id

    +

    String

    +

    Specifies the ID of the subnet (network_id) to which the NIC ports belong.

    +

    port_id

    +

    String

    +

    Specifies the ID of the NIC port.

    +

    mac_addr

    +

    String

    +

    Specifies the MAC address of the NIC.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 fixed_ips field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    subnet_id

    +

    String

    +

    Specifies the ID of the subnet (subnet_id) corresponding to the private IP address of the NIC.

    +

    ip_address

    +

    String

    +

    Specifies the NIC IP address.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
    {
+    "interfaceAttachment": {
+        "port_state": "ACTIVE",
+        "fixed_ips": [
+{
+                "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef",
+                "ip_address": "192.168.1.3"
+                    }
+            ], 
+        "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6",
+        "port_id": "ce531f90-199f-48c0-816c-13e38010b442",
+        "mac_addr": "fa:16:3e:4c:2c:30"
+                    }
+                    }
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS NIC Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158688.html b/docs/bms/api-ref/en-us_topic_0053158688.html new file mode 100644 index 000000000..7a0fb6bf8 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158688.html @@ -0,0 +1,17 @@ + + +

BMS IP Address Query

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158690.html b/docs/bms/api-ref/en-us_topic_0053158690.html new file mode 100644 index 000000000..4ce9a4db0 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158690.html @@ -0,0 +1,121 @@ + + +

Status Codes

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

    Returned Value

    +

    Description

    +

    200 OK

    +

    The request has been successfully processed.

    +

    201 Created

    +

    The request has been successfully processed and a resource has been created.

    +

    202 Accepted

    +

    The request has been accepted but may not be processed immediately.

    +

    204 No Content

    +

    The request has been successfully processed, but there is no need to send any data back.

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

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The request failed to be processed due to bad syntax.

    +

    401 Unauthorized

    +

    A username and a password are required to access a page.

    +

    403 Forbidden

    +

    The requested page cannot be accessed.

    +

    404 Not Found

    +

    The requested page cannot be found.

    +

    405 Method Not Allowed

    +

    A method in the request is not allowed.

    +

    406 Not Acceptable

    +

    The response cannot be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    The client must be authorised by the proxy before the request can proceed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    Failed to complete the request due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request due to a system error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support all that is needed for the request to be completed.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the server has received an invalid response from an upstream server.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the server is unavailable.

    +

    504 Gateway Timeout

    +

    The server has waited too long for a response from an upstream server.

    +
    +
    +
+
+
+
+
Parent topic: Public Parameters
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158693.html b/docs/bms/api-ref/en-us_topic_0053158693.html new file mode 100644 index 000000000..ffdfe2b87 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158693.html @@ -0,0 +1,324 @@ + + +

Querying BMSs (Native OpenStack API)

+

Function

This API is used to query BMSs.

+
+

Constraints

  • The query result returned by this interface includes both ECSs and BMSs. You need to filter out the BMSs using the flavor used to create the BMSs or the tags added to the BMSs during BMS creation.
  • If the image is used as the search criteria, other search criteria and pagination criteria are not supported. If both the image and other search criteria are used, the BMSs are filtered out by image. If the image is not used as the search criteria, this interface has no restrictions.
+
+

URI

GET /v2.1/{project_id}/servers{?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&tags={tags}&not-tags={not-tags}&reservation_id={reservation_id}&sort_key={sort_key}&sort_dir={sort_dir}}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    changes-since

    +

    No

    +

    String

    +

    Specifies the timestamp of the last BMS status update. The parameter is in ISO 8601 time format, for example, 2013-06-09T06:42:18Z.

    +

    image

    +

    No

    +

    String

    +

    Specifies the image ID.

    +
    NOTE:

    If the image is used as the search criteria, other search criteria and pagination criteria are not supported. If both the image and other search criteria are used, the BMS details are filtered out by image. If the image is not used as the search criteria, this interface has no restrictions.

    +
    +

    flavor

    +

    No

    +

    String

    +

    Specifies the flavor ID.

    +

    You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.

    +

    name

    +

    No

    +

    String

    +

    Specifies the BMS name. This parameter supports fuzzy matching.

    +

    For example, the regular expression ?name=bob will return both bob and bobb. To obtain only bob, you can use a regular expression matching the basic database syntax, such as MySQL or PostgreSQL (official website: https://www.postgresql.org/docs/9.2/static/functions-matching.html).

    +

    status

    +

    No

    +

    String

    +

    Specifies the BMS status.

    +

    Value range:

    +
    • ACTIVE: Running, Stopping, Deleting
    • BUILD: Creating
    • ERROR: Faulty
    • HARD_REBOOT: Forcibly Restarting
    • REBOOT: Restarting
    • DELETED: Deleted
    +

    limit

    +

    No

    +

    Integer

    +

    Specifies the number of BMSs displayed on each page.

    +

    marker

    +

    No

    +

    String

    +

    Specifies the BMS ID to which the marker corresponds. The query will start from the next ID.

    +

    tags

    +

    No

    +

    String

    +

    Queries the BMSs with specified tags.

    +

    Added in micro version 2.26.

    +

    not-tags

    +

    No

    +

    String

    +

    Queries the BMSs with tags not containing the specified value. The value is a list of tag keys.

    +
    NOTE:

    If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

    +

    For example, an existing tag is a.b. After the tag function upgrade, query the tag using "not-tags=a".

    +
    +

    Added in micro version 2.26.

    +

    reservation_id

    +

    No

    +

    String

    +

    Specifies the reserved ID, which can be used to query BMSs created in a batch.

    +

    Added in micro version 2.26.

    +

    sort_key

    +

    No

    +

    String

    +

    Specifies the BMS sorting attribute, which can be the BMS UUID (uuid), BMS status (vm_state), BMS name (display_name), BMS task status (task_state), power status (power_state), creation time (created_at), last time when the BMS is updated (updated_at), and AZ (availability_zone). You can specify multiple sort_key and sort_dir pairs.

    +

    The default sorting is the reverse order by created_at.

    +

    sort_dir

    +

    No

    +

    String

    +

    Specifies the sorting direction.

    +
    • asc: The query results are displayed in ascending order.
    • desc (default value): The query results are displayed in descending order.
    +
    +
    +
  • Example request
    • With no optional parameter
      1
      GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers
+
      +
      +
    • With an optional parameter
      1
      GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal
+
      +
      +
    • With multiple optional parameters
      1
      GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal&name=bms-test01
+
      +
      +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    servers

    +

    Array of objects

    +

    Specifies the BMS list. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 2 servers field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    Specifies the BMS name.

    +

    id

    +

    String

    +

    Specifies the unique ID of the BMS.

    +

    links

    +

    Array of objects

    +

    Specifies shortcut links of the BMS. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 links field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    rel

    +

    String

    +

    Specifies the shortcut link marker name. The value can be:

    +
    • self: resource link that contains the version number. It is used when immediate tracing is required.
    • bookmark: resource link that can be stored for a long time.
    +

    href

    +

    String

    +

    Specifies the corresponding shortcut link.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
    {
+    "servers": [
+        {
+            "name": "bms",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8b-4bc5-ae46-69cacfd4fbaa"
+                },
+                {
+                    "rel": "bookmark",
+                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa"
+                }
+            ],
+            "id": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa"
+        }
+    ]
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Lifecycle Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158695.html b/docs/bms/api-ref/en-us_topic_0053158695.html new file mode 100644 index 000000000..f2d4664c4 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158695.html @@ -0,0 +1,190 @@ + + +

Modifying Specified BMS Metadata (Native OpenStack API)

+

Function

This API is used to modify specified BMS metadata.

+
+

Constraints

The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, paused, or suspended.

+
+

URI

PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+

key

+

Yes

+

Specifies the BMS metadata key value to be modified

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    meta

    +

    Yes

    +

    Object

    +

    Specifies the user-defined metadata key and value pair. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 2 meta field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    User-defined field key and value pair

    +

    Yes

    +

    String

    +

    Specifies the user-defined metadata key and value pair.

    +
    • Each key or value contains a maximum of 255 characters.
    • The key does not support the following special characters:

      :`~!@#$%^&*()=+<,>?/'";{[]}|\

      +
    • The value does not support the following special characters:

      \"

      +
    +
    +
    +
+
  • Example request
    1
    PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key}
+
    +
    +
    1
+2
+3
+4
+5
    {
+    "meta": {
+        "key": "value"
+    }
+}
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    meta

    +

    Object

    +

    Specifies the user-defined metadata key and value pair. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + +
    Table 3 meta field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    User-defined field key and value pair

    +

    String

    +

    Specifies the user-defined metadata key and value pair.

    +

    Each key or value contains a maximum of 255 characters.

    +
    +
    +
  • Example response
    1
+2
+3
+4
+5
    {
+    "meta": {
+        "key": "value"
+    }
+} 
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Metadata Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158696.html b/docs/bms/api-ref/en-us_topic_0053158696.html new file mode 100644 index 000000000..6caccdd14 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158696.html @@ -0,0 +1,161 @@ + + +

Querying IP Addresses of a BMS (Native OpenStack API)

+

Function

This API is used to query private IP addresses of a BMS.

+
+

Constraints

Pagination query is not supported.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}/ips

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/ips
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    addresses

    +

    Object

    +

    Specifies IP addresses of the BMS. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + +
    Table 2 addresses parameter structure description

    Parameter

    +

    Type

    +

    Description

    +

    vpc_id

    +

    Array of objects

    +

    Specifies the VPC used by the BMS.

    +
    • key: indicates the ID of the VPC used by the BMS.
    • value: indicates the VPC details. For details, see Table 3.
    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 address parameter structure description

    Parameter

    +

    Type

    +

    Description

    +

    version

    +

    Integer

    +

    Specifies the IP address version. The value can be:

    +
    • 4: IPv4 address
    • 6: IPv6 address
    +

    addr

    +

    String

    +

    Specifies the IP address.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
    {
+    "addresses": {
+        "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
+            {
+                "version": 4,
+                "addr": "192.168.2.90"
+            }
+        ]
+    }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS IP Address Query
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158703.html b/docs/bms/api-ref/en-us_topic_0053158703.html new file mode 100644 index 000000000..809670946 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158703.html @@ -0,0 +1,21 @@ + + +

BMS Disk Management

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158707.html b/docs/bms/api-ref/en-us_topic_0053158707.html new file mode 100644 index 000000000..484b17821 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158707.html @@ -0,0 +1,907 @@ + + +

Querying Details About a BMS (Native OpenStack API)

+

Function

This API is used to query details about a BMS based on the BMS ID.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/9ab74d89-61e7-4259-8546-465fdebe4944
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    server

    +

    Object

    +

    Specifies BMS information. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 server field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    Specifies the BMS name.

    +

    id

    +

    String

    +

    Specifies the unique ID of the BMS.

    +

    status

    +

    String

    +

    Specifies the BMS status.

    +

    Value range:

    +
    • ACTIVE: Running, Stopping, Deleting
    • BUILD: Creating
    • ERROR: Faulty
    • HARD_REBOOT: Forcibly Restarting
    • REBOOT: Restarting
    • SHUTOFF: Stopped, Starting, Deleting, Rebuilding
    +

    created

    +

    String

    +

    Specifies the time when the BMS was created.

    +

    The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T03:30:52Z.

    +

    updated

    +

    String

    +

    Specifies the time when the BMS was last updated.

    +

    The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T04:30:52Z.

    +

    flavor

    +

    Object

    +

    Specifies the BMS flavor. For details, see Table 3.

    +

    image

    +

    Object

    +

    Specifies the BMS image. For details, see Table 4.

    +

    tenant_id

    +

    String

    +

    Specifies the ID of the tenant owning the BMS. The value is in UUID format.

    +

    This parameter specifies the same meaning as project_id.

    +

    key_name

    +

    String

    +

    Specifies the SSH key name.

    +

    user_id

    +

    String

    +

    Specifies the ID of the user to which the BMS belongs.

    +

    metadata

    +

    Object

    +

    Specifies the BMS metadata. For details, see Table 6.

    +

    hostId

    +

    String

    +

    Specifies the host ID of the BMS.

    +

    addresses

    +

    Object

    +

    Specifies BMS network addresses. For details, see Table 7.

    +

    security_groups

    +

    Array of objects

    +

    Specifies the security groups to which the BMS belongs. For details, see Table 9.

    +

    links

    +

    Array of objects

    +

    Specifies shortcut links of the BMS. For details, see Table 5.

    +

    OS-DCF:diskConfig

    +

    String

    +

    Specifies the disk configuration method. This is an extended attribute. The value can be:

    +
    • MANUAL: The API uses the partitioning scheme in the image and the file system to create a BMS. If the target flavor has a large disk, the API does not partition the remaining disk space.
    • AUTO: The API uses a single partition with the same size as the disk of the target flavor to create a BMS. The API automatically adjusts the file system to adapt to the entire partition.
    +

    OS-EXT-AZ:availability_zone

    +

    String

    +

    Specifies the AZ where the BMS is located.

    +

    OS-EXT-SRV-ATTR:host

    +

    String

    +

    Specifies the host name of the BMS. This is an extended attribute.

    +

    OS-EXT-SRV-ATTR:hypervisor_hostname

    +

    String

    +

    Specifies the name of a host on the hypervisor. This is an extended attribute provided by the Nova virt driver.

    +

    OS-EXT-SRV-ATTR:instance_name

    +

    String

    +

    Specifies the BMS alias. This is an extended attribute.

    +

    OS-EXT-STS:power_state

    +

    Integer

    +

    Specifies the power status of the BMS. This is an extended attribute.

    +

    Options: 0, 1, 2, 3, and 4

    +
    • 0: pending
    • 1: running
    • 2: paused
    • 3: shutdown
    • 4: crashed
    +

    OS-EXT-STS:task_state

    +

    String

    +

    Specifies the task status of the BMS. This is an extended attribute.

    +

    Value range:

    +
    • rebooting: The BMS is being restarted.
    • reboot_started: The BMS is normally restarted.
    • reboot_started_hard: The BMS is forcibly restarted.
    • powering-off: The BMS is being powered off.
    • powering-on: The BMS is being powered on.
    • rebuilding: The BMS is being rebuilt.
    • scheduling: The BMS is being scheduled.
    • deleting: The BMS is being deleted.
    +

    OS-EXT-STS:vm_state

    +

    String

    +

    Specifies the stable BMS status. This is an extended attribute.

    +

    Value range:

    +
    • active: The BMS is running.
    • shutoff: The BMS is stopped.
    • suspended: The BMS is suspended.
    • reboot: The BMS is restarted.
    +

    OS-SRV-USG:launched_at

    +

    String

    +

    Specifies the time when the BMS was started. This is an extended attribute.

    +

    The timestamp format is ISO 8601, for example, 2019-05-22T03:23:59.000000.

    +

    OS-SRV-USG:terminated_at

    +

    String

    +

    Specifies the time when the BMS was deleted. This is an extended attribute.

    +

    The timestamp format is ISO 8601, for example, 2019-05-22T04:23:59.000000.

    +

    os-extended-volumes:volumes_attached

    +

    Array of objects

    +

    Specifies the EVS disks attached to the BMS. For details, see Table 10.

    +

    accessIPv4

    +

    String

    +

    This is a reserved attribute.

    +

    accessIPv6

    +

    String

    +

    This is a reserved attribute.

    +

    fault

    +

    Object

    +

    Specifies the fault cause. If the BMS is faulty, this field is returned. For details, see Table 11.

    +

    config_drive

    +

    String

    +

    This is a reserved attribute.

    +

    progress

    +

    Integer

    +

    This is a reserved attribute.

    +

    description

    +

    String

    +

    Provides supplementary information about the pool.

    +

    This parameter is added in micro version 2.19.

    +

    host_status

    +

    String

    +

    Specifies the status of the host that accommodates the BMS.

    +
    • UP: The nova-compute is normal.
    • UNKNOWN: The nova-compute status is unknown.
    • DOWN: the nova-compute status is abnormal.
    • MAINTENANCE: The nova-compute is in the maintenance state.
    • Empty string: The BMS does not have host information.
    +

    Added in micro version 2.16.

    +

    OS-EXT-SRV-ATTR:hostname

    +

    String

    +

    Specifies the host name of the BMS.

    +

    Added in micro version 2.3.

    +

    OS-EXT-SRV-ATTR:reservation_id

    +

    String

    +

    Specifies the reserved BMS IDs in the batch BMS creation scenario.

    +

    Added in micro version 2.3.

    +

    OS-EXT-SRV-ATTR:launch_index

    +

    Integer

    +

    Specifies the BMS startup sequence in the batch BMS creation scenario.

    +

    Added in micro version 2.3.

    +

    OS-EXT-SRV-ATTR:kernel_id

    +

    String

    +

    Specifies the UUID of the kernel image when the AMI image is used. In other scenarios, leave this parameter blank.

    +

    Added in micro version 2.3.

    +

    OS-EXT-SRV-ATTR:ramdisk_id

    +

    String

    +

    Specifies the UUID of the Ramdisk image when the AMI image is used. In other scenarios, leave this parameter blank.

    +

    Added in micro version 2.3.

    +

    OS-EXT-SRV-ATTR:root_device_name

    +

    String

    +

    Specifies the device name of the BMS system disk, for example, /dev/sda.

    +

    Added in micro version 2.3.

    +

    OS-EXT-SRV-ATTR:user_data

    +

    String

    +

    Specifies the user_data specified during BMS creation. The value is encoded using Base64 or an empty string.

    +

    locked

    +

    Boolean

    +

    Specifies whether the BMS is locked.

    +
    • true: The BMS is locked.
    • false: The BMS is not locked.
    +

    Added in micro version 2.9.

    +

    tags

    +

    Array of strings

    +

    Specifies tags of the BMS.

    +

    This parameter is added in microversion 2.26. If the microversion is not used for query, the response does not contain the tags field.

    +

    The value of this field meets the following requirements:

    +
    • The key and value of a tag are connected using an equal sign (=), for example, key=value.
    • If the value is empty, only the key is returned.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 flavor field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the BMS type ID.

    +

    This field is not supported in microversions later than 2.47.

    +

    links

    +

    Array of objects

    +

    Specifies shortcut links of the BMS type.

    +

    For details, see Table 5.

    +

    This field is not supported in microversions later than 2.47.

    +

    vcpus

    +

    Integer

    +

    Specifies the number of CPU cores in the BMS flavor.

    +

    This field is supported in microversions later than 2.47.

    +

    ram

    +

    Integer

    +

    Specifies the memory size (MB) in the BMS flavor.

    +

    This field is supported in microversions later than 2.47.

    +

    disk

    +

    Integer

    +

    Specifies the system disk size in the BMS flavor. The value 0 indicates that the disk size is not limited.

    +

    This field is supported in microversions later than 2.47.

    +

    ephemeral

    +

    Integer

    +

    This is a reserved attribute.

    +

    This field is supported in microversions later than 2.47.

    +

    swap

    +

    Integer

    +

    This is a reserved attribute.

    +

    This field is supported in microversions later than 2.47.

    +

    original_name

    +

    String

    +

    This is a reserved attribute.

    +

    This field is supported in microversions later than 2.47.

    +

    extra_specs

    +

    Object

    +

    Extended flavor field

    +

    This field is supported in microversions later than 2.47.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 4 image field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the image ID of the BMS.

    +

    links

    +

    Array of objects

    +

    Specifies shortcut links of the BMS image. For details, see Table 5.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 5 links field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    rel

    +

    String

    +

    Specifies the shortcut link marker name. The value can be:

    +
    • self: resource link that contains the version number. It is used when immediate tracing is required.
    • bookmark: resource link that can be stored for a long time.
    +

    href

    +

    String

    +

    Specifies the corresponding shortcut link.

    +
    +
    + +
    + + + + + + + + + +
    Table 6 metadata field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    User-defined field key and value pair

    +

    String

    +

    Specifies the key and value pair of the metadata.

    +

    Each key or value contains a maximum of 255 characters.

    +
    +
    + +
    + + + + + + + + + +
    Table 7 addresses field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    vpc_id

    +

    Array of objects

    +

    Specifies the VPC used by the BMS.

    +
    • key: indicates the ID of the VPC used by the BMS.
    • value: indicates the VPC details. For details, see Table 8.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 8 address field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    addr

    +

    String

    +

    Specifies the IP address.

    +

    version

    +

    Integer

    +

    Specifies the type of the IP address. The value can be 4 or 6.

    +
    • 4: The type of the IP address is IPv4.
    • 6: The type of the IP address is IPv6.
    +

    OS-EXT-IPS-MAC:mac_addr

    +

    String

    +

    Specifies the MAC address. This is an extended attribute.

    +

    OS-EXT-IPS:type

    +

    String

    +

    Specifies the IP address type. This is an extended attribute.

    +
    • fixed: indicates the private IP address.
    • floating: indicates the EIP.
    +
    +
    + +
    + + + + + + + + + +
    Table 9 security_groups field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    name

    +

    String

    +
    • If no security group is specified during BMS creation, the default value is used.
    • If a security group is specified when you create the BMS, the value of this parameter is the security group name.
    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 10 os-extended-volumes:volumes_attached field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the EVS disk ID.

    +

    delete_on_termination

    +

    Boolean

    +

    Specifies whether to delete the disk when deleting the BMS.

    +
    • true: Yes
    • false: No
    +

    Added in micro version 2.3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 11 fault field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    message

    +

    String

    +

    Specifies the fault information.

    +

    code

    +

    Integer

    +

    Specifies the fault code.

    +

    details

    +

    String

    +

    Specifies the fault details.

    +

    created

    +

    String

    +

    Specifies the time when the fault occurred. The time is in ISO 8601 format.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
    {
+    "server": {
+        "tenant_id": "c685484a8cc2416b97260938705deb65",
+        "addresses": {
+            "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
+{
+                    "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c3:77",
+                    "OS-EXT-IPS:type": "fixed",
+                    "addr": "192.168.0.107",
+                    "version": 4
+                }
+            ]
+        },
+        "metadata": {
+            "op_svc_userid": "1311c433dd9b408886f57d695c229cbe"
+        },
+        "OS-EXT-STS:task_state": null,
+        "OS-DCF:diskConfig": "MANUAL",
+        "OS-EXT-AZ:availability_zone": "az-dc-1",
+        "links": [
+{
+                "rel": "self",
+                "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
+            },
+{
+                "rel": "bookmark",
+                "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
+                }
+        ],
+        "OS-EXT-STS:power_state": 1,
+        "id": "95bf2490-5428-432c-ad9b-5e3406f869dd",
+        "os-extended-volumes:volumes_attached": [
+{
+                "id": "dfa375b5-9856-44ad-a937-a4802b6434c3"
+            },
+{
+                "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417"
+            },
+{
+                "id": "86e801c3-acc6-465d-890c-d43ba493f553"
+            },
+{
+                "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6"
+                }
+        ],
+        "OS-EXT-SRV-ATTR:host": "bms.az1",
+        "image": {
+            "links": [
+{
+                    "rel": "bookmark",
+                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319"
+                }
+            ],
+            "id": "1a6635d8-afea-4f2b-abb6-27a202bad319"
+        },
+        "OS-SRV-USG:terminated_at": null,
+        "accessIPv4": "",
+        "accessIPv6": "",
+        "created": "2017-05-24T06:14:05Z",
+        "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e",
+        "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2",
+        "key_name": "KeyPair-JX",
+        "flavor": {
+            "links": [
+{
+                    "rel": "bookmark",
+                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium"
+                }
+            ],
+            "id": "physical.83.medium"
+        },
+        "security_groups": [
+{
+                "name": "0011b620-4982-42e4-ad12-47c95ca495c4"
+                }
+        ],
+        "config_drive": "",
+        "OS-EXT-STS:vm_state": "active",
+        "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3",
+        "user_id": "1311c433dd9b408886f57d695c229cbe",
+        "name": "bms-83",
+        "progress": 0,
+        "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078",
+        "updated": "2017-05-25T03:40:25Z",
+        "status": "ACTIVE"
+                }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Lifecycle Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158710.html b/docs/bms/api-ref/en-us_topic_0053158710.html new file mode 100644 index 000000000..d1a49ce52 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158710.html @@ -0,0 +1,521 @@ + + +

Changing the Name of a BMS (Native OpenStack API)

+

Function

This interface is used to modify BMS information. Currently, only the name of the BMS can be changed.

+
+

URI

PUT /v2.1/{project_id}/servers/{server_id}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    server

    +

    Yes

    +

    Object

    +

    Specifies the BMS data structure. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 2 server field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

    Specifies the new BMS name.

    +
    +
    +
+
  • Example request
    1
    PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd
+
    +
    +
    1
+2
+3
+4
+5
    {
+    "server": {
+        "name": "new-server-test"
+    }
+}
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    Specifies the BMS name.

    +

    id

    +

    String

    +

    Specifies the unique ID of the BMS.

    +

    status

    +

    String

    +

    Specifies the current status of the BMS.

    +
    • ACTIVE: Running, Stopping, Deleting
    • BUILD: Creating
    • ERROR: Faulty
    • HARD_REBOOT: Forcibly Restarting
    • REBOOT: Restarting
    • DELETED: Deleted
    +

    created

    +

    String

    +

    Specifies the time when the BMS was created.

    +

    The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T03:30:52Z.

    +

    updated

    +

    String

    +

    Specifies the time when the BMS was last updated.

    +

    The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T04:30:52Z.

    +

    flavor

    +

    Object

    +

    Specifies the BMS flavor information. For details, see Table 3.

    +

    image

    +

    Object

    +

    Specifies the BMS image. For details, see Table 4.

    +

    tenant_id

    +

    String

    +

    Specifies the ID of the tenant owning the BMS. The ID is in UUID format.

    +

    This parameter specifies the same meaning as project_id.

    +

    user_id

    +

    String

    +

    Specifies the ID of the user to which the BMS belongs.

    +

    metadata

    +

    Object

    +

    Specifies the BMS metadata. For details, see Table 5.

    +

    hostId

    +

    String

    +

    Specifies the host ID of the BMS.

    +

    addresses

    +

    Object

    +

    Specifies the BMS network address. For details, see Table 7.

    +

    links

    +

    Array of objects

    +

    Specifies the shortcut links of the BMS. For details, see Table 6.

    +

    accessIPv4

    +

    String

    +

    This is a reserved attribute.

    +

    accessIPv6

    +

    String

    +

    This is a reserved attribute.

    +

    OS-DCF:diskConfig

    +

    String

    +

    Specifies the disk configuration method. This is an extended attribute. The value can be:

    +
    • MANUAL: The API uses the partitioning scheme in the image and the file system to create a BMS. If the target flavor has a large disk, the API does not partition the remaining disk space.
    • AUTO: The API uses a single partition with the same size as the disk of the target flavor to create a BMS. The API automatically adjusts the file system to adapt to the entire partition.
    +

    progress

    +

    Integer

    +

    This is a reserved attribute.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 flavor field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the flavor ID.

    +

    links

    +

    Array of objects

    +

    Specifies the shortcut link of the BMS flavor. For details, see Table 6.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 4 image field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the ID of the BMS image.

    +

    links

    +

    Array of objects

    +

    Specifies the shortcut links of the BMS image. For details, see Table 6.

    +
    +
    + +
    + + + + + + + + + +
    Table 5 metadata field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    User-defined field key and value pair

    +

    String

    +

    Specifies the key and value pair of the metadata.

    +

    Each key or value contains a maximum of 255 characters.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 6 links field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    rel

    +

    String

    +

    Specifies the shortcut link marker name. The value can be:

    +
    • self: resource link that contains the version number. It is used when immediate tracing is required.
    • bookmark: resource link that can be stored for a long time.
    +

    href

    +

    String

    +

    Specifies the corresponding shortcut link.

    +
    +
    + +
    + + + + + + + + + +
    Table 7 addresses field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    vpc_id

    +

    Array of objects

    +

    Specifies the VPC used by the BMS.

    +
    • key: indicates the ID of the VPC used by the BMS.
    • value: indicates the VPC details. For details, see Table 8.
    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 8 address field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    addr

    +

    String

    +

    Specifies the IP address.

    +

    version

    +

    String

    +

    Specifies the version of the IP address.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
    {
+    "server": {
+        "tenant_id": "c685484a8cc2416b97260938705deb65",
+        "image": {
+            "links": [
+                {
+                    "rel": "bookmark",
+                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319"
+                }
+            ],
+            "id": "1a6635d8-afea-4f2b-abb6-27a202bad319"
+        },
+        "accessIPv4": "",
+        "addresses": {
+            "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
+                {
+                    "addr": "192.168.0.107",
+                    "version": 4
+                }
+            ]
+        },
+        "metadata": {
+            "op_svc_userid": "1311c433dd9b408886f57d695c229cbe"
+        },
+        "accessIPv6": "",
+        "created": "2017-05-24T06:14:05Z",
+        "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e",
+        "flavor": {
+            "links": [
+                {
+                    "rel": "bookmark",
+                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium"
+                }
+            ],
+            "id": "physical.83.medium"
+        },
+        "OS-DCF:diskConfig": "MANUAL",
+        "user_id": "1311c433dd9b408886f57d695c229cbe",
+        "name": "new-server-test",
+        "progress": 0,
+        "links": [
+            {
+                "rel": "self",
+                "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
+            },
+            {
+                "rel": "bookmark",
+                "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
+            }
+        ],
+        "id": "95bf2490-5428-432c-ad9b-5e3406f869dd",
+        "updated": "2017-05-25T03:40:25Z",
+        "status": "ACTIVE"
+    }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Status Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158711.html b/docs/bms/api-ref/en-us_topic_0053158711.html new file mode 100644 index 000000000..6abd0540a --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158711.html @@ -0,0 +1,17 @@ + + +

BMS NIC Management

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158712.html b/docs/bms/api-ref/en-us_topic_0053158712.html new file mode 100644 index 000000000..e3e4ee8d6 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158712.html @@ -0,0 +1,185 @@ + + +

Updating BMS Metadata (Native OpenStack API)

+

Function

This API is used to update BMS metadata.

+
+
  • If the metadata does not contain the target field, the field is automatically added to the field.
  • If the metadata contains the target field, the field value is automatically updated.
+

Constraints

The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, paused, or suspended.

+
+

URI

POST /v2.1/{project_id}/servers/{server_id}/metadata

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    metadata

    +

    Yes

    +

    Object

    +

    Specifies the user-defined metadata key and value pair. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 2 metadata field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    User-defined field key and value pair

    +

    Yes

    +

    String

    +

    Specifies the user-defined metadata key and value pair.

    +
    • Each key or value contains a maximum of 255 characters.
    • The key does not support the following special characters:

      :`~!@#$%^&*()=+<,>?/'";{[]}|\

      +
    • The value does not support the following special characters:

      \"

      +
    +
    +
    +
+
  • Example request
    1
    POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata
+
    +
    +
    1
+2
+3
+4
+5
    {
+    "metadata": {
+        "key": "value"
+    }
+    }
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    metadata

    +

    Object

    +

    Specifies the user-defined metadata key and value pair. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + +
    Table 3 metadata field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    User-defined field key and value pair

    +

    String

    +

    Specifies the key and value pair of the metadata.

    +
    • Each key or value contains a maximum of 255 characters.
    • The value does not support the following special characters:

      \"

      +
    +
    +
    +
  • Example response
    1
+2
+3
+4
+5
    {
+    "metadata": {
+        "key": "value"
+    }
+    }
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Metadata Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158713.html b/docs/bms/api-ref/en-us_topic_0053158713.html new file mode 100644 index 000000000..224a687d4 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158713.html @@ -0,0 +1,71 @@ + + +

Deleting a BMS (Native OpenStack API)

+

Function

This interface is used to delete a BMS.

+
+

URI

DELETE /v2.1/{project_id}/servers/{server_id}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/9ab74d89-61e7-4259-8546-465fdebe4944
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Lifecycle Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0053158716.html b/docs/bms/api-ref/en-us_topic_0053158716.html new file mode 100644 index 000000000..b692e4434 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0053158716.html @@ -0,0 +1,133 @@ + + +

Restarting a BMS (Native OpenStack API)

+

Function

This API is used to restart a single BMS.

+
+

Constraints

Currently, only forcible restart is supported.

+
+

URI

POST /v2.1/{project_id}/servers/{server_id}/action

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    reboot

    +

    Yes

    +

    Object

    +

    Specifies the operation of restarting the BMS. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 2 reboot field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    type

    +

    Yes

    +

    String

    +

    Specifies the type of the restart operation.

    +
    • SOFT: soft restart
    • HARD: forcible restart
      NOTE:

      Currently, value SOFT is invalid. All BMS restart operations are forcible restart.

      +
      +
    +
    +
    +
+
  • Example request
    1
    POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action
+
    +
    +
    1
+2
+3
+4
+5
    {
+    "reboot": {
+        "type": "HARD"
+    }
+}
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Status Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060323087.html b/docs/bms/api-ref/en-us_topic_0060323087.html new file mode 100644 index 000000000..737f4a1eb --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060323087.html @@ -0,0 +1,13 @@ + + +

Public Parameters

+
+
+ +
+ diff --git a/docs/bms/api-ref/en-us_topic_0060384657.html b/docs/bms/api-ref/en-us_topic_0060384657.html new file mode 100644 index 000000000..e406874e6 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060384657.html @@ -0,0 +1,21 @@ + + +

BMS SSH Key Pair Management

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060384658.html b/docs/bms/api-ref/en-us_topic_0060384658.html new file mode 100644 index 000000000..9a7e335e3 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060384658.html @@ -0,0 +1,170 @@ + + +

Querying SSH Key Pairs (Native OpenStack API)

+

Function

This interface is used to query SSH key pairs and to display the query results in a list.

+
+

Constraints

Pagination query is not supported.

+
+

URI

GET /v2.1/{project_id}/os-keypairs

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    keypairs

    +

    Array of objects

    +

    Specifies key pairs. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + +
    Table 2 keypairs field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    keypair

    +

    Object

    +

    Specifies details about a key pair. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 keypair field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    fingerprint

    +

    String

    +

    Specifies fingerprint information about the key pair.

    +

    name

    +

    String

    +

    Specifies the key pair name.

    +

    type

    +

    String

    +

    Specifies the key type, which is ssh by default.

    +

    This field is supported in microversions later than 2.2.

    +

    public_key

    +

    String

    +

    Specifies information about the public key in the key pair.

    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
    {
+    "keypairs": [
+        {
+            "keypair": {
+                "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a",
+                "name": "keypair-test",
+                "type": "ssh",
+                "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova"
+            }
+        }
+    ]
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS SSH Key Pair Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060384659.html b/docs/bms/api-ref/en-us_topic_0060384659.html new file mode 100644 index 000000000..c64d8e796 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060384659.html @@ -0,0 +1,196 @@ + + +

Querying an SSH Key Pair (Native OpenStack API)

+

Function

This interface is used to query a specified SSH key pair based on the key pair name.

+
+

URI

GET /v2.1/{project_id}/os-keypairs/{keypair_name}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

keypair_name

+

Yes

+

Specifies the key pair name.

+

You can obtain the key pair name by calling the Querying SSH Key Pairs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs/keypair-test
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    keypair

    +

    Object

    +

    Specifies the SSH key pair. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 keypair field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    public_key

    +

    String

    +

    Specifies information about the public key in the key pair.

    +

    name

    +

    String

    +

    Specifies the key pair name.

    +

    fingerprint

    +

    String

    +

    Specifies fingerprint information about the key pair.

    +

    created_at

    +

    String

    +

    Specifies the time when the key pair was created.

    +

    The timestamp format is ISO 8601, for example, 2019-05-07T12:06:13.681238.

    +

    deleted

    +

    Boolean

    +

    Specifies the deleted key pair.

    +
    • true: indicates that the key has been deleted.
    • false: indicates that the key is not deleted.
    +

    deleted_at

    +

    String

    +

    Specifies the time when the key pair was deleted.

    +

    The timestamp format is ISO 8601, for example, 2019-05-07T12:06:13.681238.

    +

    id

    +

    String

    +

    Specifies the key pair ID.

    +

    updated_at

    +

    String

    +

    Specifies the time when the key pair was updated.

    +

    The timestamp format is ISO 8601, for example, 2019-05-07T12:06:13.681238.

    +

    user_id

    +

    String

    +

    Specifies information about the user to which the key pair belongs.

    +
    +
    +
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
    {
+    "keypair": {
+        "created_at": "2019-05-07T12:06:13.681238",
+        "deleted": false,
+        "deleted_at": null,
+        "fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01",
+        "id": 1,
+        "name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314",
+        "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd+GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/9IXRx1ERImsqZnE9usB Generated-by-Nova",
+        "updated_at": null,
+        "user_id": "fake"
+    }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS SSH Key Pair Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060384660.html b/docs/bms/api-ref/en-us_topic_0060384660.html new file mode 100644 index 000000000..8ab467ad0 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060384660.html @@ -0,0 +1,221 @@ + + +

Creating and Importing an SSH Key Pair (Native OpenStack API)

+

Function

This interface is used to create an SSH key pair or import a public key to generate a key pair.

+

After an SSH key is created, download the private key to a local directory. Then, you can use this private key to log in to the BMS. To ensure BMS security, the private key can be downloaded only once. Keep it secure.

+
+

URI

POST /v2.1/{project_id}/os-keypairs

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+
+
+
+

Request

  • Request parameters

    When creating an SSH key pair, you only need to configure name. When importing a public SSH key, you must also configure public_key.

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

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    keypair

    +

    Yes

    +

    Object

    +

    Specifies the created or imported SSH key pair. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 2 keypair field data structure description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    public_key

    +

    No

    +

    String

    +

    Specifies the imported public key. The maximum size of the imported public key is 1024 bytes.

    +

    Note: If the length of the public key to be imported exceeds 1024 bytes, the public key import to the BMS will fail.

    +

    name

    +

    Yes

    +

    String

    +

    Specifies the key pair name.

    +

    The new key pair name cannot be the same as an existing one.

    +
    +
    +
+
  • Example request
    1
    POST https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs
+
    +
    +
    1
+2
+3
+4
+5
+6
    {
+    "keypair": {
+        "name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043",
+        "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD+htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n"
+    }
+}
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    keypair

    +

    Object

    +

    Specifies the SSH key pair. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 keypair field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    fingerprint

    +

    String

    +

    Specifies fingerprint information about the key pair.

    +

    name

    +

    String

    +

    Specifies the key pair name.

    +

    public_key

    +

    String

    +

    Specifies the public key.

    +

    private_key

    +

    String

    +

    Specifies the private key.

    +
    • The information about the private key is contained in the response for creating an SSH key.
    • The information about the private key is not contained in the response for importing an SSH key.
    +

    user_id

    +

    String

    +

    Specifies the ID of the user to which the key pair belongs.

    +
    +
    +
+
  • Example response
    1
+2
+3
+4
+5
+6
+7
+8
    {
+    "keypair": {
+        "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD+htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n",
+        "user_id": "f882feb345064e7d9392440a0f397c25",
+        "name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043",
+        "fingerprint": "35:9d:d0:c3:4a:80:d3:d8:86:f1:ca:f7:df:c4:f9:d8"
+    }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS SSH Key Pair Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060384661.html b/docs/bms/api-ref/en-us_topic_0060384661.html new file mode 100644 index 000000000..605a04209 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060384661.html @@ -0,0 +1,71 @@ + + +

Deleting an SSH Key Pair (Native OpenStack API)

+

Function

This interface is used to delete a specified SSH key pair based on the key pair name.

+
+

URI

DELETE /v2.1/{project_id}/os-keypairs/{keypair_name}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

keypair_name

+

Yes

+

Specifies the key pair name.

+

You can obtain the key pair name by calling the Querying SSH Key Pairs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs/keypair-test
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS SSH Key Pair Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060402469.html b/docs/bms/api-ref/en-us_topic_0060402469.html new file mode 100644 index 000000000..b5e07e857 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060402469.html @@ -0,0 +1,123 @@ + + +

Querying BMS Metadata (Native OpenStack API)

+

Function

The BMS metadata includes BMS basic information on the cloud platform, such as the BMS ID, hostname, and network information. This API is used to query the BMS metadata.

+
+

Constraints

Pagination query is not supported.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}/metadata

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    metadata

    +

    Object

    +

    Specifies the user-defined metadata key and value pair. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + +
    Table 2 metadata field data structure description

    Parameter

    +

    Type

    +

    Description

    +

    User-defined field key and value pair

    +

    String

    +

    Specifies the key and value pair of the metadata.

    +

    Each key or value contains a maximum of 255 characters.

    +
    +
    +
  • Example response
    1
+2
+3
+4
+5
    {
+    "metadata": {
+        "key": "value"
+    }
+} 
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Metadata Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060410925.html b/docs/bms/api-ref/en-us_topic_0060410925.html new file mode 100644 index 000000000..ca55d9f33 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060410925.html @@ -0,0 +1,25 @@ + + +

BMS 1D Tag Management

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060410926.html b/docs/bms/api-ref/en-us_topic_0060410926.html new file mode 100644 index 000000000..6271b3772 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060410926.html @@ -0,0 +1,107 @@ + + +

Querying BMS Tags (Native OpenStack API)

+

Function

This API is used to query all tags of a BMS.

+

You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}/tags

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    Array of strings

    +

    Specifies user-defined tags of a BMS.

    +
    +
    +
+
  • Example response
    1
+2
+3
+4
+5
+6
+7
    {
+    "tags": [
+        "baz",
+        "foo",
+        "qux"
+    ]
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS 1D Tag Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060410927.html b/docs/bms/api-ref/en-us_topic_0060410927.html new file mode 100644 index 000000000..69bf381f1 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060410927.html @@ -0,0 +1,148 @@ + + +

Adding Tags to a BMS (Native OpenStack API)

+

Function

This API is used to add tags to a BMS.

+

You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.

+
+

Constraints

A BMS can have a maximum of 50 tags.
  • It is recommended that you add the __type_baremetal tag to BMSs to distinguish BMSs from ECSs. Otherwise, BMSs will be available only on the ECS console.
  • A new tag will overwrite the existing one. If you want to retain the original tag, add it to the list of new tags. You are advised to add __type_baremetal to the added tags list each time you add a tag.
+
+
+
+

URI

PUT /v2.1/{project_id}/servers/{server_id}/tags

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    Yes

    +

    Array of strings

    +
    • Specifies the tags of a BMS. Each tag can contain a maximum of 80 characters.
    • The tag cannot start with a period (.).
    • A BMS can have a maximum of 50 tags.
    • An empty tag cannot be created.
    +
    +
    +
  • Example request
    1
    PUT https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags
+
    +
    +
    1
+2
+3
+4
+5
+6
+7
    {
+    "tags": [
+        "baz",
+        "foo",
+        "qux"
+    ]
+}
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    Array of strings

    +

    Specifies user-defined tags of a BMS.

    +
    +
    +
+
  • Example response
    1
+2
+3
+4
+5
+6
+7
    {
+    "tags": [
+        "baz",
+        "foo",
+        "qux"
+    ]
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS 1D Tag Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060410928.html b/docs/bms/api-ref/en-us_topic_0060410928.html new file mode 100644 index 000000000..5fe2d1615 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060410928.html @@ -0,0 +1,75 @@ + + +

Deleting Tags of a BMS (Native OpenStack API)

+

Function

This API is used to delete all tags of a BMS.

+

You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.

+
+

Constraints

  • Tag __type_baremetal is used to identify a BMS. You are not advised to delete this tag. Otherwise, the BMS will be displayed only on the ECS console.
  • After deleting the __type_baremetal tag, you can add it again by following the instructions in Adding a Tag to a BMS (Native OpenStack API). After the tag is added, the BMS will be displayed on the BMS console.
+
+
+

URI

DELETE /v2.1/{project_id}/servers/{server_id}/tags

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS 1D Tag Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060410929.html b/docs/bms/api-ref/en-us_topic_0060410929.html new file mode 100644 index 000000000..661195f20 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060410929.html @@ -0,0 +1,85 @@ + + +

Adding a Tag to a BMS (Native OpenStack API)

+

Function

This API is used to add a tag to a BMS.

+

You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.

+
+

Constraints

  • A BMS can have a maximum of 50 tags.
  • The tag contains a maximum of 80 characters.
  • The tag cannot start with a period (.).
  • An empty tag cannot be created.
+

It is recommended that you add the __type_baremetal tag to BMSs to distinguish BMSs from ECSs.

+
+
+

URI

PUT /v2.1/{project_id}/servers/{server_id}/tags/{tag}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+

tag

+

Yes

+

Specifies the tag information.

+

Constraints:

+
  • The tag contains a maximum of 80 characters.
  • The tag cannot start with a period (.).
  • An empty tag cannot be created.
  • URL encoding is required for special characters.
+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    PUT https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags/{tag}
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS 1D Tag Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060410930.html b/docs/bms/api-ref/en-us_topic_0060410930.html new file mode 100644 index 000000000..28a3513f2 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060410930.html @@ -0,0 +1,95 @@ + + +

Checking for Tags of a BMS (Native OpenStack API)

+

Function

This API is used to check whether a BMS has a specified tag.

+

You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.

+
+

URI

GET /v2.1/{project_id}/servers/{server_id}/tags/{tag}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+

tag

+

Yes

+

Specifies the key of the tag to be queried.

+

Constraints:

+
  • URL encoding is required for special characters.
  • If no tag key is specified, all tags of the BMS are displayed.
+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/2d85af7c-cbfe-40c5-a378-4d03b42fb0e2/tags/{tag}
+
    +
    +
+
+

Response

If the specified tag exists, no response is returned.

+

If the specified tag does not exist, the response is as follows:

+
1
+2
+3
+4
+5
+6
{
+    "itemNotFound": {
+        "message": "Server 2d85af7c-cbfe-40c5-a378-4d03b42fb0e2 has no tag 'abc'",
+        "code": 404
+    }
+}
+
+
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS 1D Tag Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0060424486.html b/docs/bms/api-ref/en-us_topic_0060424486.html new file mode 100644 index 000000000..7ca992f49 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060424486.html @@ -0,0 +1,85 @@ + + +

Deleting a Tag of a BMS (Native OpenStack API)

+

Function

This API is used to delete a tag of a BMS.

+

You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.

+
+

Constraints

  • The tag contains a maximum of 80 characters.
  • If a tag contains non-URL-safe characters, perform URL encoding.
+
  • Tag __type_baremetal is used to identify a BMS. You are not advised to delete this tag. Otherwise, the BMS will be displayed only on the ECS console.
  • After deleting the __type_baremetal tag, you can add it again by following the instructions in Adding a Tag to a BMS (Native OpenStack API). After the tag is added, the BMS will be displayed on the BMS console.
+
+
+

URI

DELETE /v2.1/{project_id}/servers/{server_id}/tags/{tag}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

server_id

+

Yes

+

Specifies the BMS ID.

+

You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.

+

tag

+

Yes

+

Specifies the tag information.

+

Constraints:

+
  • A tag can contain a maximum of 80 characters. If a tag contains non-URL-safe characters, perform URL encoding.
  • If no key is specified, all tags of the BMS are deleted.
+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags/{tag}
+
    +
    +
+
+

Response

N/A

+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

204

+

The server has processed the request but did not return any content.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS 1D Tag Management
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0107541808.html b/docs/bms/api-ref/en-us_topic_0107541808.html new file mode 100644 index 000000000..551cb9bfa --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0107541808.html @@ -0,0 +1,1241 @@ + + +

Error Codes

+

Context

  • An error code returned by an API does not correspond to one error message. The following table lists only common error messages.
  • Most BMS APIs are asynchronous. Some error codes are displayed in the returned messages for task viewing requests. HTTP status codes may not be accurate.
  • The BMS service is strongly dependent on other services, such as network and storage. When error messages are provided for the BMS-depended services, contact technical support for troubleshooting.
+
+

Error Code Description

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

HTTP Status Code

+

Returned Value

+

Description

+

Error Message

+

Handling Measure

+

400

+

BMS.0001

+

Request error.

+

Fail to parse request, reason: %s.

+

Check the request body according to the returned error message.

+

400

+

BMS.0002

+

BMS has not been launched.

+

The BMS service is unavailable.

+

Select a region where the BMS service is available.

+

400

+

BMS.0003

+

Request error.

+

Create BareMetal Server error, request is null.

+

Check the request body according to the returned error message.

+

400

+

BMS.0004

+

Insufficient permission.

+

Role check fail, reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0005

+

Insufficient permission.

+

Role check fail, reason: You do not have permission or your balance is insufficient.

+

See the returned error message or contact technical support.

+

400

+

BMS.0008

+

Failed to query a flavor.

+

Fail to query flavor [%s], reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0006

+

Failed to create the task.

+

Fail to operate baremetal server.

+

See the returned error message or contact technical support.

+

400

+

BMS.0009

+

Failed to query flavor attributes.

+

Fail to query flavor extra specs[%s], reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0010

+

Failed to query an image.

+

Fail to query image [%s], reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0011

+

The images do not support BMS.

+

The selected images cannot be used to apply for BMSs, %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0012

+

Insufficient IP addresses in the selected subnet.

+

The number of IP addresses in the selected subnet[%s] is insufficient.

+

Check whether the IP addresses of the subnet are used up.

+

400

+

BMS.0013

+

Failed to query the port.

+

Fail to query ports by subnet [%s], reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0014

+

IP address conflict.

+

The specified IP address conflicts with an existing IP address in subnet[%s].

+

Modify the NIC IP address.

+

400

+

BMS.0015

+

Failed to query the NIC.

+

Fail to query subnet, reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0017

+

The EIP quota is insufficient.

+

The number[%d] of EIPs has reached the maximum[%d] allowed. Apply for a higher quota and try again.

+

Apply for a higher EIP quota.

+

400

+

BMS.0218

+

Failed to create the order.

+

Fail to create order, reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0018

+

Invalid request parameters.

+

Request parameter is invalid.

+

Modify the request parameters based on the returned error message.

+

400

+

BMS.0019

+

Invalid NIC parameters.

+

publicIp parameter is illegal, reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0021

+

The flavor is invalid for creating the BMS. Select another flavor.

+

Flavor parameter is illegal, reason: %s.

+

Select a valid flavor.

+

400

+

BMS.0022

+

Invalid request parameters.

+

Request parameter is invalid.

+

Modify the request parameters based on the returned error message.

+

400

+

BMS.0023

+

Failed to query the quota.

+

Fail to query limits, reason: %s

+

See the returned error message or contact technical support.

+

400

+

BMS.0025

+

The number of BMSs exceeds the quota.

+

The number of cloud servers has reached the maximum allowed.

+

Apply for a higher quota.

+

400

+

BMS.0026

+

The number of BMS CPUs exceeds the quota.

+

The number of CPU cores used by all cloud servers has reached the maximum allowed.

+

Apply for a higher quota.

+

400

+

BMS.0027

+

The BMS memory exceeds the quota.

+

The memory space used by all cloud servers has reached the maximum allowed.

+

Apply for a higher quota.

+

400

+

BMS.0028

+

The number of BMSs and that of CPUs exceed the quotas.

+

The number of CPU cores used by all cloud servers and that of cloud servers have reached the maximum allowed.

+

Apply for a higher quota.

+

400

+

BMS.0029

+

The number of BMSs and the memory exceed the quotas.

+

The memory space used by all cloud servers and the number of cloud servers have reached the maximum allowed.

+

Apply for a higher quota.

+

400

+

BMS.0030

+

The BMS memory and the number of CPUs exceed the quotas.

+

The memory space and number of CPU cores used by all cloud servers have reached the maximum allowed.

+

Apply for a higher quota.

+

400

+

BMS.0031

+

The number of BMSs, the number of CPUs, and the memory exceed the quotas.

+

The number of cloud servers, the memory space used by all cloud servers, and the number of CPU cores used by all cloud servers have reached the maximum allowed.

+

Apply for a higher quota.

+

400

+

BMS.0032

+

Contact technical support to apply for a BMS.

+

Token check fail.

+

See the returned error message or contact technical support.

+

403

+

BMS.0033

+

You do not have operation rights. Contact technical support.

+

Fail to check roles, reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0034

+

Currently, BMSs cannot be automatically provisioned.

+

Not support create Bare Metal Server.

+

This operation is not supported.

+

400

+

BMS.0047

+

Invalid system disk.

+

Root volume is illegal, reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0049

+

Failed to query key_name.

+

Query keypair fail, reason is: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0102

+

This image does not support volume attaching.

+

The image does not support attach volume.

+

Contact technical support.

+

400

+

BMS.0103

+

The disk does not exist.

+

Attach volume %s fail, volume info is null.

+

Check whether the disk information is correct.

+

400

+

BMS.0104

+

The data volume cannot be attached to the mount point of the system volume.

+

Attach volume %s fail, data volume can not attach in root volume device.

+

Select another mount point.

+

400

+

BMS.0105

+

The mount point is invalid.

+

Attach volume %s fail, device is illegal.

+

Check whether the mount point is valid.

+

400

+

BMS.0106

+

The AZ of data disks is different from that of the BMS.

+

Attach volume %s fail, volume's az is not equal with server's az.

+

Ensure that the AZ of data disks is the same as that of the BMS.

+

400

+

BMS.0108

+

The system disk does not match the BMS.

+

Attach volume %s fail, root volume does not match the VM, do not change image.

+

Attach a matching system disk to the BMS.

+

400

+

BMS.1001

+

This operation can be performed only when the BMS is in running or stopped.

+

Volume can only be attached when server %s stopped or active.

+

Try again later or contact technical support.

+

400

+

BMS.1002

+

The number of data disks that can be attached to the BMS exceeds the quota.

+

Attach volume fail, server %s attachment num over limit.

+

Contact technical support.

+

400

+

BMS.1003

+

The disk status is invalid.

+

Attach shareable volume %s fail, volume status is %s, not available or inuse.

+

Check whether the disk is in attached or other unavailable status.

+

400

+

BMS.1004

+

The number of shared data disks that can be attached to the BMS exceeds the quota.

+

Attach shareable volume %s fail, volume status is %s, not available or inuse.

+

Contact technical support.

+

400

+

BMS.1006

+

The running status of the BMS cannot be obtained.

+

Server %s info is null or its status or its metadata is null.

+

Try again later or contact technical support.

+

400

+

BMS.1007

+

Failed to call the API.

+

Calling interface failed

+

See the returned error message or contact technical support.

+

400

+

BMS.1008

+

The disk type does not match the BMS.

+

The server[%s] is not HANA server, volume[%s] does not match the server.

+

Check whether the disk type matches the BMS or contact the technical support.

+

400

+

BMS.1009

+

The data disk has been attached to the BMS.

+

Attach shareable volume %s fail, volume status is %s, the volume has been attached to the server.

+

Select another data disk.

+

400

+

BMS.1011

+

The data disk is being attached.

+

Attach shareable volume %s fail, volume status is %s, not available or inuse.

+

Do not repeatedly attach the data disk.

+

400

+

BMS.3001

+

Failed to query the security group or subnet.

+

Query security group failed: %s.

+

or

+

Query vpcId for subnet failed: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.3011

+

System error.

+

Decoded token is null.

+

See the returned error message or contact technical support.

+

400

+

BMS.3025

+

The EVS disk type is incorrect.

+

Not support create shareable data volumes.

+

See the returned error message or contact technical support.

+

400

+

BMS.3035

+

No matching disk is found for the BMS.

+

Attach volume fail: the bmsid [%s] in volume metadata is not the same with bmsid [%s] in url.

+

Ensure that the disk matches the BMS or contact technical support.

+

400

+

BMS.3039

+

Failed to verify password complexity.

+

The password is illegal, reason: %s.

+

See the password rules.

+

400

+

BMS.0246

+

Failed to query the VPC.

+

The vpcId[%s] is invalid or not-existing.

+

See the returned error message or contact technical support.

+

400

+

BMS.0201

+

The parameters for creating the BMS are incorrectly configured.

+

Fail to check the baremetal server params, reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0202

+

The data disk type is invalid.

+

All volumes must be in same type.

+

See the returned error message or contact technical support.

+

400

+

BMS.0203

+

Parameter Volume is invalid.

+

Volume is illegal, %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0204

+

The number of data disks exceeds the upper limit.

+

The number of data volumes is illegal. The number is %d, but maximum number allow is %d.

+

See the returned error message or contact technical support.

+

400

+

BMS.0205

+

The BMS quantity is invalid.

+

The number of baremetal servers is out of range for one quest.

+

Change or delete the BMS quantity.

+

400

+

BMS.0206

+

Invalid name.

+

The length of baremetal server name[%s] is %s.

+

Change the name as required.

+

400

+

BMS.0207

+

No IP address can be specified when BMSs are created in a batch.

+

VPC is illegal, reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0208

+

Failed to query the AZ.

+

Fail to get RegionInfo by tenant [%s], reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0210

+

The length of the injected data exceeds the upper limit.

+

The size of userdata [%d] is over quota limits [%d].

+

Modify the injected data.

+

400

+

BMS.0211

+

Invalid key.

+

The image platform is [%s], support publicKey, reason: the publicKey is illegal, null is not allowed.

+

Select a valid key.

+

400

+

BMS.0114

+

The disk to be detached is not in the disk list of the BMS.

+

Volume %s is not in server %s attach volume list.

+

Check whether the disk exists.

+

400

+

BMS.0212

+

The system is overloaded.

+

System is overloaded, please try again later.

+

Try again later.

+

400

+

BMS.0213

+

Insufficient permission.

+

OBTAZ role verify fail: not allowed role.

+

See the returned error message or contact technical support.

+

400

+

BMS.0214

+

Failed to query the NIC.

+

Query subnet[%s] failed: response is null.

+

See the returned error message or contact technical support.

+

400

+

BMS.0215

+

Failed to create the order.

+

The response of inquiry order info is null or invalid.

+

See the returned error message or contact technical support.

+

400

+

BMS.0216

+

Failed to submit the order.

+

Submit order[%s] failed: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0217

+

Failed to verify metadata.

+

Create server fail, reason: metaData is illegal.

+

See the returned error message or contact technical support.

+

400

+

BMS.0222

+

The primary NIC cannot be deleted.

+

primary port can not be deleted.

+

See the returned error message or contact technical support.

+

400

+

BMS.0223

+

Currently, only SCSI disks are supported.

+

Only SCSI disks are supported.

+

Select the SCSI disk type.

+

400

+

BMS.0039

+

The BMS has been shut down.

+

Server is stopped, not allow to stop.

+

Do not stop the BMS again.

+

400

+

BMS.0040

+

The BMS does not exist.

+

The server does not exist.

+

See the returned error message or contact technical support.

+

400

+

BMS.0035

+

The BMS is being powered on and no other operations are allowed.

+

Server is powering on, not allow to %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0036

+

The BMS is being powered off and no other operations are allowed.

+

Server is powering off, not allow to %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0038

+

The BMS is running and cannot be started.

+

Server is running, not allow to start.

+

See the returned error message or contact technical support.

+

400

+

BMS.0037

+

The BMS is being restarted and no other operations are allowed.

+

Server is rebooting, not allow to %s.

+

See the returned error message or contact technical support.

+

403

+

BMS.0288

+

You do not have permissions to perform this operation.

+

Policy doesn't allow %s to be performed.

+

See the returned error message or contact technical support.

+

400

+

BMS.0290

+

The disk is not a shared disk and cannot be attached to multiple BMSs.

+

Batch attach volume type must be sharable.

+

Select a shared disk.

+

400

+

BMS.0071

+

If an EIP has been specified for creating the BMS, no other EIP can be created for the BMS.

+

Using an existing EIP and creating a new EIP can't be used at the same time.

+

See the returned error message or contact technical support.

+

400

+

BMS.0072

+

An EIP cannot be used to create multiple BMSs.

+

An existing EIP cannot be assigned to the ECSs created in batches.

+

See the returned error message or contact technical support.

+

400

+

BMS.0073

+

The bandwidth parameter is empty.

+

Bandwidth info in eip is null.

+

See the returned error message or contact technical support.

+

400

+

BMS.0074

+

The EIP extension parameter is unavailable.

+

Parameter exetendparam or chargingMode is null.

+

See the returned error message or contact technical support.

+

400

+

BMS.0075

+

The bandwidth ID is empty.

+

Bandwidth info in eip is null.

+

See the returned error message or contact technical support.

+

400

+

BMS.0077

+

Invalid bandwidth size.

+

PublicIp parameter is illegal, reason: %s.

+

See the returned error message or contact technical support.

+

400

+

BMS.0078

+

EIP quota is insufficient.

+

Shared bandwidth has been bound to %d EIPs, quota is %d.

+

See the returned error message or contact technical support.

+

400

+

BMS.0079

+

The EIP bandwidth type is unavailable.

+

Specifies the bandwidth of the shared type and the id cannot be empty.

+

See the returned error message or contact technical support.

+

400

+

BMS.0080

+

The subnet status is unavailable.

+

Check subnet status failed.

+

Check whether the subnet exists or whether it is in ACTIVE state.

+

400

+

BMS.0297

+

The submitted EVS disk order has not been paid. The EVS disk cannot be attached to or detached from the BMS.

+

Fail to attach volume[%s]: volume is locked.

+

See the returned error message or contact technical support.

+

400

+

BMS.0054

+

Failed to verify the capacity.

+

Check capacity fail, the number of capacity is: [%d], and req num is: [%d].

+

The capacity is insufficient. Contact technical support.

+

400

+

BMS.0055

+

Failed to query the quota.

+

Query capacity fail, Flavor id is [%s], reason: [%s].

+

See the returned error message or contact technical support.

+

400

+

BMS.3037

+

Insufficient resources or failed to start the BMS.

+

Insufficient resources or failed to start the BMS.

+

Contact technical support.

+

400

+

BMS.3004

+

Failed to create the BMS due to an internal system error.

+

Failed to create the BMS due to an internal system error.

+

Contact technical support.

+

400

+

BMS.3005

+

Failed to create the port.

+

Failed to create the port.

+

Contact technical support.

+

400

+

BMS.3033

+

Failed to create the system disk.

+

Failed to create the system disk.

+

Contact technical support.

+

400

+

BMS.3029

+

Failed to create the system disk. The disk status is abnormal.

+

Failed to create the system disk. The disk status is abnormal.

+

Contact technical support.

+

400

+

BMS.3006

+

Failed to assign the EIP.

+

Failed to assign the floating IP address.

+

Contact technical support.

+

400

+

BMS.3021

+

Failed to create the data disk.

+

Failed to create the data disk.

+

Contact technical support.

+

400

+

BMS.3019

+

Failed to attach the data disk.

+

Failed to attach the data disk.

+

Contact technical support.

+

400

+

BMS.3038

+

Failed to assign an EIP.

+

Failed to assign the EIP.

+

Contact technical support.

+

400

+

BMS.0315

+

Disks cannot be attached to a BMS using this flavor.

+

Disks cannot be attached to a BMS using this flavor[%s].

+

See the returned error message or contact technical support.

+

400

+

BMS.0360

+

The disk has been frozen and cannot be operated for the BMS.

+

This operation cannot be performed because EVS Disk %s is frozen.

+

See the returned error message or contact technical support.

+

400

+

BMS.3026

+

The password does not meet requirements.

+

Password does not meet the requirements of the rule.

+

See the returned error message or contact technical support.

+

400

+

BMS.3027

+

Invalid VPC parameters.

+

VPC parameter is illegal.

+

See the returned error message or contact technical support.

+

400

+

BMS.3028

+

Disk quota is abnormal.

+

cinder quota check fail.

+

See the returned error message or contact technical support.

+

400

+

Common.0018

+

tenant_id in the token is different from that in the URL.

+

tenantId in token is not the same with in URL.

+

Check whether the tenant token is correct.

+

400

+

BMS.0111

+

Password or key pair is not specified, or both specified.

+

none or multiple passwords specified, please specify one.

+

The password and key pair cannot be specified at the same time. Select one of them based on the login mode.

+

400

+

BMS.0395

+

Windows BMSs do not support remote login.

+

The server[%s] is windows system and can not support remote login.

+

See the returned error message or contact technical support.

+
+
+
+
+
+
+
Parent topic: Public Parameters
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0114885743.html b/docs/bms/api-ref/en-us_topic_0114885743.html new file mode 100644 index 000000000..f3dd14101 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0114885743.html @@ -0,0 +1,123 @@ + + +

Querying Details About extra_specs Parameters of a BMS Flavor (Native OpenStack API)

+

Function

extra_specs parameters specify the key-value pair of a BMS flavor. For example, baremetal:extBootType specifies the boot device of the BMS. Its value can be LocalDisk (local disk) or Volume (EVS disk). If you want to check whether a flavor supports quick provisioning, you can call this API.

+
+

URI

GET /v2.1/{project_id}/flavors/{flavor_id}/os-extra_specs

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

For how to obtain the project ID, see Obtaining Required Information.

+

flavor_id

+

Yes

+

Specifies the flavor ID.

+

You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.

+
+
+
+

Request

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/flavors/physical.s2.medium/os-extra_specs
+
    +
    +
+
+

Response

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    extra_specs

    +

    Object

    +

    Specifies the key-value pair of a BMS flavor.

    +
    • capabilities:cpu_arch: specifies the CPU architecture of the BMS. The value can be x86_64 (for x86 servers) or aarch64 (for ARM servers).
    • baremetal:disk_detail: specifies the disk description.
    • capabilities:hypervisor_type: specifies the hypervisor type. The value is fixed at ironic.
    • baremetal:__support_evs: specifies whether to support EVS disks. The value can be true or false. If the flavor does not contain this parameter, EVS disks are not supported either.
    • baremetal:extBootType: specifies the boot device of the BMS. The value can be LocalDisk (local disk) or Volume (EVS disk).
    • baremetal:net_num: specifies the number of NICs that can be attached to a BMS.
    • baremetal:netcard_detail: specifies description of the NIC.
    • baremetal:cpu_detail: specifies description of the CPU.
    • resource_type: specifies the resource type. The value is fixed at ironic.
    • baremetal:memory_detail: specifies description of the memory.
    +
    +
    +
+
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
    {
+    "extra_specs": {
+        "capabilities:cpu_arch": "x86_64",
+        "baremetal:disk_detail": "SAS 8T",
+        "capabilities:hypervisor_type": "ironic",
+        "baremetal:__support_evs": "true",
+        "baremetal:extBootType": "LocalDisk",
+        "capabilities:board_type": "s2m",
+        "baremetal:net_num": "2",
+        "baremetal:netcard_detail": "2*10GE",
+        "baremetal:cpu_detail": "2*8coreIntel Xeon E5-2667 V43.2GHz",
+        "resource_type": "ironic",
+        "baremetal:memory_detail": "256GB DDR4 RAM(GB)"
+    }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: BMS Flavor Query
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0131054288.html b/docs/bms/api-ref/en-us_topic_0131054288.html new file mode 100644 index 000000000..9de14e2cd --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131054288.html @@ -0,0 +1,73 @@ + + +

Change History

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

Released On

+

Description

+

2021-10-30

+

Modified the following content:

+

Optimized the descriptions for some APIs.

+

2019-04-25

+

Modified the following content:

+

Added response parameters in Querying API Versions (Native OpenStack API) and Querying an API Version (Native OpenStack API).

+

2019-01-30

+

Modified the following content:

+ +

2018-10-15

+

Added the following content:

+

API Version Query

+

2018-05-30

+

Modified the following content:

+

Adjusted the outline.

+

2018-03-30

+

Modified the following content:

+ +

2018-02-07

+

Accepted in OTC 3.0.

+

2017-11-30

+

Modified the following content:

+

Changed availability_zone to a mandatory field in section Creating a BMS (Native OpenStack API).

+

2017-08-30

+

Modified the following content:

+ +

2017-05-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0134720581.html b/docs/bms/api-ref/en-us_topic_0134720581.html new file mode 100644 index 000000000..6eba5551b --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0134720581.html @@ -0,0 +1,17 @@ + + +

API Version Query

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0134720582.html b/docs/bms/api-ref/en-us_topic_0134720582.html new file mode 100644 index 000000000..442b8e317 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0134720582.html @@ -0,0 +1,150 @@ + + +

Querying API Versions (Native OpenStack API)

+

Function

This interface is used to query all available Nova versions.

+
+

URI

GET /

+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/
+
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    versions

    +

    Array of objects

    +

    Specifies the list of all API versions.

    +

    id

    +

    String

    +

    Specifies the version ID, for example, v1.

    +

    links

    +

    Array of objects

    +

    Specifies the API URL.

    +

    href

    +

    String

    +

    Specifies the reference address of the current API version.

    +

    rel

    +

    String

    +

    Specifies the relationship between the current API version and the referenced address.

    +

    version

    +

    String

    +

    If the APIs of this version support minor versions, set this parameter to the maximum minor version supported. If not, leave this parameter blank.

    +

    status

    +

    String

    +

    Specifies the version status. Possible values are as follows:

    +
    • CURRENT: indicates a primary version.
    • SUPPORTED: indicates an old version that is still supported.
    • DEPRECATED: indicates a deprecated version which may be deleted later.
    +

    updated

    +

    String

    +

    Specifies the version release time, which must be the UTC time.

    +

    For example, the release time of v1 is 2014-06-28T12:20:21Z.

    +

    min_version

    +

    String

    +

    If the APIs of this version support minor versions, set this parameter to the supported minimum minor version. If not, leave this parameter blank.

    +
    +
    +
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
    {
+    "versions": [
+        {
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "https://192.168.82.231:443/v2/"
+                }
+            ],
+            "id": "v2.0",
+            "updated": "2018-09-21T12:33:21Z",
+            "status": "SUPPORTED"
+        }
+    ]
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: API Version Query
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0134720583.html b/docs/bms/api-ref/en-us_topic_0134720583.html new file mode 100644 index 000000000..1f91f8937 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0134720583.html @@ -0,0 +1,192 @@ + + +

Querying an API Version (Native OpenStack API)

+

Function

This API is used to query a specified API version.

+
+

URI

GET /{api_version}

+

Table 1 lists the parameters.

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

Parameter

+

Mandatory

+

Description

+

api_version

+

Yes

+

Specifies the API version, for example v2.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    1
    GET https://{ECS Endpoint}/v2
+
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    version

    +

    Object

    +

    Specifies a specified version.

    +

    id

    +

    String

    +

    Specifies the version ID, for example, v1.

    +

    links

    +

    Array of objects

    +

    Specifies the API URL.

    +

    href

    +

    String

    +

    Specifies the reference address of the current API version.

    +

    rel

    +

    String

    +

    Specifies the relationship between the current API version and the referenced address.

    +

    version

    +

    String

    +

    If the APIs of this version support minor versions, set this parameter to the maximum minor version supported. If not, leave this parameter blank.

    +

    status

    +

    String

    +

    Specifies the version status. Possible values are as follows:

    +
    • CURRENT: indicates a primary version.
    • SUPPORTED: indicates an old version that is still supported.
    • DEPRECATED: indicates a deprecated version which may be deleted later.
    +

    updated

    +

    String

    +

    Specifies the version release time, which must be the UTC time.

    +

    For example, the release time of v1 is 2014-06-28T12:20:21Z.

    +

    min_version

    +

    String

    +

    If the APIs of this version support minor versions, set this parameter to the supported minimum minor version. If not, leave this parameter blank.

    +
    +
    +
  • Example response
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
    {
+    "version": {
+        "min_version": "",
+        "media-types": [
+            {
+                "type": "application/vnd.openstack.compute+json;version=2",
+                "base": "application/json"
+            }
+        ],
+        "links": [
+            {
+                "rel": "self",
+                "href": "https://ecs.service.domain.com:443/v2/"
+            },
+            {
+                "rel": "describedby",
+                "href": "http://docs.openstack.org/",
+                "type": "text/html"
+            }
+        ],
+        "id": "v2.0",
+        "updated": "1999-02-20T11:33:21Z",
+        "version": "",
+        "status": "SUPPORTED"
+    }
+}
+
    +
    +
+
+

Returned Values

Normal values +
+ + + + + + + +

Returned Values

+

Description

+

200

+

The request has been successfully processed.

+
+
+
+

For details about other returned values, see Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: API Version Query
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0143138428.html b/docs/bms/api-ref/en-us_topic_0143138428.html new file mode 100644 index 000000000..49361d956 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0143138428.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 using JSON messages, with the media type represented by Application/json.

+

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

+
+ diff --git a/docs/bms/api-ref/en-us_topic_0171226370.html b/docs/bms/api-ref/en-us_topic_0171226370.html new file mode 100644 index 000000000..18315eba6 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0171226370.html @@ -0,0 +1,31 @@ + + +

Native OpenStack Nova V2.1 APIs

+
+
+ +
+ diff --git a/docs/bms/api-ref/en-us_topic_0171226371.html b/docs/bms/api-ref/en-us_topic_0171226371.html new file mode 100644 index 000000000..e51178786 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0171226371.html @@ -0,0 +1,12 @@ + + +

API Use Instructions

+
  • BMS does not have independent endpoints. When API calls are made to the BMS service, ECS APIs are used. Therefore, ensure that you use the ECS service endpoints when you make calls to the BMS service APIs.
  • For details about network service APIs, see Virtual Private Cloud API Reference.
  • To support function extension, Nova APIs can be distinguished by version. There are two types of versions:
    • Major version: independent URL
    • Microversion: Used by the HTTP request header X-OpenStack-Nova-API-Version. Since microversion 2.27, the new microversion header OpenStack-API-Version has been supported.
    +
+
+
+
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/en-us_topic_0173933989.html b/docs/bms/api-ref/en-us_topic_0173933989.html new file mode 100644 index 000000000..2be23a538 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0173933989.html @@ -0,0 +1,21 @@ + + +

BMS Metadata Management

+
+
+ + +
+
Parent topic: Native OpenStack Nova V2.1 APIs
+
+
+ diff --git a/docs/bms/api-ref/public_sys-resources/ExpandCollapse.js b/docs/bms/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 000000000..116ddaabf --- /dev/null +++ b/docs/bms/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/bms/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/bms/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/bms/api-ref/public_sys-resources/commonltr_print.css b/docs/bms/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 000000000..a59823141 --- /dev/null +++ b/docs/bms/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/bms/api-ref/public_sys-resources/commonrtl.css b/docs/bms/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 000000000..f261da752 --- /dev/null +++ b/docs/bms/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/bms/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/bms/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/bms/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/bms/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/bms/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/bms/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/bms/api-ref/public_sys-resources/icon-danger.gif b/docs/bms/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/bms/api-ref/public_sys-resources/icon-huawei.gif b/docs/bms/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/bms/api-ref/public_sys-resources/icon-notice.gif b/docs/bms/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/bms/api-ref/public_sys-resources/icon-tip.gif b/docs/bms/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/bms/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/bms/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/bms/api-ref/public_sys-resources/pygments.css b/docs/bms/api-ref/public_sys-resources/pygments.css new file mode 100644 index 000000000..53c536579 --- /dev/null +++ b/docs/bms/api-ref/public_sys-resources/pygments.css @@ -0,0 +1 @@ +.hll{background-color:#ffc}.c{color:#069;font-style:italic}.err{color:black}.k{color:#069;font-weight:bold}.ch{color:#069;font-style:italic}.cm{color:#008200}.cp{color:black}.cpf{color:#069;font-style:italic}.c1{color:#008200}.cs{color:#069;font-weight:bold}.gd{color:#000;background-color:#fdd}.ge{font-style:italic}.gr{color:#a00}.gh{color:#999}.gi{color:#000;background-color:#dfd}.go{color:#888}.gp{color:#555}.gs{font-weight:bold}.gu{color:#aaa}.gt{color:#a00}.kc{color:#000080;font-weight:bold}.kd{color:#069;font-weight:bold}.kn{color:#000080;font-weight:bold}.kp{color:#069;font-weight:bold}.kr{color:#000080;font-weight:bold}.kt{color:#069;font-weight:bold}.m{color:blue}.s{color:blue}.na{color:gray}.nt{color:#069;font-weight:bold}.ow{font-weight:bold}.w{color:#bbb}.mb{color:blue}.mf{color:blue}.mh{color:blue}.mi{color:black}.mo{color:blue}.sa{color:blue}.sb{color:blue}.sc{color:#800080}.dl{color:blue}.sd{color:blue}.s2{color:blue}.se{color:blue}.sh{color:blue}.si{color:blue}.sx{color:blue}.sr{color:blue}.s1{color:blue}.ss{color:blue}.il{color:blue}.linenos{width:15px}.linenos{border-right:3px solid #6ce26c;color:#afafaf;text-align:right;padding:0 .5em 0 1em}.codecoloring{line-height:1.1em}.code,.highlight pre{font-family:"Consolas","Bitstream Vera Sans Mono","Courier New",Courier,monospace}.code,.highlight pre span{font-size:1em}.nb{color:#ff1493}.nv{color:#a70}.nx,.o,.n,.nf{color:black}.vc,.vi{color:#a70}.code,.highlight pre{padding:0 1em}.highlighttable pre{box-sizing:border-box;margin:0} \ No newline at end of file diff --git a/docs/bms/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/bms/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