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:

+ +
+

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

+
+

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

+
+

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

+
+

Response

+
+

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

+
+

Response

+ +
+

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

+
+

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

+
+

Response

+ +
+

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

+
+

Response

+ +
+

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

+
+

Response

+ +
+

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

+
+

Response

+ +
+

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

+
+

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

+
+

Response

+ +
+

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

+
+

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

+ +
+

Response

+ +
+

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

+
+

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

+
+

Response

+ +
+

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

+
+

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

+ +
+

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

+
+

Response

+ +
+

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

+
+
+
+
+
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

+
+

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

+
+

Response

+ +
+

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

+ +
+

Response

+
+

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

+
+

Response

+ +
+

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

+
+

Response

+ +
+

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

+ +
+

Response

+ +
+

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.

+
+ +

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

+ +
+

Response

+
+

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

+
+

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

+ +
+

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

+
+

Response

+ +
+

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

+
+

Response

+
+

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

+ +
+

Response

+ +
+

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

+
+

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

+
+

Response

+
+

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

+
+

Response

+ +
+

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

+
+

Response

+ +
+

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

+
+

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

+

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

+
+

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

+
+

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

+
  • 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

+
+

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

+
+

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

+
+

Response

+ +
+

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

+
+

Response Message

+
+

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

+
+

Response Message

+
+

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

+
+
+
+
+
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 000000000..60f607621 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/bms/api-ref/public_sys-resources/commonltr.css b/docs/bms/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 000000000..c5480b0ab --- /dev/null +++ b/docs/bms/api-ref/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.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:.6em;margin-bottom:.6em}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}.notice p{margin-top:.5em;margin-bottom:.5em}.warning 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}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.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}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}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}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}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}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.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:.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 000000000..47a9c7235 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/bms/api-ref/public_sys-resources/delta.gif b/docs/bms/api-ref/public_sys-resources/delta.gif new file mode 100644 index 000000000..0d1b1f674 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/bms/api-ref/public_sys-resources/deltaend.gif b/docs/bms/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 000000000..cc7da0fc8 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/deltaend.gif differ 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 000000000..84eec9be2 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/icon-arrowdn.gif differ 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 000000000..39583d168 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/bms/api-ref/public_sys-resources/icon-caution.gif b/docs/bms/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/icon-caution.gif differ 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 000000000..079c79b26 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/icon-danger.gif differ 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 000000000..a31d60f89 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/bms/api-ref/public_sys-resources/icon-note.gif b/docs/bms/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 000000000..31be2b039 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/icon-note.gif differ 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 000000000..409070650 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/icon-notice.gif differ 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 000000000..c47bae05c Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/bms/api-ref/public_sys-resources/icon-warning.gif b/docs/bms/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/icon-warning.gif differ 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 000000000..57a0e1f53 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/bms/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/bms/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 000000000..fa4b64990 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/bms/api-ref/public_sys-resources/popup.js b/docs/bms/api-ref/public_sys-resources/popup.js new file mode 100644 index 000000000..a550862ed --- /dev/null +++ b/docs/bms/api-ref/public_sys-resources/popup.js @@ -0,0 +1 @@ +var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=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 000000000..def5c3565 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/warning_3.0-en-us.png differ