forked from docs/doc-exports
wanghuijuan738
69783f9e3e
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Co-authored-by: wanghuijuan738 <wanghuijuan738@huawei.com> Co-committed-by: wanghuijuan738 <wanghuijuan738@huawei.com>
857 lines
34 KiB
JSON
857 lines
34 KiB
JSON
[
|
|
{
|
|
"desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ",
|
|
"product_code":"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":"BMS APIs",
|
|
"uri":"en-us_topic_0060602044.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"desc":"For details about network service APIs, see Virtual Private Cloud API Reference.When using BMS APIs, you need to use endpoints. For details, see Regions and Endpoints.Whe",
|
|
"product_code":"bms",
|
|
"title":"API Instructions",
|
|
"uri":"en-us_topic_0131668048.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_0132973615.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"4"
|
|
},
|
|
{
|
|
"desc":"This API is used to query all available API versions of the BMS service.GET /NoneQuerying all available API versionsGET https://{BMS Endpoint}/Normal valuesReturned Value",
|
|
"product_code":"bms",
|
|
"title":"Querying API Versions",
|
|
"uri":"en-us_topic_0132973804.html",
|
|
"doc_type":"api",
|
|
"p_code":"4",
|
|
"code":"5"
|
|
},
|
|
{
|
|
"desc":"This API is used to query a specified API version of the BMS service.GET /{api_version}Table 1 lists the parameters.Parameter descriptionParameterMandatoryDescriptionapi_",
|
|
"product_code":"bms",
|
|
"title":"Querying an API Version",
|
|
"uri":"en-us_topic_0132973805.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_0113746488.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"7"
|
|
},
|
|
{
|
|
"desc":"This API is used to create one or multiple BMSs.Logging in to a BMS can be authenticated using either a key pair or password. For security purposes, you are advised to us",
|
|
"product_code":"bms",
|
|
"title":"Creating BMSs",
|
|
"uri":"en-us_topic_0106040941.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"8"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete specified BMSs in a batch or one by one.This API can only be used to delete pay-per-use BMSs.POST /v1/{project_id}/baremetalservers/deleteTable",
|
|
"product_code":"bms",
|
|
"title":"Deleting BMSs",
|
|
"uri":"en-us_topic_0191726734.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"desc":"This API is used to query details about a BMS.GET /v1/{project_id}/baremetalservers/{server_id}Table 1 lists the parameters.NoneQuerying details about a BMS (ID: 53206ed0",
|
|
"product_code":"bms",
|
|
"title":"Querying Details About a BMS",
|
|
"uri":"en-us_topic_0113746489.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"desc":"This API is used to query BMSs by filters and display details about the BMSs.The information that can be queried includes the BMS billing mode and whether the BMS is froz",
|
|
"product_code":"bms",
|
|
"title":"Querying Details About BMSs",
|
|
"uri":"en-us_topic_0129082263.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"11"
|
|
},
|
|
{
|
|
"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_0113746490.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the name of a BMS.The new name must meet the following requirements:Contain 1 to 63 characters, consisting of letters (case-insensitive), digit",
|
|
"product_code":"bms",
|
|
"title":"Changing a BMS Name",
|
|
"uri":"en-us_topic_0107654006.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"This API is used to reinstall the BMS OS. The OS of BMSs supporting quick provisioning can be reinstalled using the original image without any change to the data disks. P",
|
|
"product_code":"bms",
|
|
"title":"Reinstalling a BMS OS",
|
|
"uri":"en-us_topic_0126150310.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"This API is used to start BMSs of specified IDs. You can start a maximum of 1000 BMSs at a time.This is an asynchronous API. Calling the API successfully indicates that t",
|
|
"product_code":"bms",
|
|
"title":"Starting BMSs",
|
|
"uri":"en-us_topic_0131356391.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"This API is used to restart BMSs of specified IDs. You can restart a maximum of 1000 BMSs at a time.This is an asynchronous API. Calling the API successfully indicates th",
|
|
"product_code":"bms",
|
|
"title":"Restarting BMSs",
|
|
"uri":"en-us_topic_0131356392.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"This API is used to stop BMSs of specified IDs. You can stop a maximum of 1000 BMSs at a time.This is an asynchronous API. Calling the API successfully indicates that the",
|
|
"product_code":"bms",
|
|
"title":"Stopping BMSs",
|
|
"uri":"en-us_topic_0131356393.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"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_0131703308.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"en-us_topic_0131703289.html",
|
|
"doc_type":"api",
|
|
"p_code":"18",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"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_0131036397.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"desc":"This API is used to query information about NICs bound to a BMS, such as the IP address and MAC address of each NIC.GET /v1/{project_id}/baremetalservers/{server_id}/os-i",
|
|
"product_code":"bms",
|
|
"title":"Querying NICs Bound to a BMS",
|
|
"uri":"en-us_topic_0131036398.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"desc":"This API is used to bind one or more NICs to a BMS.POST /v1/{project_id}/baremetalservers/{server_id}/nicsTable 1 lists the parameters.Binding a NIC (subnet ID: d32019d3-",
|
|
"product_code":"bms",
|
|
"title":"Binding NICs to a BMS",
|
|
"uri":"en-us_topic_0229339177.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"This API is used to unbind one or more NICs from a BMS.The primary NIC of a BMS has routing rules configured and cannot be unbound.POST /v1/{project_id}/baremetalservers/",
|
|
"product_code":"bms",
|
|
"title":"Unbinding NICs from a BMS",
|
|
"uri":"en-us_topic_0229339178.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"This API is used to specify whether to delete a NIC when the BMS is deleted or the NIC is unbound.PUT /v1/{project_id}/baremetalservers/{server_id}/os-interface/{port_id}",
|
|
"product_code":"bms",
|
|
"title":"Modifying Attributes of a BMS NIC",
|
|
"uri":"en-us_topic_0229339179.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"24"
|
|
},
|
|
{
|
|
"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_0113746491.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"This API is used to attach EVS disks to a BMS as data disks after the BMS is created if existing data disks are insufficient or cannot meet requirements.EVS disks cannot ",
|
|
"product_code":"bms",
|
|
"title":"Attaching an EVS Disk to a BMS",
|
|
"uri":"en-us_topic_0107658564.html",
|
|
"doc_type":"api",
|
|
"p_code":"25",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"desc":"This API is used to detach a disk from a BMS.A disk attached to /dev/sda functions as the system disk. You can only detach the system disk from a stopped BMS.Disks attach",
|
|
"product_code":"bms",
|
|
"title":"Detaching an EVS Disk from a BMS",
|
|
"uri":"en-us_topic_0107658627.html",
|
|
"doc_type":"api",
|
|
"p_code":"25",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"desc":"This API is used to query EVS disks attached to a BMS.GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachmentsTable 1 lists the parameters.Parameter descri",
|
|
"product_code":"bms",
|
|
"title":"Querying EVS Disks Attached to a BMS",
|
|
"uri":"en-us_topic_0130145446.html",
|
|
"doc_type":"api",
|
|
"p_code":"25",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"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 Password Management",
|
|
"uri":"en-us_topic_0131629814.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"29"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the random password of the administrator (account Administrator or an account configured using Cloudbase-Init) generated by the system during th",
|
|
"product_code":"bms",
|
|
"title":"Obtaining the Password of a Windows BMS",
|
|
"uri":"en-us_topic_0131629816.html",
|
|
"doc_type":"api",
|
|
"p_code":"29",
|
|
"code":"30"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete the random password generated during initial Windows BMS installation. After the password is deleted, you can still use your password to log in",
|
|
"product_code":"bms",
|
|
"title":"Deleting the Password of a Windows BMS",
|
|
"uri":"en-us_topic_0131629817.html",
|
|
"doc_type":"api",
|
|
"p_code":"29",
|
|
"code":"31"
|
|
},
|
|
{
|
|
"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 Quota Management",
|
|
"uri":"en-us_topic_0131920832.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"32"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the quotas of all resources for a specified tenant, including used quotas.GET /v1/{project_id}/baremetalservers/limitsTable 1 lists the paramete",
|
|
"product_code":"bms",
|
|
"title":"Querying Tenant Quotas",
|
|
"uri":"en-us_topic_0131920833.html",
|
|
"doc_type":"api",
|
|
"p_code":"32",
|
|
"code":"33"
|
|
},
|
|
{
|
|
"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 Management",
|
|
"uri":"en-us_topic_0131326851.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"34"
|
|
},
|
|
{
|
|
"desc":"This API is used to query BMS flavor details and extended flavor information. You can call this API to query the value of parameter baremetal:extBootType to check whether",
|
|
"product_code":"bms",
|
|
"title":"Querying Flavor Details and Extended Flavor Information",
|
|
"uri":"en-us_topic_0131326852.html",
|
|
"doc_type":"api",
|
|
"p_code":"34",
|
|
"code":"35"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"bms",
|
|
"title":"Task Management",
|
|
"uri":"en-us_topic_0118683801.html",
|
|
"doc_type":"api",
|
|
"p_code":"2",
|
|
"code":"36"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the execution status of a task.Ater an asynchronous API is called, for example an API for creating BMSs or attaching or detaching disks, job_id ",
|
|
"product_code":"bms",
|
|
"title":"Querying Task Statuses",
|
|
"uri":"en-us_topic_0118696596.html",
|
|
"doc_type":"api",
|
|
"p_code":"36",
|
|
"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":"Native OpenStack Nova V2.1 APIs",
|
|
"uri":"en-us_topic_0171226370.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"38"
|
|
},
|
|
{
|
|
"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 Instructions (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002340063004.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"39"
|
|
},
|
|
{
|
|
"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 (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002374101001.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"40"
|
|
},
|
|
{
|
|
"desc":"This API is used to query all available Nova versions.GET /NoneQuerying all available API versionsGET https://{ECS Endpoint}/Normal valuesReturned ValuesDescription200The",
|
|
"product_code":"bms",
|
|
"title":"Querying API Versions",
|
|
"uri":"en-us_topic_0000002374260861.html",
|
|
"doc_type":"api",
|
|
"p_code":"40",
|
|
"code":"41"
|
|
},
|
|
{
|
|
"desc":"This API is used to query a specified API version.GET /{api_version}Table 1 lists the parameters.NoneQuerying the API v2GET https://{ECS Endpoint}/v2Normal valuesReturned",
|
|
"product_code":"bms",
|
|
"title":"Querying an API Version",
|
|
"uri":"en-us_topic_0000002340222780.html",
|
|
"doc_type":"api",
|
|
"p_code":"40",
|
|
"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 Lifecycle Management (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002340063008.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"43"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a BMS.This API cannot be used to create BMSs in a batch.When you create a BMS using an image that supports Cloud-Init or Cloudbase-Init, only p",
|
|
"product_code":"bms",
|
|
"title":"Creating a BMS",
|
|
"uri":"en-us_topic_0000002374101005.html",
|
|
"doc_type":"api",
|
|
"p_code":"43",
|
|
"code":"44"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a BMS.DELETE /v2.1/{project_id}/servers/{server_id}Table 1 lists the parameters.NoneDeleting a BMS (ID: 9ab74d89-61e7-4259-8546-465fdebe4944)DE",
|
|
"product_code":"bms",
|
|
"title":"Deleting a BMS",
|
|
"uri":"en-us_topic_0000002374260865.html",
|
|
"doc_type":"api",
|
|
"p_code":"43",
|
|
"code":"45"
|
|
},
|
|
{
|
|
"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.NoneQuerying details about a BMS ",
|
|
"product_code":"bms",
|
|
"title":"Querying Details About a BMS",
|
|
"uri":"en-us_topic_0000002340222784.html",
|
|
"doc_type":"api",
|
|
"p_code":"43",
|
|
"code":"46"
|
|
},
|
|
{
|
|
"desc":"This API is used to query BMSs.The query result returned by this API includes both ECSs and BMSs. You need to filter out the BMSs using the flavor used to create the BMSs",
|
|
"product_code":"bms",
|
|
"title":"Querying BMSs",
|
|
"uri":"en-us_topic_0000002340063012.html",
|
|
"doc_type":"api",
|
|
"p_code":"43",
|
|
"code":"47"
|
|
},
|
|
{
|
|
"desc":"This API is used to query details about BMSs.The query result returned by this API includes both ECSs and BMSs. You need to filter out the BMSs using the flavor used to c",
|
|
"product_code":"bms",
|
|
"title":"Querying Details About BMSs",
|
|
"uri":"en-us_topic_0000002374101009.html",
|
|
"doc_type":"api",
|
|
"p_code":"43",
|
|
"code":"48"
|
|
},
|
|
{
|
|
"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 (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002374260869.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"49"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify BMS information. Currently, only the name of a BMS can be changed.PUT /v2.1/{project_id}/servers/{server_id}Table 1 lists the parameters.Changi",
|
|
"product_code":"bms",
|
|
"title":"Changing the Name of a BMS",
|
|
"uri":"en-us_topic_0000002340222792.html",
|
|
"doc_type":"api",
|
|
"p_code":"49",
|
|
"code":"50"
|
|
},
|
|
{
|
|
"desc":"This API is used to start a single BMS.POST /v2.1/{project_id}/servers/{server_id}/actionTable 1 lists the parameters.Starting a BMS (ID: 95bf2490-5428-432c-ad9b-5e3406f8",
|
|
"product_code":"bms",
|
|
"title":"Starting a BMS",
|
|
"uri":"en-us_topic_0000002340063016.html",
|
|
"doc_type":"api",
|
|
"p_code":"49",
|
|
"code":"51"
|
|
},
|
|
{
|
|
"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.Rest",
|
|
"product_code":"bms",
|
|
"title":"Restarting a BMS",
|
|
"uri":"en-us_topic_0000002374101017.html",
|
|
"doc_type":"api",
|
|
"p_code":"49",
|
|
"code":"52"
|
|
},
|
|
{
|
|
"desc":"This API is used to stop a single BMS.This API has been deprecated. Use the API in Stopping BMSs.The OS-EXT-STS:vm_state attribute (BMS status) must be active or error.Cu",
|
|
"product_code":"bms",
|
|
"title":"Stopping a BMS",
|
|
"uri":"en-us_topic_0000002374260881.html",
|
|
"doc_type":"api",
|
|
"p_code":"49",
|
|
"code":"53"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the address for remotely logging in to a BMS.POST /v2.1/{project_id}/servers/{server_id}/actionTable 1 lists the parameters.Request parametersP",
|
|
"product_code":"bms",
|
|
"title":"Obtaining a Remote Login Address",
|
|
"uri":"en-us_topic_0000002340222796.html",
|
|
"doc_type":"api",
|
|
"p_code":"49",
|
|
"code":"54"
|
|
},
|
|
{
|
|
"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 (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002340063024.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"55"
|
|
},
|
|
{
|
|
"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 metadata of a BMS.",
|
|
"product_code":"bms",
|
|
"title":"Querying BMS Metadata",
|
|
"uri":"en-us_topic_0000002374101021.html",
|
|
"doc_type":"api",
|
|
"p_code":"55",
|
|
"code":"56"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"en-us_topic_0000002374260885.html",
|
|
"doc_type":"api",
|
|
"p_code":"55",
|
|
"code":"57"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify specified BMS metadata.The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, or paused.PUT /v2.1/{project_id}/servers/{se",
|
|
"product_code":"bms",
|
|
"title":"Modifying Specified BMS Metadata",
|
|
"uri":"en-us_topic_0000002340222800.html",
|
|
"doc_type":"api",
|
|
"p_code":"55",
|
|
"code":"58"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete specified BMS metadata.The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, or paused.DELETE /v2.1/{project_id}/servers/",
|
|
"product_code":"bms",
|
|
"title":"Deleting Specified BMS Metadata",
|
|
"uri":"en-us_topic_0000002340063028.html",
|
|
"doc_type":"api",
|
|
"p_code":"55",
|
|
"code":"59"
|
|
},
|
|
{
|
|
"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 (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002374101025.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"60"
|
|
},
|
|
{
|
|
"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.NoneQ",
|
|
"product_code":"bms",
|
|
"title":"Querying IP Addresses of a BMS",
|
|
"uri":"en-us_topic_0000002374260889.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"61"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"en-us_topic_0000002340222804.html",
|
|
"doc_type":"api",
|
|
"p_code":"60",
|
|
"code":"62"
|
|
},
|
|
{
|
|
"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 (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002340063032.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"63"
|
|
},
|
|
{
|
|
"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":"QueryingBMS Flavors",
|
|
"uri":"en-us_topic_0000002374101029.html",
|
|
"doc_type":"api",
|
|
"p_code":"63",
|
|
"code":"64"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"en-us_topic_0000002374260893.html",
|
|
"doc_type":"api",
|
|
"p_code":"63",
|
|
"code":"65"
|
|
},
|
|
{
|
|
"desc":"extra_specs parameters are key-value pairs of a BMS flavor. For example, baremetal:extBootType indicates the boot device of a BMS. Its value can be LocalDisk (local disk)",
|
|
"product_code":"bms",
|
|
"title":"Querying Details About extra_specs Parameters of a BMS Flavor",
|
|
"uri":"en-us_topic_0000002340222808.html",
|
|
"doc_type":"api",
|
|
"p_code":"63",
|
|
"code":"66"
|
|
},
|
|
{
|
|
"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 (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002340063036.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"67"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"en-us_topic_0000002374101033.html",
|
|
"doc_type":"api",
|
|
"p_code":"67",
|
|
"code":"68"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"en-us_topic_0000002374260897.html",
|
|
"doc_type":"api",
|
|
"p_code":"67",
|
|
"code":"69"
|
|
},
|
|
{
|
|
"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 (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002340222812.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"70"
|
|
},
|
|
{
|
|
"desc":"This API is used to query information about EVS disks attached to a BMS.GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachmentsTable 1 lists the parameters.NoneQ",
|
|
"product_code":"bms",
|
|
"title":"Querying Information About EVS Disks Attached to a BMS",
|
|
"uri":"en-us_topic_0000002340063040.html",
|
|
"doc_type":"api",
|
|
"p_code":"70",
|
|
"code":"71"
|
|
},
|
|
{
|
|
"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 an EVS Disk Attached to a BMS",
|
|
"uri":"en-us_topic_0000002374101037.html",
|
|
"doc_type":"api",
|
|
"p_code":"70",
|
|
"code":"72"
|
|
},
|
|
{
|
|
"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 PAUSED state, which ",
|
|
"product_code":"bms",
|
|
"title":"Attaching an EVS Disk to a BMS",
|
|
"uri":"en-us_topic_0000002374260901.html",
|
|
"doc_type":"api",
|
|
"p_code":"70",
|
|
"code":"73"
|
|
},
|
|
{
|
|
"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 running, the constraint",
|
|
"product_code":"bms",
|
|
"title":"Detaching an EVS Disk from a BMS",
|
|
"uri":"en-us_topic_0000002340222816.html",
|
|
"doc_type":"api",
|
|
"p_code":"70",
|
|
"code":"74"
|
|
},
|
|
{
|
|
"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 Management (Native OpenStack APIs)",
|
|
"uri":"en-us_topic_0000002340063044.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"75"
|
|
},
|
|
{
|
|
"desc":"This API is used to query SSH key pairs.Pagination query is not supported.GET /v2.1/{project_id}/os-keypairsTable 1 lists the parameters.NoneQuerying SSH key pairs in a p",
|
|
"product_code":"bms",
|
|
"title":"Querying SSH Key Pairs (Native OpenStack API)",
|
|
"uri":"en-us_topic_0000002374101041.html",
|
|
"doc_type":"api",
|
|
"p_code":"75",
|
|
"code":"76"
|
|
},
|
|
{
|
|
"desc":"This API 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.NoneQuerying d",
|
|
"product_code":"bms",
|
|
"title":"Querying an SSH Key Pair (Native OpenStack API)",
|
|
"uri":"en-us_topic_0000002374260905.html",
|
|
"doc_type":"api",
|
|
"p_code":"75",
|
|
"code":"77"
|
|
},
|
|
{
|
|
"desc":"This API is used to create an SSH key pair or import a public key to generate a key pair.After an SSH key pair is generated, download the private key to a local directory",
|
|
"product_code":"bms",
|
|
"title":"Creating or Importing an SSH Key Pair (Native OpenStack API)",
|
|
"uri":"en-us_topic_0000002340222820.html",
|
|
"doc_type":"api",
|
|
"p_code":"75",
|
|
"code":"78"
|
|
},
|
|
{
|
|
"desc":"This API 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.NoneDeleti",
|
|
"product_code":"bms",
|
|
"title":"Deleting an SSH Key Pair (Native OpenStack API)",
|
|
"uri":"en-us_topic_0000002340063048.html",
|
|
"doc_type":"api",
|
|
"p_code":"75",
|
|
"code":"79"
|
|
},
|
|
{
|
|
"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 (OpenStack Nova APIs)",
|
|
"uri":"en-us_topic_0000002374101045.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"80"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"en-us_topic_0000002374260909.html",
|
|
"doc_type":"api",
|
|
"p_code":"80",
|
|
"code":"81"
|
|
},
|
|
{
|
|
"desc":"This API is used to add tags for 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 Tags for a BMS",
|
|
"uri":"en-us_topic_0000002340222824.html",
|
|
"doc_type":"api",
|
|
"p_code":"80",
|
|
"code":"82"
|
|
},
|
|
{
|
|
"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 from a BMS",
|
|
"uri":"en-us_topic_0000002340063052.html",
|
|
"doc_type":"api",
|
|
"p_code":"80",
|
|
"code":"83"
|
|
},
|
|
{
|
|
"desc":"This API is used to add a tag for 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 ha",
|
|
"product_code":"bms",
|
|
"title":"Adding a Tag for a BMS",
|
|
"uri":"en-us_topic_0000002374101049.html",
|
|
"doc_type":"api",
|
|
"p_code":"80",
|
|
"code":"84"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"en-us_topic_0000002374260913.html",
|
|
"doc_type":"api",
|
|
"p_code":"80",
|
|
"code":"85"
|
|
},
|
|
{
|
|
"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 from a BMS",
|
|
"uri":"en-us_topic_0000002340222828.html",
|
|
"doc_type":"api",
|
|
"p_code":"80",
|
|
"code":"86"
|
|
},
|
|
{
|
|
"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":"87"
|
|
},
|
|
{
|
|
"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":"87",
|
|
"code":"88"
|
|
},
|
|
{
|
|
"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":"87",
|
|
"code":"89"
|
|
},
|
|
{
|
|
"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":"Task Responses",
|
|
"uri":"en-us_topic_0131356398.html",
|
|
"doc_type":"api",
|
|
"p_code":"87",
|
|
"code":"90"
|
|
},
|
|
{
|
|
"desc":"Normal response{ \n \"job_id\": \"70a599e0-31e7-49b7-b260-868f441e862b\" \n}Abnormal response{ \n \"error\": {\"message\": \"\", \"code\": XXX}\n}",
|
|
"product_code":"bms",
|
|
"title":"Task ID Response",
|
|
"uri":"en-us_topic_0131356399.html",
|
|
"doc_type":"api",
|
|
"p_code":"90",
|
|
"code":"91"
|
|
},
|
|
{
|
|
"desc":"Normal response{ \n \"order_id\": \"CS2009141523OQSEQ\",\n \"job_id\": \"ff808081748b760c01748b7f80370003\"\n}Abnormal response{ \n \"error\": {\"message\": \"\", \"code\": XXX}\n}",
|
|
"product_code":"bms",
|
|
"title":"Order ID Response",
|
|
"uri":"en-us_topic_0131356400.html",
|
|
"doc_type":"api",
|
|
"p_code":"90",
|
|
"code":"92"
|
|
},
|
|
{
|
|
"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":"Appendix",
|
|
"uri":"en-us_topic_0171277623.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"93"
|
|
},
|
|
{
|
|
"desc":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Obtain the Project ID by Ca",
|
|
"product_code":"bms",
|
|
"title":"Obtaining a Project ID",
|
|
"uri":"en-us_topic_0171277624.html",
|
|
"doc_type":"api",
|
|
"p_code":"93",
|
|
"code":"94"
|
|
},
|
|
{
|
|
"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":"95"
|
|
}
|
|
] |