Function
This API is used to query information about the EVS disks attached to a BMS.
+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.
@@ -26,8 +26,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0053158659.html b/docs/bms/api-ref/en-us_topic_0053158659.html index 214911e8..f8c0e549 100644 --- a/docs/bms/api-ref/en-us_topic_0053158659.html +++ b/docs/bms/api-ref/en-us_topic_0053158659.html @@ -1,7 +1,7 @@ -
1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments +
- Example request
@@ -54,7 +54,7 @@1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments
Object
Specifies information about the disks attached to the BMS. For details, see Table 2.
+Specifies information about the disks attached to the BMS. For details, see Table 2.
String
Specifies the ID of the BMS to which the disks are attached.
+Specifies the ID of the BMS to which the disks are attached.
volumeId
@@ -108,14 +108,14 @@ 5 6 7 -8{ - "volumeAttachments": { - "device": "/dev/vdb", - "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa", - "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", - "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6" - } -} +8
{ + "volumeAttachments": { + "device": "/dev/vdb", + "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa", + "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", + "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6" + } +}
Starting a BMS (Native OpenStack API)
-Function
This API is used to start a single BMS.
+Starting a BMS (Native OpenStack API)
+diff --git a/docs/bms/api-ref/en-us_topic_0060410928.html b/docs/bms/api-ref/en-us_topic_0060410928.html index 53043d49..7b18e3dc 100644 --- a/docs/bms/api-ref/en-us_topic_0060410928.html +++ b/docs/bms/api-ref/en-us_topic_0060410928.html @@ -1,10 +1,10 @@ -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.
@@ -26,8 +26,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
null
Specifies the operation of starting the BMS. The data structure is empty.
+Specifies the operation of starting the BMS. The data structure is empty.
- Example request
-1POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action +
- Example request
1POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action
diff --git a/docs/bms/api-ref/en-us_topic_0053158662.html b/docs/bms/api-ref/en-us_topic_0053158662.html index 8239988a..0c69a5c2 100644 --- a/docs/bms/api-ref/en-us_topic_0053158662.html +++ b/docs/bms/api-ref/en-us_topic_0053158662.html @@ -1,7 +1,7 @@ -1 2 -3
{ - "os-start": {} - } +3
{ + "os-start": {} + }
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.
+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.
@@ -26,15 +26,15 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
vpc_id
Yes
Specifies the ID of the VPC where the BMS is located.
+Specifies the ID of the VPC where the BMS is located.
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0053158665.html b/docs/bms/api-ref/en-us_topic_0053158665.html index 09954fbb..85429ecd 100644 --- a/docs/bms/api-ref/en-us_topic_0053158665.html +++ b/docs/bms/api-ref/en-us_topic_0053158665.html @@ -1,7 +1,7 @@ -
1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/ips/{vpc_id} +
- Example request
@@ -61,8 +61,8 @@1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/ips/{vpc_id}
Array of address objects
Specifies the network used by the BMS.
-Vpc_id: indicates the ID of the VPC used by the BMS.
+Specifies the VPC used by the BMS.
+Vpc_id indicates the ID of the VPC used by the BMS.
{ - "5849fdf1-9d79-4589-80c2-fe557990c417": [ - { - "version": 4, - "addr": "192.168.1.159" - } - ] -} +8
{ + "5849fdf1-9d79-4589-80c2-fe557990c417": [ + { + "version": 4, + "addr": "192.168.1.159" + } + ] +}
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.
+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.
@@ -26,8 +26,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
volume_id
@@ -35,7 +35,7 @@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.
+You can query attached EVS disks attached to a BMS using the Querying Information About the Disks Attached to a BMS (Native OpenStack API) API.
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0053158668.html b/docs/bms/api-ref/en-us_topic_0053158668.html index 88b9eca0..8ab9845c 100644 --- a/docs/bms/api-ref/en-us_topic_0053158668.html +++ b/docs/bms/api-ref/en-us_topic_0053158668.html @@ -1,6 +1,6 @@ -
1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments/b53f23bd-ee8f-49ec-9420-d1acfeaf91d6 +
- Example request
@@ -62,7 +62,7 @@1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-volume_attachments/b53f23bd-ee8f-49ec-9420-d1acfeaf91d6
Object
Specifies information about the disk attached to the BMS. For details, see Table 2.
+Specifies information about the disk attached to the BMS. For details, see Table 2.
String
Specifies the ID of the BMS to which the disks are attached.
+Specifies the ID of the BMS to which the disks are attached.
volumeId
@@ -116,14 +116,14 @@ 5 6 7 -8{ - "volumeAttachment": { - "device": "/dev/vdb", - "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa", - "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", - "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6" - } - } +8
{ + "volumeAttachment": { + "device": "/dev/vdb", + "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa", + "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", + "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6" + } + }
BMS Flavor Query
+BMS Flavor Query
-
diff --git a/docs/bms/api-ref/en-us_topic_0053158674.html b/docs/bms/api-ref/en-us_topic_0053158674.html
index ffc6bdbc..f174ef29 100644
--- a/docs/bms/api-ref/en-us_topic_0053158674.html
+++ b/docs/bms/api-ref/en-us_topic_0053158674.html
@@ -1,7 +1,7 @@
-
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0053158678.html b/docs/bms/api-ref/en-us_topic_0053158678.html index 195a2b15..dd64bb9f 100644 --- a/docs/bms/api-ref/en-us_topic_0053158678.html +++ b/docs/bms/api-ref/en-us_topic_0053158678.html @@ -1,7 +1,7 @@ -
1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium +
- Example request
@@ -54,7 +54,7 @@1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium
Object
Specifies the BMS flavor. For details, see Table 2.
+Specifies a BMS flavor. For details, see Table 2.
String
Specifies the BMS flavor ID.
+Specifies the BMS flavor ID.
name
String
Specifies the BMS flavor name.
+Specifies the BMS flavor name.
vcpus
Integer
Specifies the number of CPU cores in the BMS flavor.
+Specifies the number of CPU cores in the BMS flavor.
ram
Integer
Specifies the memory size (MB) in the BMS flavor.
+Specifies the memory size (MB) in the BMS flavor.
disk
Integer
Specifies the disk size (GB) in the BMS flavor.
+Specifies the disk size (GB) in the BMS flavor.
swap
@@ -200,30 +200,30 @@ 21 22 23 -24{ - "flavor": { - "name": "physical.o2.medium", - "links": [ - { - "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium", - "rel": "self" - }, - { - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium", - "rel": "bookmark" - } - ], - "ram": 192705, - "OS-FLV-DISABLED:disabled": false, - "vcpus": 24, - "swap": "", - "os-flavor-access:is_public": true, - "rxtx_factor": 1, - "OS-FLV-EXT-DATA:ephemeral": 0, - "disk": 1862, - "id": "physical.o2.medium" - } - } +24
{ + "flavor": { + "name": "physical.o2.medium", + "links": [ + { + "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium", + "rel": "self" + }, + { + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.o2.medium", + "rel": "bookmark" + } + ], + "ram": 192705, + "OS-FLV-DISABLED:disabled": false, + "vcpus": 24, + "swap": "", + "os-flavor-access:is_public": true, + "rxtx_factor": 1, + "OS-FLV-EXT-DATA:ephemeral": 0, + "disk": 1862, + "id": "physical.o2.medium" + } + }
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.
+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.
@@ -26,8 +26,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0053158679.html b/docs/bms/api-ref/en-us_topic_0053158679.html index 26aaa938..47e29f9a 100644 --- a/docs/bms/api-ref/en-us_topic_0053158679.html +++ b/docs/bms/api-ref/en-us_topic_0053158679.html @@ -1,7 +1,7 @@ -
1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface +
- Example request
@@ -54,7 +54,7 @@1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface
Array of objects
Specifies information about NICs of the BMS. For details, see Table 2.
+Specifies information about NICs of the BMS. For details, see Table 2.
{ - "interfaceAttachments": [ - { - "port_state": "ACTIVE", - "fixed_ips": [ - { - "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", - "ip_address": "192.168.1.3" - } - ], - "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", - "port_id": "ce531f90-199f-48c0-816c-13e38010b442", - "mac_addr": "fa:16:3e:4c:2c:30" - } - ] -} +16
{ + "interfaceAttachments": [ + { + "port_state": "ACTIVE", + "fixed_ips": [ + { + "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", + "ip_address": "192.168.1.3" + } + ], + "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", + "port_id": "ce531f90-199f-48c0-816c-13e38010b442", + "mac_addr": "fa:16:3e:4c:2c:30" + } + ] +}
Querying Details About BMSs (Native OpenStack API)
-Function
This API is used to query details about BMSs.
+Querying Details About BMSs (Native OpenStack API)
+Function
This API is used to query details about BMSs.
@@ -45,7 +45,7 @@Constraints
- The query result returned by this interface includes both ECS and BMS details. You need to filter out the BMS details using the flavor used to create the BMSs or the tags added to the BMSs during BMS creation.
- If the image is used as the search criteria, other search criteria and pagination criteria are not supported. If both the image and other search criteria are used, the BMS details are filtered out by image. If the image is not used as the search criteria, this interface has no restrictions.
String
Specifies the timestamp of the last BMS status update. The parameter is in ISO 8601 time format, for example, 2013-06-09T06:42:18Z.
+Specifies the timestamp of the last BMS status update. The parameter is in ISO 8601 time format, for example, 2013-06-09T06:42:18Z.
image
@@ -66,7 +66,7 @@String
Specifies the flavor ID.
-You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.
+You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.
name
@@ -75,7 +75,7 @@String
Specifies the BMS name. This parameter supports fuzzy matching.
+Specifies the BMS name. This parameter supports fuzzy matching.
For example, the regular expression ?name=bob will return both bob and bobb. To obtain only bob, you can use a regular expression matching the basic database syntax, such as MySQL or PostgreSQL (official website: https://www.postgresql.org/docs/9.2/static/functions-matching.html).
String
Specifies the BMS status.
+Specifies the BMS status.
Value range:
-- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
- DELETED: Deleted
- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
limit
@@ -96,7 +96,7 @@Integer
Specifies the number of BMSs displayed on each page.
+Specifies the number of BMSs displayed on each page.
marker
@@ -105,7 +105,7 @@String
Specifies the BMS ID to which the marker corresponds. The query will start from the next ID.
+Specifies the BMS ID to which the marker corresponds. The query will start from the next ID.
tags
@@ -114,7 +114,7 @@String
Queries the BMSs with specified tags.
+Queries the BMSs with specified tags.
Added in micro version 2.26.
String
Queries the BMSs with tags not containing the specified value. The value is a list of tag keys.
+Queries the BMSs with tags not containing the specified value. The value is a list of tag keys.
NOTE:@@ -137,7 +137,7 @@If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
For example, an existing tag is a.b. After the tag function upgrade, query the tag using "not-tags=a".
String
Specifies the reserved ID, which can be used to query BMSs created in a batch.
+Specifies the reserved ID, which can be used to query BMSs created in a batch.
Added in micro version 2.26.
String
Specifies the BMS sorting attribute, which can be the BMS UUID (uuid), BMS status (vm_state), BMS name (display_name), BMS task status (task_state), power status (power_state), creation time (created_at), last time when the BMS is updated (updated_at), and AZ (availability_zone). You can specify multiple sort_key and sort_dir pairs.
+Specifies the BMS sorting attribute, which can be the BMS UUID (uuid), BMS status (vm_state), BMS name (display_name), BMS task status (task_state), power status (power_state), creation time (created_at), last time when the BMS is updated (updated_at), and AZ (availability_zone). You can specify multiple sort_key and sort_dir pairs.
The default sorting is the reverse order by created_at.
- Example request
- Example request
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.
+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.
@@ -27,7 +27,7 @@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.
+You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.
Request
- Example request
- Example request
- Example request
- With no optional parameterdiff --git a/docs/bms/api-ref/en-us_topic_0053158683.html b/docs/bms/api-ref/en-us_topic_0053158683.html index eb62e135..e97d878f 100644 --- a/docs/bms/api-ref/en-us_topic_0053158683.html +++ b/docs/bms/api-ref/en-us_topic_0053158683.html @@ -1,9 +1,9 @@ -
1https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail +
- Example request
- With no optional parameter-
1https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail
- With an optional parameter-
1https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal +
- With an optional parameter
-1https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal
- With multiple optional parameters
diff --git a/docs/bms/api-ref/en-us_topic_0053158680.html b/docs/bms/api-ref/en-us_topic_0053158680.html index db46ee23..9ef3de7f 100644 --- a/docs/bms/api-ref/en-us_topic_0053158680.html +++ b/docs/bms/api-ref/en-us_topic_0053158680.html @@ -1,6 +1,6 @@ -1https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal&name=bms-test01 +
- With multiple optional parameters
@@ -211,21 +211,21 @@1https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal&name=bms-test01
String
Specifies the BMS name.
+Specifies the BMS name.
id
String
Specifies the unique ID of the BMS.
+Specifies the unique ID of the BMS.
status
String
Specifies the BMS status.
+Specifies the BMS status.
Value range:
- ACTIVE: The BMS is running, stopped, or being deleted.
- BUILD: The BMS is being created.
- ERROR: The BMS is faulty.
- HARD_REBOOT: The BMS is being forcibly restarted.
- REBOOT: The BMS is being restarted.
- SHUTOFF: The BMS is stopped, being started, being deleted, or being rebuilt.
String
Specifies when the BMS was created.
+Specifies when the BMS was created.
The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T03:30:52Z.
String
Specifies the last time when the BMS was updated.
+Specifies the last time when the BMS was updated.
The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T04:30:52Z.
Object
Specifies the BMS flavor. For details, see Table 5.
+Specifies the BMS flavor. For details, see Table 5.
image
Object
Specifies the BMS image. For details, see Table 6.
+Specifies the BMS image. For details, see Table 6.
tenant_id
String
Specifies the ID of the tenant owning the BMS. The value is in UUID format.
+Specifies the ID of the tenant owning the BMS. The value is in UUID format.
This parameter equals to project_id.
String
Specifies the user ID of the BMS.
+Specifies the user ID of the BMS.
metadata
Map<String,String>
Specifies the BMS metadata.
+Specifies the BMS metadata.
It is a user-defined metadata key-value pair. Each key or value contains a maximum of 255 characters.
String
Specifies the host ID of the BMS.
+Specifies the host ID of the BMS.
addresses
Map<String,Array of address objects>
Specifies the network address of the BMS. Specifies the VPC used by the BMS.
-- key: indicates the ID of the VPC used by the BMS.
- value indicates the VPC details.
Specifies the network address of the BMS. Specifies the VPC used by the BMS.
+- key: indicates the ID of the VPC used by the BMS.
- value indicates the VPC details.
security_groups
Array of objects
Specifies the security groups of the BMS. For details, see Table 9.
+Specifies the security groups of the BMS. For details, see Table 9.
links
Array of objects
Specifies shortcut links of the BMS. For details, see Table 7.
+Specifies shortcut links of the BMS. For details, see Table 7.
OS-DCF:diskConfig
@@ -324,42 +324,42 @@String
Specifies the disk configuration method. This is an extended attribute. The value can be:
-- MANUAL: The BMS is created using the partitioning scheme and file system in the image. If the target flavor has a large disk, the API does not partition the remaining disk space.
- AUTO: The BMS is created using a single partition with the same size as the disk of the target flavor. The API automatically adjusts the file system to adapt to the entire partition.
- MANUAL: The BMS is created using the partitioning scheme and file system in the image. If the target flavor has a large disk, the API does not partition the remaining disk space.
- AUTO: The BMS is created using a single partition with the same size as the disk of the target flavor. The API automatically adjusts the file system to adapt to the entire partition.
OS-EXT-AZ:availability_zone
String
Specifies the name of the AZ where the BMS is deployed. This is an extended attribute.
+Specifies the name of the AZ where the BMS is deployed. This is an extended attribute.
OS-EXT-SRV-ATTR:host
String
Specifies the host name of the BMS. This is an extended attribute.
+Specifies the hostname of the BMS. This is an extended attribute.
OS-EXT-SRV-ATTR:hypervisor_hostname
String
Specifies the hypervisor host name. This is an extended attribute provided by the Nova virt driver.
+Specifies the hostname of the hypervisor. This is an extended attribute provided by the Nova virt driver.
OS-EXT-SRV-ATTR:instance_name
String
Specifies the BMS alias. This is an extended attribute.
+Specifies the BMS alias. This is an extended attribute.
OS-EXT-STS:power_state
Integer
Specifies the power status of the BMS. This is an extended attribute.
+Specifies the BMS power status. This is an extended attribute.
Value range:
- 0: pending
- 1: running
- 2: paused
- 3: shutdown
- 4: crashed
String
Specifies the task status of the BMS. This is an extended attribute.
+Specifies the BMS task status. This is an extended attribute.
Value range:
- rebooting: The BMS is being restarted.
- reboot_started: The BMS is normally restarted.
- reboot_started_hard: The BMS is forcibly restarted.
- powering-off: The BMS is being powered off.
- powering-on: The BMS is being powered on.
- rebuilding: The BMS is being rebuilt.
- scheduling: The BMS is being scheduled.
- deleting: The BMS is being deleted.
String
Specifies the stability status of the BMS. This is an extended attribute.
+Specifies the BMS status. This is an extended attribute.
Value range:
-- active: The BMS is running.
- shutoff: The BMS is stopped.
- suspended: The BMS is suspended.
- reboot: The BMS is restarted.
- active: The BMS is running.
- shutoff: The BMS is stopped.
- reboot: The BMS is restarted.
OS-SRV-USG:launched_at
String
Specifies the time when the BMS was started. This is an extended attribute.
+Specifies the time when the BMS was started. This is an extended attribute.
The timestamp format complies with ISO 8601, for example, 2019-05-22T03:23:59.000000.
String
Specifies the time when the BMS was deleted. This is an extended attribute.
+Specifies the time when the BMS was deleted. This is an extended attribute.
The timestamp format complies with ISO 8601, for example, 2019-05-22T04:23:59.000000.
Array of objects
Specifies the attached EVS disks of the BMS. For details, see Table 10.
+Specifies the attached EVS disks of the BMS. For details, see Table 10.
accessIPv4
@@ -423,7 +423,7 @@Object
Specifies the fault cause. If the BMS is faulty, this field will be returned. For details, see Table 11.
+Specifies the fault cause. If the BMS is faulty, this field will be returned. For details, see Table 11.
config_drive
@@ -452,8 +452,8 @@String
Specifies the status of theBMS host.
-- UP: The host is normal.
- UNKNOWN: The host status is unknown.
- DOWN: the host is abnormal.
- MAINTENANCE: The host is being maintained.
- Empty string: There is no BMS host information.
Specifies the status of theBMS host.
+- UP: The host is normal.
- UNKNOWN: The host status is unknown.
- DOWN: the host is abnormal.
- MAINTENANCE: The host is being maintained.
- Empty string: There is no BMS host information.
This is a new parameter in micro version 2.16.
String
Specifies the host name of the BMS.
+Specifies the hostname of the BMS.
This is a new parameter in micro version 2.3.
String
Specifies the reserved BMS IDs when BMSs are created in batches.
+Specifies the reserved BMS IDs when BMSs are created in a batch.
This is a new parameter in micro version 2.3.
Integer
Specifies the startup sequence of the BMSs created in batches.
+Specifies the startup sequence of the BMSs created in a batch.
This is a new parameter in micro version 2.3.
String
Specifies the user_data specified during BMS creation. The value is encoded using Base64 or an empty string.
+Specifies the user_data specified during BMS creation. The value is encoded using Base64 or an empty string.
locked
Boolean
Specifies whether the BMS is locked.
+Specifies whether the BMS is locked.
- true: The BMS is locked.
- false: The BMS is not locked.
This is a new parameter in micro version 2.9.
Array of strings
Specifies tags of the BMS.
+Specifies tags of the BMS.
This is a new parameter in micro version 2.26. If you are not using this micro version, the response will not contain the tags parameter.
A tag must meet the following requirements:
- The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
Array of objects
Specifies system tags of the BMS. For details, see Table 3.
+Specifies system tags of the BMS. For details, see Table 3.
enterprise_project_id
@@ -549,7 +549,7 @@Object
Specifies scheduling information of the BMS. For details, see Table 4.
+Specifies scheduling information of the BMS. For details, see Table 4.
String
Specifies the BMS type ID.
+Specifies the BMS type ID.
This field is not supported in microversions later than 2.47.
Array of objects
Specifies shortcut links of the BMS type.
+Specifies shortcut links of the BMS type.
For details, see Table 7.
This field is not supported in microversions later than 2.47.
String
Specifies the image ID of the BMS.
+Specifies the image ID of the BMS.
links
Array of objects
Specifies shortcut links of the BMS image. For details, see Table 7.
+Specifies shortcut links of the BMS image. For details, see Table 7.
String
- If no security group is specified during BMS creation, the default value is used.
- If a security group is specified when you create the BMS, the value of this parameter is the security group name.
- If no security group is specified during BMS creation, the default value is used.
- If a security group is specified when you create the BMS, the value of this parameter is the security group name.
Boolean
Specifies whether to delete the disk when deleting the BMS.
-- true: Yes
- false: No
Specifies whether to delete the disk when deleting the BMS.
+- true: Yes
- false: No
Added in micro version 2.3.
{ - "servers": [ -{ - "tenant_id": "c685484a8cc2416b97260938705deb64", - "addresses": { - "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ -{ - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77", - "OS-EXT-IPS:type": "fixed", - "addr": "192.168.0.107", - "version": 4 - } - ] - }, - "metadata": { - "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" - }, - "OS-EXT-STS:task_state": null, - "OS-DCF:diskConfig": "MANUAL", - "OS-EXT-AZ:availability_zone": "az-dc-1", - "links": [ -{ - "rel": "self", - "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" - }, -{ - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" - } - ], - "OS-EXT-STS:power_state": 1, - "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", - "os-extended-volumes:volumes_attached": [ -{ - "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" - }, -{ - "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" - }, -{ - "id": "86e801c3-acc6-465d-890c-d43ba493f553" - }, -{ - "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" - } - ], - "OS-EXT-SRV-ATTR:host": "bms.az1", - "image": { - "links": [ -{ - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" - } - ], - "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" - }, - "OS-SRV-USG:terminated_at": null, - "accessIPv4": "", - "accessIPv6": "", - "created": "2017-05-24T06:14:05Z", - "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", - "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", - "key_name": "KeyPair-JX", - "flavor": { - "links": [ -{ - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" - } - ], - "id": "physical.83.medium" - }, - "security_groups": [ -{ - "name": "0011b620-4982-42e4-ad12-47c95ca495c4" - } - ], - "config_drive": "", - "OS-EXT-STS:vm_state": "active", - "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", - "user_id": "1311c433dd9b408886f57d695c229cbe", - "name": "bms", +89
{ + "servers": [ +{ + "tenant_id": "c685484a8cc2416b97260938705deb64", + "addresses": { + "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ +{ + "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77", + "OS-EXT-IPS:type": "fixed", + "addr": "192.168.0.107", + "version": 4 + } + ] + }, + "metadata": { + "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" + }, + "OS-EXT-STS:task_state": null, + "OS-DCF:diskConfig": "MANUAL", + "OS-EXT-AZ:availability_zone": "az-dc-1", + "links": [ +{ + "rel": "self", + "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" + }, +{ + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" + } + ], + "OS-EXT-STS:power_state": 1, + "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", + "os-extended-volumes:volumes_attached": [ +{ + "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" + }, +{ + "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" + }, +{ + "id": "86e801c3-acc6-465d-890c-d43ba493f553" + }, +{ + "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" + } + ], + "OS-EXT-SRV-ATTR:host": "bms.az1", + "image": { + "links": [ +{ + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" + } + ], + "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" + }, + "OS-SRV-USG:terminated_at": null, + "accessIPv4": "", + "accessIPv6": "", + "created": "2017-05-24T06:14:05Z", + "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", + "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", + "key_name": "KeyPair-JX", + "flavor": { + "links": [ +{ + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" + } + ], + "id": "physical.83.medium" + }, + "security_groups": [ +{ + "name": "0011b620-4982-42e4-ad12-47c95ca495c4" + } + ], + "config_drive": "", + "OS-EXT-STS:vm_state": "active", + "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", + "user_id": "1311c433dd9b408886f57d695c229cbe", + "name": "bms", "progress": 0, - "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", - "updated": "2017-05-25T03:40:25Z", - "status": "ACTIVE" - } - ] -} + "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", + "updated": "2017-05-25T03:40:25Z", + "status": "ACTIVE" + } + ] +}
BMS Lifecycle Management
+BMS Lifecycle Management
-
diff --git a/docs/bms/api-ref/en-us_topic_0053158682.html b/docs/bms/api-ref/en-us_topic_0053158682.html
index 0c4cae14..35191000 100644
--- a/docs/bms/api-ref/en-us_topic_0053158682.html
+++ b/docs/bms/api-ref/en-us_topic_0053158682.html
@@ -253,7 +253,7 @@
- Example request@@ -422,28 +422,28 @@ 19 20 21 -22
1POST https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers +
- Example request@@ -269,19 +269,19 @@ 10 11 12 -13
1POST https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers
{ - "server": { - "imageRef": "1a6635d8-afea-4f2b-abb6-27a202bad319", - "flavorRef": "physical.o2.medium", - "name": "bms_name01", - "availability_zone": "az-dc-1", - "networks": [ - { - "uuid": "8470310b-bfa2-4edf-8f64-d15196b2b2c9" - } - ] - } -} +13
{ + "server": { + "imageRef": "1a6635d8-afea-4f2b-abb6-27a202bad319", + "flavorRef": "physical.o2.medium", + "name": "bms_name01", + "availability_zone": "az-dc-1", + "networks": [ + { + "uuid": "8470310b-bfa2-4edf-8f64-d15196b2b2c9" + } + ] + } +}
- Example request
- With an optional parameter
{ - "server": { - "security_groups": [ - { - "name": "default" - } - ], - "OS-DCF:diskConfig": "MANUAL", - "links": [ - { - "rel": "self", - "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/servers/9ab74d89-61e7-4259-8546-465fdebe4944" - }, - { - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/9ab74d89-61e7-4259-8546-465fdebe4944" - } - ], - "id": "9ab74d89-61e7-4259-8546-465fdebe4944", - "adminPass": "RjdD3h8U2DBe" - } -} +22
{ + "server": { + "security_groups": [ + { + "name": "default" + } + ], + "OS-DCF:diskConfig": "MANUAL", + "links": [ + { + "rel": "self", + "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/servers/9ab74d89-61e7-4259-8546-465fdebe4944" + }, + { + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/9ab74d89-61e7-4259-8546-465fdebe4944" + } + ], + "id": "9ab74d89-61e7-4259-8546-465fdebe4944", + "adminPass": "RjdD3h8U2DBe" + } +}
Deleting Specified BMS Metadata (Native OpenStack API)
+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.
+Constraints
The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, or paused.
URI
DELETE /v2.1/{project_id}/servers/{server_id}/metadata/{key}
Table 1 lists the parameters.
@@ -28,8 +28,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
key
@@ -44,7 +44,7 @@Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0053158713.html b/docs/bms/api-ref/en-us_topic_0053158713.html index 9200f701..b00a09fa 100644 --- a/docs/bms/api-ref/en-us_topic_0053158713.html +++ b/docs/bms/api-ref/en-us_topic_0053158713.html @@ -27,7 +27,7 @@
1DELETE https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key} +
- Example request
diff --git a/docs/bms/api-ref/en-us_topic_0053158684.html b/docs/bms/api-ref/en-us_topic_0053158684.html index a2afa25a..898c135c 100644 --- a/docs/bms/api-ref/en-us_topic_0053158684.html +++ b/docs/bms/api-ref/en-us_topic_0053158684.html @@ -1,9 +1,9 @@1DELETE https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key}
Querying BMS Flavors (Native OpenStack API)
-Function
This API is used to query BMS flavors.
+-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.
+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.
@@ -81,15 +81,15 @@Request
- Request parameters -
- Example request
- With no optional parameter-
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail +
- Example request
- With no optional parameter-
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail
- With an optional parameterdiff --git a/docs/bms/api-ref/en-us_topic_0053158711.html b/docs/bms/api-ref/en-us_topic_0053158711.html index 6abd0540..5bc1f2a8 100644 --- a/docs/bms/api-ref/en-us_topic_0053158711.html +++ b/docs/bms/api-ref/en-us_topic_0053158711.html @@ -1,6 +1,6 @@ -
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail?minDisk=3725 +
- With an optional parameter
-1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail?minDisk=3725
- With multiple optional parameters
-1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail?minDisk=3725&is_public=true +
- With multiple optional parameters
@@ -109,7 +109,7 @@1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/flavors/detail?minDisk=3725&is_public=true
Array of objects
Specifies BMS flavors. For details, see Table 3.
+Specifies BMS flavors. For details, see Table 3.
String
Specifies the BMS flavor ID.
+Specifies the BMS flavor ID.
name
String
Specifies the BMS flavor name.
+Specifies the BMS flavor name.
vcpus
Integer
Specifies the number of CPU cores in the BMS flavor.
+Specifies the number of CPU cores in the BMS flavor.
ram
Integer
Specifies the memory size (MB) in the BMS flavor.
+Specifies the memory size (MB) in the BMS flavor.
disk
Integer
Specifies the disk size (GB) in the BMS flavor.
+Specifies the disk size (GB) in the BMS flavor.
swap
diff --git a/docs/bms/api-ref/en-us_topic_0053158685.html b/docs/bms/api-ref/en-us_topic_0053158685.html index d26caabb..f14c6738 100644 --- a/docs/bms/api-ref/en-us_topic_0053158685.html +++ b/docs/bms/api-ref/en-us_topic_0053158685.html @@ -1,9 +1,9 @@ -Stopping a BMS (Native OpenStack API)
-Function
This API is used to stop a single BMS.
+Stopping a BMS (Native OpenStack API)
+-Function
This API is used to stop a single BMS.
Constraints
- The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active or error.
- Currently, only forcible stopping is supported.
Constraints
- The OS-EXT-STS:vm_state attribute (BMS status) must be active or error.
- Currently, only forcible stopping is supported.
URI
POST /v2.1/{project_id}/servers/{server_id}/action
Table 1 lists the parameters.
@@ -28,8 +28,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
Object
Specifies the operation of stopping the BMS. For details, see Table 2.
+Specifies the operation of stopping the BMS. For details, see Table 2.
- Example request-
1POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action +
- Example request
1POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action
diff --git a/docs/bms/api-ref/en-us_topic_0053158687.html b/docs/bms/api-ref/en-us_topic_0053158687.html index f9f8eb7b..4de9146c 100644 --- a/docs/bms/api-ref/en-us_topic_0053158687.html +++ b/docs/bms/api-ref/en-us_topic_0053158687.html @@ -1,7 +1,7 @@ -1 2 -3
{ - "os-stop": {} -} +3
{ + "os-stop": {} +}
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.
+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.
@@ -26,8 +26,8 @@
Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
id
@@ -35,7 +35,7 @@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).
+You can obtain the NIC ID from the NICs tab page on the BMS details page or by calling the Querying Information About BMS NICs (Native OpenStack API) API. (The NIC ID is the value of port_id).
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0053158688.html b/docs/bms/api-ref/en-us_topic_0053158688.html index 7a0fb6bf..a09991ff 100644 --- a/docs/bms/api-ref/en-us_topic_0053158688.html +++ b/docs/bms/api-ref/en-us_topic_0053158688.html @@ -1,6 +1,6 @@ -
1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface/ce531f90-199f-48c0-816c-13e38010b442 +
- Example request
@@ -62,7 +62,7 @@1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface/ce531f90-199f-48c0-816c-13e38010b442
Object
Specifies information about the specified BMS NIC. For details, see Table 2.
+Specifies information about the specified BMS NIC. For details, see Table 2.
{ - "interfaceAttachment": { - "port_state": "ACTIVE", - "fixed_ips": [ -{ - "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", - "ip_address": "192.168.1.3" - } +14
{ + "interfaceAttachment": { + "port_state": "ACTIVE", + "fixed_ips": [ +{ + "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", + "ip_address": "192.168.1.3" + } ], - "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", - "port_id": "ce531f90-199f-48c0-816c-13e38010b442", - "mac_addr": "fa:16:3e:4c:2c:30" - } - } + "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", + "port_id": "ce531f90-199f-48c0-816c-13e38010b442", + "mac_addr": "fa:16:3e:4c:2c:30" + } + }
BMS IP Address Query
+BMS IP Address Query
-
diff --git a/docs/bms/api-ref/en-us_topic_0053158693.html b/docs/bms/api-ref/en-us_topic_0053158693.html
index 4de7750b..f307b520 100644
--- a/docs/bms/api-ref/en-us_topic_0053158693.html
+++ b/docs/bms/api-ref/en-us_topic_0053158693.html
@@ -1,7 +1,7 @@
-
- The query result returned by this interface includes both ECSs and BMSs. You need to filter out the BMSs using the flavor used to create the BMSs or the tags added to the BMSs during BMS creation.
- If the image is used as the search criteria, other search criteria and pagination criteria are not supported. If both the image and other search criteria are used, the BMSs are filtered out by image. If the image is not used as the search criteria, this interface has no restrictions.
- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
- DELETED: Deleted
- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
Querying BMSs (Native OpenStack API)
-Function
This API is used to query BMSs.
+Querying BMSs (Native OpenStack API)
+Function
This API is used to query BMSs.
@@ -45,7 +45,7 @@Constraints
String
Specifies the timestamp of the last BMS status update. The parameter is in ISO 8601 time format, for example, 2013-06-09T06:42:18Z.
+Specifies the timestamp of the last BMS status update. The parameter is in ISO 8601 time format, for example, 2013-06-09T06:42:18Z.
image
@@ -66,7 +66,7 @@String
Specifies the flavor ID.
-You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.
+You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.
name
@@ -75,7 +75,7 @@String
Specifies the BMS name. This parameter supports fuzzy matching.
+Specifies the BMS name. This parameter supports fuzzy matching.
For example, the regular expression ?name=bob will return both bob and bobb. To obtain only bob, you can use a regular expression matching the basic database syntax, such as MySQL or PostgreSQL (official website: https://www.postgresql.org/docs/9.2/static/functions-matching.html).
String
Specifies the BMS status.
+Specifies the BMS status.
Value range:
-limit
@@ -96,7 +96,7 @@Integer
Specifies the number of BMSs displayed on each page.
+Specifies the number of BMSs displayed on each page.
marker
@@ -105,7 +105,7 @@String
Specifies the BMS ID to which the marker corresponds. The query will start from the next ID.
+Specifies the BMS ID to which the marker corresponds. The query will start from the next ID.
tags
@@ -114,7 +114,7 @@String
Queries the BMSs with specified tags.
+Queries the BMSs with specified tags.
Added in micro version 2.26.
String
Queries the BMSs with tags not containing the specified value. The value is a list of tag keys.
+Queries the BMSs with tags not containing the specified value. The value is a list of tag keys.
NOTE:@@ -137,7 +137,7 @@If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
For example, an existing tag is a.b. After the tag function upgrade, query the tag using "not-tags=a".
String
Specifies the reserved ID, which can be used to query BMSs created in a batch.
+Specifies the reserved ID, which can be used to query BMSs created in a batch.
Added in micro version 2.26.
String
Specifies the BMS sorting attribute, which can be the BMS UUID (uuid), BMS status (vm_state), BMS name (display_name), BMS task status (task_state), power status (power_state), creation time (created_at), last time when the BMS is updated (updated_at), and AZ (availability_zone). You can specify multiple sort_key and sort_dir pairs.
+Specifies the BMS sorting attribute, which can be the BMS UUID (uuid), BMS status (vm_state), BMS name (display_name), BMS task status (task_state), power status (power_state), creation time (created_at), last time when the BMS is updated (updated_at), and AZ (availability_zone). You can specify multiple sort_key and sort_dir pairs.
The default sorting is the reverse order by created_at.
- Example request
- Example request
- With no optional parameterdiff --git a/docs/bms/api-ref/en-us_topic_0053158696.html b/docs/bms/api-ref/en-us_topic_0053158696.html index 8e3a5d14..4eef8beb 100644 --- a/docs/bms/api-ref/en-us_topic_0053158696.html +++ b/docs/bms/api-ref/en-us_topic_0053158696.html @@ -1,7 +1,7 @@ -
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers +
- Example request
- With no optional parameter-
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers
- With an optional parameter-
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal +
- With an optional parameter
-1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal
- With multiple optional parameters
diff --git a/docs/bms/api-ref/en-us_topic_0053158695.html b/docs/bms/api-ref/en-us_topic_0053158695.html index abf2f8e7..e771f22f 100644 --- a/docs/bms/api-ref/en-us_topic_0053158695.html +++ b/docs/bms/api-ref/en-us_topic_0053158695.html @@ -1,9 +1,9 @@ -1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal&name=bms-test01 +
- With multiple optional parameters
@@ -192,7 +192,7 @@1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal&name=bms-test01
Array of objects
Specifies the BMS list. For details, see Table 2.
+Specifies the BMS list. For details, see Table 2.
String
Specifies the BMS name.
+Specifies the BMS name.
id
String
Specifies the unique ID of the BMS.
+Specifies the unique ID of the BMS.
links
Array of objects
Specifies shortcut links of the BMS. For details, see Table 3.
+Specifies shortcut links of the BMS. For details, see Table 3.
{ - "servers": [ - { - "name": "bms", - "links": [ - { - "rel": "self", - "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8b-4bc5-ae46-69cacfd4fbaa" - }, - { - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" - } - ], - "id": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" - } - ] -} +18
{ + "servers": [ + { + "name": "bms", + "links": [ + { + "rel": "self", + "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8b-4bc5-ae46-69cacfd4fbaa" + }, + { + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" + } + ], + "id": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" + } + ] +}
Modifying Specified BMS Metadata (Native OpenStack API)
-Function
This API is used to modify specified BMS metadata.
+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.
+Constraints
The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, or paused.
URI
PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key}
Table 1 lists the parameters.
@@ -28,15 +28,15 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
key
Yes
Specifies the BMS metadata key value to be modified
+Specifies the BMS metadata key value to be modified.
- Example request@@ -154,10 +154,10 @@ 2 3 4 -5
1PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key} +
- Example request@@ -101,11 +101,11 @@ 2 3 4 -5
1PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key}
{ - "meta": { - "key": "value" - } -} +5
{ + "meta": { + "key": "value" + } +}
- Example request
- With an optional parameter
{ - "meta": { - "key": "value" - } +5
{ + "meta": { + "key": "value" + } }
Querying IP Addresses of a BMS (Native OpenStack API)
-Function
This API is used to query private IP addresses of a BMS.
+Querying IP Addresses of a BMS (Native OpenStack API)
+Function
This API is used to query private IP addresses of a BMS.
@@ -28,8 +28,8 @@Constraints
Pagination query is not supported.
- Example request
- Example request
Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
Request
- Request parameters -
- Example request-
1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/ips +
- Example request
@@ -56,15 +56,15 @@1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/ips
Map<String,Array of address objects>
Specifies the VPC used by the BMS.
-- key: indicates the ID of the VPC used by the BMS.
- value indicates the VPC details.
Specifies the VPC used by the BMS.
+- key: indicates the ID of the VPC used by the BMS.
- value indicates the VPC details.
-Table 2 address parameter structure description Parameter
+diff --git a/docs/bms/api-ref/en-us_topic_0053158703.html b/docs/bms/api-ref/en-us_topic_0053158703.html index 80967094..5a3521d8 100644 --- a/docs/bms/api-ref/en-us_topic_0053158703.html +++ b/docs/bms/api-ref/en-us_topic_0053158703.html @@ -1,6 +1,6 @@ -Table 2 address parameter structure description Parameter
Type
{ - "addresses": { - "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ - { - "version": 4, - "addr": "192.168.2.90" - } - ] - } -} +10
{ + "addresses": { + "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ + { + "version": 4, + "addr": "192.168.2.90" + } + ] + } +}
BMS Disk Management
+BMS Disk Management
-
diff --git a/docs/bms/api-ref/en-us_topic_0053158707.html b/docs/bms/api-ref/en-us_topic_0053158707.html
index 5a44b338..4f6cfbfe 100644
--- a/docs/bms/api-ref/en-us_topic_0053158707.html
+++ b/docs/bms/api-ref/en-us_topic_0053158707.html
@@ -1,7 +1,7 @@
-
Querying Details About a BMS (Native OpenStack API)
-Function
This API is used to query details about a BMS based on the BMS ID.
+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.
@@ -26,8 +26,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0053158710.html b/docs/bms/api-ref/en-us_topic_0053158710.html index db4910c7..47f4df9c 100644 --- a/docs/bms/api-ref/en-us_topic_0053158710.html +++ b/docs/bms/api-ref/en-us_topic_0053158710.html @@ -27,7 +27,7 @@
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/9ab74d89-61e7-4259-8546-465fdebe4944 +
- Example request
@@ -54,7 +54,7 @@1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/9ab74d89-61e7-4259-8546-465fdebe4944
Object
Specifies BMS information. For details, see Table 2.
+Specifies BMS information. For details, see Table 2.
String
Specifies the BMS name.
+Specifies the BMS name.
id
String
Specifies the unique ID of the BMS.
+Specifies the unique ID of the BMS.
status
String
Specifies the BMS status.
+Specifies the BMS status.
Value range:
- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
- SHUTOFF: Stopped, Starting, Deleting, Rebuilding
String
Specifies the time when the BMS was created.
+Specifies the time when the BMS was created.
The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T03:30:52Z.
String
Specifies the time when the BMS was last updated.
+Specifies the time when the BMS was last updated.
The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T04:30:52Z.
Object
Specifies the BMS flavor. For details, see Table 3.
+Specifies the BMS flavor. For details, see Table 3.
image
Object
Specifies the BMS image. For details, see Table 4.
+Specifies the BMS image. For details, see Table 4.
tenant_id
@@ -141,14 +141,14 @@String
Specifies the ID of the user to which the BMS belongs.
+Specifies the ID of the user to which the BMS belongs.
metadata
Map<String,String>
Specifies the BMS metadata.
+Specifies the BMS metadata.
It is a user-defined metadata key-value pair. Each key or value contains a maximum of 255 characters.
String
Specifies the host ID of the BMS.
+Specifies the host ID of the BMS.
addresses
Map<String,Array of address objects>
Specifies BMS network addresses. Specifies the VPC used by the BMS.
-- key: indicates the ID of the VPC used by the BMS.
- value indicates the VPC details.
Specifies BMS network addresses. Specifies the VPC used by the BMS.
+- key: indicates the ID of the VPC used by the BMS.
- value indicates the VPC details.
security_groups
Array of objects
Specifies the security groups to which the BMS belongs. For details, see Table 7.
+Specifies the security groups to which the BMS belongs. For details, see Table 7.
links
Array of objects
Specifies shortcut links of the BMS. For details, see Table 5.
+Specifies shortcut links of the BMS. For details, see Table 5.
OS-DCF:diskConfig
@@ -193,35 +193,35 @@String
Specifies the AZ where the BMS is located.
+Specifies the AZ where the BMS is located.
OS-EXT-SRV-ATTR:host
String
Specifies the host name of the BMS. This is an extended attribute.
+Specifies the hostname of the BMS. This is an extended attribute.
OS-EXT-SRV-ATTR:hypervisor_hostname
String
Specifies the name of a host on the hypervisor. This is an extended attribute provided by the Nova virt driver.
+Specifies the hostname of the hypervisor. This is an extended attribute provided by the Nova virt driver.
OS-EXT-SRV-ATTR:instance_name
String
Specifies the BMS alias. This is an extended attribute.
+Specifies the BMS alias. This is an extended attribute.
OS-EXT-STS:power_state
Integer
Specifies the power status of the BMS. This is an extended attribute.
+Specifies the BMS power status. This is an extended attribute.
Options: 0, 1, 2, 3, and 4
- 0: pending
- 1: running
- 2: paused
- 3: shutdown
- 4: crashed
String
Specifies the task status of the BMS. This is an extended attribute.
+Specifies the BMS task status. This is an extended attribute.
Value range:
- rebooting: The BMS is being restarted.
- reboot_started: The BMS is normally restarted.
- reboot_started_hard: The BMS is forcibly restarted.
- powering-off: The BMS is being powered off.
- powering-on: The BMS is being powered on.
- rebuilding: The BMS is being rebuilt.
- scheduling: The BMS is being scheduled.
- deleting: The BMS is being deleted.
String
Specifies the stable BMS status. This is an extended attribute.
+Specifies the BMS status. This is an extended attribute.
Value range:
-- active: The BMS is running.
- shutoff: The BMS is stopped.
- suspended: The BMS is suspended.
- reboot: The BMS is restarted.
- active: The BMS is running.
- shutoff: The BMS is stopped.
- reboot: The BMS is restarted.
OS-SRV-USG:launched_at
String
Specifies the time when the BMS was started. This is an extended attribute.
+Specifies the time when the BMS was started. This is an extended attribute.
The timestamp format is ISO 8601, for example, 2019-05-22T03:23:59.000000.
String
Specifies the time when the BMS was deleted. This is an extended attribute.
+Specifies the time when the BMS was deleted. This is an extended attribute.
The timestamp format is ISO 8601, for example, 2019-05-22T04:23:59.000000.
Array of objects
Specifies the EVS disks attached to the BMS. For details, see Table 8.
+Specifies the EVS disks attached to the BMS. For details, see Table 8.
accessIPv4
@@ -285,7 +285,7 @@Object
Specifies the fault cause. If the BMS is faulty, this field is returned. For details, see Table 9.
+Specifies the fault cause. If the BMS is faulty, this field is returned. For details, see Table 9.
config_drive
@@ -314,8 +314,8 @@String
Specifies the status of the host that accommodates the BMS.
-- UP: The nova-compute is normal.
- UNKNOWN: The nova-compute status is unknown.
- DOWN: the nova-compute status is abnormal.
- MAINTENANCE: The nova-compute is in the maintenance state.
- Empty string: The BMS does not have host information.
Specifies the status of the host that accommodates the BMS.
+- UP: The nova-compute is normal.
- UNKNOWN: The nova-compute status is unknown.
- DOWN: the nova-compute status is abnormal.
- MAINTENANCE: The nova-compute is in the maintenance state.
- Empty string: The BMS does not have host information.
Added in micro version 2.16.
String
Specifies the host name of the BMS.
+Specifies the hostname of the BMS.
Added in micro version 2.3.
String
Specifies the reserved BMS IDs in the batch BMS creation scenario.
+Specifies the reserved BMS IDs in a batch BMS creation situation.
Added in micro version 2.3.
Integer
Specifies the BMS startup sequence in the batch BMS creation scenario.
+Specifies the BMS startup sequence in a batch BMS creation situation.
Added in micro version 2.3.
String
Specifies the device name of the BMS system disk, for example, /dev/sda.
+Specifies the device name of the BMS system disk, for example, /dev/sda.
Added in micro version 2.3.
String
Specifies the user_data specified during BMS creation. The value is encoded using Base64 or an empty string.
+Specifies the user_data specified during BMS creation. The value is encoded using Base64 or an empty string.
locked
Boolean
Specifies whether the BMS is locked.
+Specifies whether the BMS is locked.
- true: The BMS is locked.
- false: The BMS is not locked.
Added in micro version 2.9.
Array of strings
Specifies tags of the BMS.
+Specifies tags of the BMS.
This parameter is added in microversion 2.26. If the microversion is not used for query, the response does not contain the tags field.
The value of this field meets the following requirements:
- The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
String
Specifies the BMS type ID.
+Specifies the BMS type ID.
This field is not supported in microversions later than 2.47.
Array of objects
Specifies shortcut links of the BMS type.
+Specifies shortcut links of the BMS type.
For details, see Table 5.
This field is not supported in microversions later than 2.47.
String
- If no security group is specified during BMS creation, the default value is used.
- If a security group is specified when you create the BMS, the value of this parameter is the security group name.
- If no security group is specified during BMS creation, the default value is used.
- If a security group is specified when you create the BMS, the value of this parameter is the security group name.
Boolean
Specifies whether to delete the disk when deleting the BMS.
-- true: Yes
- false: No
Specifies whether to delete the disk when deleting the BMS.
+- true: Yes
- false: No
Added in micro version 2.3.
{ - "server": { - "tenant_id": "c685484a8cc2416b97260938705deb65", - "addresses": { - "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ -{ - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c3:77", - "OS-EXT-IPS:type": "fixed", - "addr": "192.168.0.107", - "version": 4 - } - ] - }, - "metadata": { - "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" - }, - "OS-EXT-STS:task_state": null, - "OS-DCF:diskConfig": "MANUAL", - "OS-EXT-AZ:availability_zone": "az-dc-1", - "links": [ -{ - "rel": "self", - "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" - }, -{ - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" - } - ], - "OS-EXT-STS:power_state": 1, - "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", - "os-extended-volumes:volumes_attached": [ -{ - "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" - }, -{ - "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" - }, -{ - "id": "86e801c3-acc6-465d-890c-d43ba493f553" - }, -{ - "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" - } - ], - "OS-EXT-SRV-ATTR:host": "bms.az1", - "image": { - "links": [ -{ - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" - } - ], - "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" - }, - "OS-SRV-USG:terminated_at": null, - "accessIPv4": "", - "accessIPv6": "", - "created": "2017-05-24T06:14:05Z", - "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", - "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", - "key_name": "KeyPair-JX", - "flavor": { - "links": [ -{ - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" - } - ], - "id": "physical.83.medium" - }, - "security_groups": [ -{ - "name": "0011b620-4982-42e4-ad12-47c95ca495c4" - } - ], - "config_drive": "", - "OS-EXT-STS:vm_state": "active", - "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", - "user_id": "1311c433dd9b408886f57d695c229cbe", - "name": "bms-83", - "progress": 0, - "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", - "updated": "2017-05-25T03:40:25Z", - "status": "ACTIVE" - } -} +87
{ + "server": { + "tenant_id": "c685484a8cc2416b97260938705deb65", + "addresses": { + "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ +{ + "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c3:77", + "OS-EXT-IPS:type": "fixed", + "addr": "192.168.0.107", + "version": 4 + } + ] + }, + "metadata": { + "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" + }, + "OS-EXT-STS:task_state": null, + "OS-DCF:diskConfig": "MANUAL", + "OS-EXT-AZ:availability_zone": "az-dc-1", + "links": [ +{ + "rel": "self", + "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" + }, +{ + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" + } + ], + "OS-EXT-STS:power_state": 1, + "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", + "os-extended-volumes:volumes_attached": [ +{ + "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" + }, +{ + "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" + }, +{ + "id": "86e801c3-acc6-465d-890c-d43ba493f553" + }, +{ + "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" + } + ], + "OS-EXT-SRV-ATTR:host": "bms.az1", + "image": { + "links": [ +{ + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" + } + ], + "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" + }, + "OS-SRV-USG:terminated_at": null, + "accessIPv4": "", + "accessIPv6": "", + "created": "2017-05-24T06:14:05Z", + "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", + "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", + "key_name": "KeyPair-JX", + "flavor": { + "links": [ +{ + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" + } + ], + "id": "physical.83.medium" + }, + "security_groups": [ +{ + "name": "0011b620-4982-42e4-ad12-47c95ca495c4" + } + ], + "config_drive": "", + "OS-EXT-STS:vm_state": "active", + "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", + "user_id": "1311c433dd9b408886f57d695c229cbe", + "name": "bms-83", + "progress": 0, + "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", + "updated": "2017-05-25T03:40:25Z", + "status": "ACTIVE" + } +}
Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
- Example request
- Example request@@ -127,7 +127,7 @@
1PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd +
- Example request@@ -89,11 +89,11 @@ 2 3 4 -5
1PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd
{ - "server": { - "name": "new-server-test" - } -} +5
{ + "server": { + "name": "new-server-test" + } +}
String
Specifies the current status of the BMS.
-- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
- DELETED: Deleted
- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
created
@@ -347,8 +347,8 @@Array of objects
Specifies the VPC used by the BMS.
-- key: indicates the ID of the VPC used by the BMS.
- value: indicates the VPC details. For details, see Table 8.
Specifies the VPC used by the BMS.
+- key: indicates the ID of the VPC used by the BMS.
- value: indicates the VPC details. For details, see Table 8.
- Example request
{ - "server": { - "tenant_id": "c685484a8cc2416b97260938705deb65", - "image": { - "links": [ - { - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" - } - ], - "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" - }, - "accessIPv4": "", - "addresses": { - "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ - { - "addr": "192.168.0.107", - "version": 4 - } - ] - }, - "metadata": { - "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" - }, - "accessIPv6": "", - "created": "2017-05-24T06:14:05Z", - "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", - "flavor": { - "links": [ - { - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" - } - ], - "id": "physical.83.medium" - }, - "OS-DCF:diskConfig": "MANUAL", - "user_id": "1311c433dd9b408886f57d695c229cbe", - "name": "new-server-test", - "progress": 0, - "links": [ - { - "rel": "self", - "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" - }, - { - "rel": "bookmark", - "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" - } - ], - "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", - "updated": "2017-05-25T03:40:25Z", - "status": "ACTIVE" - } -} +55
{ + "server": { + "tenant_id": "c685484a8cc2416b97260938705deb65", + "image": { + "links": [ + { + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" + } + ], + "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" + }, + "accessIPv4": "", + "addresses": { + "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ + { + "addr": "192.168.0.107", + "version": 4 + } + ] + }, + "metadata": { + "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" + }, + "accessIPv6": "", + "created": "2017-05-24T06:14:05Z", + "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", + "flavor": { + "links": [ + { + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" + } + ], + "id": "physical.83.medium" + }, + "OS-DCF:diskConfig": "MANUAL", + "user_id": "1311c433dd9b408886f57d695c229cbe", + "name": "new-server-test", + "progress": 0, + "links": [ + { + "rel": "self", + "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" + }, + { + "rel": "bookmark", + "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" + } + ], + "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", + "updated": "2017-05-25T03:40:25Z", + "status": "ACTIVE" + } +}
- Example request
BMS NIC Management
+BMS NIC Management
-
diff --git a/docs/bms/api-ref/en-us_topic_0053158712.html b/docs/bms/api-ref/en-us_topic_0053158712.html
index 913e5f34..3de1674b 100644
--- a/docs/bms/api-ref/en-us_topic_0053158712.html
+++ b/docs/bms/api-ref/en-us_topic_0053158712.html
@@ -1,10 +1,10 @@
-
- If the metadata does not contain the target field, the field is automatically added to the field.
- If the metadata contains the target field, the field value is automatically updated.
Updating BMS Metadata (Native OpenStack API)
-Function
This API is used to update BMS metadata.
+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.
+Constraints
The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, or paused.
URI
POST /v2.1/{project_id}/servers/{server_id}/metadata
Table 1 lists the parameters.
@@ -29,8 +29,8 @@ - With an optional parameter
Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
- Example request@@ -149,11 +149,11 @@ 2 3 4 -5
1POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata +
- Example request@@ -95,11 +95,11 @@ 2 3 4 -5
1POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata
{ - "metadata": { - "key": "value" - } - } +5
{ + "metadata": { + "key": "value" + } + }
- Example request
- Example request
- With no optional parameter
{ - "metadata": { - "key": "value" - } - } +5
{ + "metadata": { + "key": "value" + } + }
Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
- Example request
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0060384657.html b/docs/bms/api-ref/en-us_topic_0060384657.html index e406874e..34a09036 100644 --- a/docs/bms/api-ref/en-us_topic_0060384657.html +++ b/docs/bms/api-ref/en-us_topic_0060384657.html @@ -1,6 +1,6 @@ --
1DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/9ab74d89-61e7-4259-8546-465fdebe4944 +
- Example request
diff --git a/docs/bms/api-ref/en-us_topic_0053158716.html b/docs/bms/api-ref/en-us_topic_0053158716.html index cbf947dc..8842e61d 100644 --- a/docs/bms/api-ref/en-us_topic_0053158716.html +++ b/docs/bms/api-ref/en-us_topic_0053158716.html @@ -1,7 +1,7 @@ -1DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/9ab74d89-61e7-4259-8546-465fdebe4944
Restarting a BMS (Native OpenStack API)
-Function
This API is used to restart a single BMS.
+Restarting a BMS (Native OpenStack API)
+Function
This API is used to restart a single BMS.
@@ -28,8 +28,8 @@Constraints
Currently, only forcible restart is supported.
Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
Object
Specifies the operation of restarting the BMS. For details, see Table 2.
+Specifies the operation of restarting the BMS. For details, see Table 2.
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0060323087.html b/docs/bms/api-ref/en-us_topic_0060323087.html index 737f4a1e..7fe4a5a6 100644 --- a/docs/bms/api-ref/en-us_topic_0060323087.html +++ b/docs/bms/api-ref/en-us_topic_0060323087.html @@ -8,6 +8,8 @@
1POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action +
- Example request@@ -94,11 +94,11 @@ 2 3 4 -5
1POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action
{ - "reboot": { - "type": "HARD" - } -} +5
{ + "reboot": { + "type": "HARD" + } +}
- Example request
- Error Codes
+ - Task Responses
+
BMS SSH Key Pair Management
+BMS SSH Key Pair Management
-
diff --git a/docs/bms/api-ref/en-us_topic_0060384658.html b/docs/bms/api-ref/en-us_topic_0060384658.html
index 1140818d..65ff1e18 100644
--- a/docs/bms/api-ref/en-us_topic_0060384658.html
+++ b/docs/bms/api-ref/en-us_topic_0060384658.html
@@ -29,7 +29,7 @@
- Example request
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0060384659.html b/docs/bms/api-ref/en-us_topic_0060384659.html index 48865488..1d6b937a 100644 --- a/docs/bms/api-ref/en-us_topic_0060384659.html +++ b/docs/bms/api-ref/en-us_topic_0060384659.html @@ -35,7 +35,7 @@
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs +
- Example request
@@ -126,18 +126,18 @@ 9 10 11 -121GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs
{ - "keypairs": [ - { - "keypair": { - "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a", - "name": "keypair-test", - "type": "ssh", - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova" - } - } - ] -} +12
{ + "keypairs": [ + { + "keypair": { + "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a", + "name": "keypair-test", + "type": "ssh", + "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova" + } + } + ] +}
- Example request
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0060384660.html b/docs/bms/api-ref/en-us_topic_0060384660.html index 0823a016..64805e45 100644 --- a/docs/bms/api-ref/en-us_topic_0060384660.html +++ b/docs/bms/api-ref/en-us_topic_0060384660.html @@ -2,7 +2,7 @@
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs/keypair-test +
- Example request
@@ -151,19 +151,19 @@ 10 11 12 -131GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs/keypair-test
{ - "keypair": { - "created_at": "2019-05-07T12:06:13.681238", - "deleted": false, - "deleted_at": null, - "fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01", - "id": 1, - "name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314", - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd+GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/9IXRx1ERImsqZnE9usB Generated-by-Nova", - "updated_at": null, - "user_id": "fake" - } -} +13
{ + "keypair": { + "created_at": "2019-05-07T12:06:13.681238", + "deleted": false, + "deleted_at": null, + "fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01", + "id": 1, + "name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314", + "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd+GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/9IXRx1ERImsqZnE9usB Generated-by-Nova", + "updated_at": null, + "user_id": "fake" + } +}
Creating and Importing an SSH Key Pair (Native OpenStack API)
diff --git a/docs/bms/api-ref/en-us_topic_0060384661.html b/docs/bms/api-ref/en-us_topic_0060384661.html index b3dd784d..a53369c3 100644 --- a/docs/bms/api-ref/en-us_topic_0060384661.html +++ b/docs/bms/api-ref/en-us_topic_0060384661.html @@ -35,7 +35,7 @@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.
+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.
@@ -70,7 +70,7 @@String
Specifies the imported public key. The maximum size of the imported public key is 1024 bytes.
-Note: If the length of the public key to be imported exceeds 1024 bytes, the public key import to the BMS will fail.
+Note: If the length of the public key to be imported exceeds 1024 bytes, the public key import to the BMS will fail.
name
@@ -87,7 +87,7 @@ -- Example request@@ -182,14 +182,14 @@ 5 6 7 -8
1POST https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs +
- Example request@@ -96,12 +96,12 @@ 3 4 5 -6
1POST https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs
{ - "keypair": { - "name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043", - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD+htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n" - } -} +6
{ + "keypair": { + "name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043", + "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD+htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n" + } +}
- Example request
{ - "keypair": { - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD+htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n", - "user_id": "f882feb345064e7d9392440a0f397c25", - "name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043", - "fingerprint": "35:9d:d0:c3:4a:80:d3:d8:86:f1:ca:f7:df:c4:f9:d8" - } -} +8
{ + "keypair": { + "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC9mC3WZN9UGLxgPBpP7H5jZMc6pKwOoSgre8yun6REFktn/Kz7DUt9jaR1UJyRzHxITfCfAIgSxPdGqB/oF1suMyWgu5i0625vavLB5z5kC8Hq3qZJ9zJO1poE1kyD+htiTtPWJ88e12xuH2XB/CZN9OpEiF98hAagiOE0EnOS5Q== Generated by Nova\n", + "user_id": "f882feb345064e7d9392440a0f397c25", + "name": "keypair-7d7c3650-dabe-4eb0-b904-5c464453c043", + "fingerprint": "35:9d:d0:c3:4a:80:d3:d8:86:f1:ca:f7:df:c4:f9:d8" + } +}
- Example request
- Example request
Request
- Request parameters -
- Example request-
1DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs/keypair-test +
- Example request
diff --git a/docs/bms/api-ref/en-us_topic_0060402469.html b/docs/bms/api-ref/en-us_topic_0060402469.html index a1eabfa0..2d6798ce 100644 --- a/docs/bms/api-ref/en-us_topic_0060402469.html +++ b/docs/bms/api-ref/en-us_topic_0060402469.html @@ -1,7 +1,7 @@ -1DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/os-keypairs/keypair-test
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.
+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.
@@ -28,8 +28,8 @@Constraints
Pagination query is not supported.
Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0060410925.html b/docs/bms/api-ref/en-us_topic_0060410925.html index ca55d9f3..314b24ac 100644 --- a/docs/bms/api-ref/en-us_topic_0060410925.html +++ b/docs/bms/api-ref/en-us_topic_0060410925.html @@ -1,6 +1,6 @@ -
1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata +
- Example request
@@ -66,10 +66,10 @@ 2 3 4 -51GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata
{ - "metadata": { - "key": "value" - } +5
{ + "metadata": { + "key": "value" + } }
BMS 1D Tag Management
+BMS 1D Tag Management
-
diff --git a/docs/bms/api-ref/en-us_topic_0060410926.html b/docs/bms/api-ref/en-us_topic_0060410926.html
index fab4b3e8..766235e2 100644
--- a/docs/bms/api-ref/en-us_topic_0060410926.html
+++ b/docs/bms/api-ref/en-us_topic_0060410926.html
@@ -1,7 +1,7 @@
-
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0060410927.html b/docs/bms/api-ref/en-us_topic_0060410927.html index bf6c7c42..4323f734 100644 --- a/docs/bms/api-ref/en-us_topic_0060410927.html +++ b/docs/bms/api-ref/en-us_topic_0060410927.html @@ -1,10 +1,10 @@ -
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags +
- Example request
@@ -68,13 +68,13 @@ 4 5 6 -71GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags
{ - "tags": [ - "baz", - "foo", - "qux" - ] -} +7
{ + "tags": [ + "baz", + "foo", + "qux" + ] +}
Adding Tags to a BMS (Native OpenStack API)
-Function
This API is used to add tags to a BMS.
+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.
@@ -31,8 +31,8 @@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.
Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
- Example request
Querying BMS Tags (Native OpenStack API)
-Function
This API is used to query all tags of a BMS.
+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
@@ -27,8 +27,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
Request
- Example request
- Example request
@@ -110,13 +110,13 @@ 4 5 6 -71PUT https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags +
- Example request
@@ -72,13 +72,13 @@ 4 5 6 -71PUT https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags
{ - "tags": [ - "baz", - "foo", - "qux" - ] -} +7
{ + "tags": [ + "baz", + "foo", + "qux" + ] +}
{ - "tags": [ - "baz", - "foo", - "qux" - ] -} +7
{ + "tags": [ + "baz", + "foo", + "qux" + ] +}
- Example request
Deleting Tags of a BMS (Native OpenStack API)
-Function
This API is used to delete all tags of a BMS.
+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.
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
@@ -31,7 +31,7 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
Request
- Request parameters -
- Example request
1DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags +
- Example request
diff --git a/docs/bms/api-ref/en-us_topic_0060410929.html b/docs/bms/api-ref/en-us_topic_0060410929.html index 9a20075e..b22ae27b 100644 --- a/docs/bms/api-ref/en-us_topic_0060410929.html +++ b/docs/bms/api-ref/en-us_topic_0060410929.html @@ -1,11 +1,11 @@ -1DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags
Adding a Tag to a BMS (Native OpenStack API)
-Function
This API is used to add a tag to a BMS.
+Adding a Tag to a BMS (Native OpenStack API)
+Function
This API is used to add a tag to a BMS.
You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.
Constraints
- A BMS can have a maximum of 50 tags.
- The tag contains a maximum of 80 characters.
- The tag cannot start with a period (.).
- An empty tag cannot be created.
It is recommended that you add the __type_baremetal tag to BMSs to distinguish BMSs from ECSs.
+ 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}
@@ -32,7 +32,7 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
tag
@@ -49,7 +49,7 @@Request
- Request parameters -
- Example request
1PUT https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags/{tag} +
- Example request
diff --git a/docs/bms/api-ref/en-us_topic_0060410930.html b/docs/bms/api-ref/en-us_topic_0060410930.html index da0a2d10..940b0a22 100644 --- a/docs/bms/api-ref/en-us_topic_0060410930.html +++ b/docs/bms/api-ref/en-us_topic_0060410930.html @@ -1,7 +1,7 @@ -1PUT https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags/{tag}
Checking for Tags of a BMS (Native OpenStack API)
-Function
This API is used to check whether a BMS has a specified tag.
+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}
@@ -27,8 +27,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
tag
@@ -37,7 +37,7 @@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.
- URL encoding is required for special characters.
- If no tag key is specified, all tags of the BMS are displayed.
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0060424486.html b/docs/bms/api-ref/en-us_topic_0060424486.html index 80cc5f8b..f231aa91 100644 --- a/docs/bms/api-ref/en-us_topic_0060424486.html +++ b/docs/bms/api-ref/en-us_topic_0060424486.html @@ -1,11 +1,11 @@ -
1GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/2d85af7c-cbfe-40c5-a378-4d03b42fb0e2/tags/{tag} +
- Example request
@@ -58,12 +58,12 @@ 3 4 5 -61GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/2d85af7c-cbfe-40c5-a378-4d03b42fb0e2/tags/{tag}
{ - "itemNotFound": { - "message": "Server 2d85af7c-cbfe-40c5-a378-4d03b42fb0e2 has no tag 'abc'", - "code": 404 - } -} +6
{ + "itemNotFound": { + "message": "Server 2d85af7c-cbfe-40c5-a378-4d03b42fb0e2 has no tag 'abc'", + "code": 404 + } +}
Deleting a Tag of a BMS (Native OpenStack API)
-Function
This API is used to delete a tag of a BMS.
+Deleting a Tag of a BMS (Native OpenStack API)
+Function
This API is used to delete a tag of a BMS.
You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.
Constraints
- The tag contains a maximum of 80 characters.
- If a tag contains non-URL-safe characters, perform URL encoding.
- Tag __type_baremetal is used to identify a BMS. You are not advised to delete this tag. Otherwise, the BMS will be displayed only on the ECS console.
- After deleting the __type_baremetal tag, you can add it again by following the instructions in Adding a Tag to a BMS (Native OpenStack API). After the tag is added, the BMS will be displayed on the BMS console.
- 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}
@@ -31,8 +31,8 @@Yes
Specifies the BMS ID.
-You can obtain the BMS ID from the BMS console or using the Querying BMSs (Native OpenStack API) API.
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
tag
@@ -41,7 +41,7 @@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.
- A tag can contain a maximum of 80 characters. If a tag contains non-URL-safe characters, perform URL encoding.
- If no key is specified, all tags of the BMS are deleted.
Request
- Request parameters -
- Example request
1DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags/{tag} +
- Example request
diff --git a/docs/bms/api-ref/en-us_topic_0060602044.html b/docs/bms/api-ref/en-us_topic_0060602044.html new file mode 100644 index 00000000..8455fa75 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0060602044.html @@ -0,0 +1,31 @@ + + +1DELETE https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags/{tag}
BMS APIs
+ ++ ++ diff --git a/docs/bms/api-ref/en-us_topic_0106040941.html b/docs/bms/api-ref/en-us_topic_0106040941.html new file mode 100644 index 00000000..1f4bde08 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0106040941.html @@ -0,0 +1,871 @@ + + +Creating BMSs
+++Function
This API is used to create one or more BMSs.
++Background for Setting the Login Authentication Mode
Logging in to a BMS can be authenticated using either a key pair or password. For security purposes, you are advised to use key pair authentication.
+- Key pair
A key pair is used for BMS login authentication.
+Method of calling APIs: Use the key_name field to specify the key file used for logging in to the BMS. For details about how to use the key_name field, see Table 2.
+ - Password
If you choose the initial password for authentication in a BMS, you can log in to a BMS using the username and its initial password. The initial password of user root is used for authentication in Linux.
+Methods of calling APIs:
+- Method 1 (recommended): Use the adminPass field to specify the initial login password of the specified administrator account. For details about how to use the adminPass field, see Table 2.+
For Linux BMSs with Cloud-Init, if field user_data is specified, field adminPass is invalid.
+ - Method 2:
- For Linux BMSs with Cloud-Init, use the user_data field to inject data. For details, see Table 2.
+ Public images contain Cloud-Init or Cloudbase-Init by default. For private images, you need to check whether Cloud-Init or Cloudbase-Init is installed.
+ - Method 1 (recommended): Use the adminPass field to specify the initial login password of the specified administrator account. For details about how to use the adminPass field, see Table 2.
+Constraints
- File injection is not supported.
+++URI
POST /v1/{project_id}/baremetalservers
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
++Request Parameters
++ +
+Parameter
+Mandatory
+Type
+Description
+server
+Yes
+Object
+Specifies BMS information. For details, see Table 2.
++ +
+Table 2 server field data structure description Parameter
+Mandatory
+Type
+Description
+imageRef
+Yes
+String
+Specifies the image ID or image resource URL used for creating the BMS. The ID is in the format of a Universally Unique Identifier (UUID).
+You can obtain the image ID from the IMS console or by following the instructions in "Querying Images" in Image Management Service API Reference.
+When using an API to query images, you can add the field ?virtual_env_type=Ironic to filter BMS images.
+flavorRef
+Yes
+String
+Specifies the flavor ID of the BMS. The format is physical.x.x.
+You can obtain the flavor ID from the BMS console or using the Querying Details About Flavors and Extended Flavor Information API.
+name
+Yes
+String
+Specifies the BMS name.
+Value range:
+- The value can contain a maximum of 63 characters consisting of letters (case-insensitive), digits, underscores (_), hyphens (-), and periods (.).
- If more than one BMS is to be created, tags similar to -0000 will be automatically added to the end of the BMS names during the creation. In this case, the BMS name contains 1 to 58 characters.
metadata
+Yes
+Object
+Specifies the BMS metadata. The maximum size for both the metadata key and value is 255 characters. For details, see Table 3.
+user_data
+No
+String
+Specifies the user data to be injected during the BMS creation. Text can be injected.
+Constraints:
+- The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding) is 32 KB.
- If key_name is not specified, the password of user root for logging in to the BMS will be injected by default.
Password complexity requirements:
+- Contains 8 to 26 characters.
- Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?
An example is as follows:
+- Use a plaintext password (risky in security), for example, cloud.1234.++ +
1 +2
#!/bin/bash +echo 'root:Cloud.1234' | chpasswd ; +
- Use a password.++ +
1 +2
#!/bin/bash +echo 'root:$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig' | chpasswd -e +
where, $6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig is the ciphertext password, which can be generated as follows:
+- Generate an encrypted salt value.++ +
1 +2
[root@test linux]# python -c "import crypt, getpass, pwd;print crypt.mksalt()" +$6$V6azyeLwcD3CHlpY +
- Generate a ciphertext password based on the salt value.++ +
1 +2
[root@test linux]# python -c "import crypt, getpass, pwd;print crypt.crypt('Cloud.1234','\$6\$V6azyeLwcD3CHlpY')" + $6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig +
NOTE:+Data injection is not supported for BMSs that use a Linux image and the password login mode.
+adminPass
+No
+String
+Specifies the initial login password of the administrator account for logging in to a BMS using password authentication. The Linux administrator is root.
+Password complexity requirements:+- Contains 8 to 26 characters.
- Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?
- (Linux OSs) Cannot contain the username or the username in reverse.
key_name
+No
+String
+Specifies the name of a key pair. This is an extended attribute. To log in to a BMS using an SSH key pair, set the value to the name of an existing private key.
+You can create a key pair using the Creating and Importing an SSH Key Pair (Native OpenStack API) API, or query existing key pairs using the Querying SSH Key Pairs (Native OpenStack API) API.
+Constraints:
+- If both key_name and user_data are specified, user_data only injects user data.
security_groups
+No
+Array of objects
+Specifies security groups of the BMS. For details, see Table 4.
+nics
+Yes
+Array of objects
+Specifies NICs of the BMS. For details, see Table 5.
+Constraints:
+A maximum of two NICs can be attached to a BMS. The first will be used as the primary NIC. If multiple NICs are specified, ensure that all NICs belong to the same VPC.
+availability_zone
+Yes
+String
+Specifies the name of the AZ where the BMS is located.
+vpcid
+Yes
+String
+Specifies the ID of the VPC to which the BMS belongs. The value is in UUID format. You can obtain the VPC ID from the network console or by following the instructions in "Querying VPC Details" of Virtual Private Cloud API Reference.
+publicip
+No
+Object
+Specifies the EIP information of the BMS. Possible values include:
+- Do not use (This parameter is unavailable.)
- Automatically assign: Assign a new EIP.
- Specify: Specify an EIP that has been created.
For details, see Table 6.
+count
+No
+Integer
+Specifies the number of BMSs to be created.
+Constraints:
+- If this parameter is not specified, the default value is 1.
- If the quota is sufficient, the maximum value is 24.
root_volume
+No
+Object
+Specifies system disk configurations of the BMS. For details, see Table 7.
+Constraints:
+If the flavor supports quick provisioning, this parameter is mandatory. Otherwise, this parameter is not required. For how to check whether a flavor supports quick provisioning, see Querying Details About extra_specs Parameters of a BMS Flavor (Native OpenStack API).
+data_volumes
+No
+Array of objects
+Specifies data disk configurations of the BMS. Each data structure represents a data disk to be created. For details, see Table 8.
+Constraints:
+A maximum of 40 EVS disks (including the system disk and data disks) can be attached to a BMS.
+extendparam
+Yes
+Object
+Specifies the supplementary for creating the BMS. For details, see Table 9.
+schedulerHints
+No
+Object
+Specifies scheduling information of the BMS. This parameter is mandatory for creating a BMS in a DeC.
+For details, see Table 10.
+server_tags
+No
+Map<String,String>
+Specifies tags of the BMS.
+- Key: A tag key contains a maximum of 36 Unicode characters. It cannot be left blank. The tag key of a BMS must be unique. It cannot contain ASCII characters (0–31) or special characters =*<>\,|/
- Value: A tag value contains a maximum of 43 Unicode characters and can be left blank. It cannot contain ASCII characters (0–31) or special characters =*<>\,|/
NOTE:+A maximum of 10 tags can be added to a BMS. __type_baremetal is an internal tag of the system. Therefore, you can add a maximum of nine tags.
++ +
+Table 3 metadata field data structure description Parameter
+Mandatory
+Type
+Description
+op_svc_userid
+Yes
+String
+Specifies the user ID. You can obtain the user ID from My Credential on the management console.
+BYOL
+No
+String
+Specifies whether a license is provided. The value can be true or false.
+admin_pass
+No
+String
+Specifies the initial password of the administrator account for logging in to a BMS. For Linux, the administrator account is root.
+Password complexity requirements:+- Contains 8 to 26 characters.
- Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?
- Cannot contain the username, the username in reverse, or more than two consecutive characters in the username.
agency_name
+No
+String
+Specifies the IAM agency name.
+An agency provides a temporary security credential for accessing a BMS. The agency is created by the tenant administrator on the IAM console.
++ +
+Table 4 security_groups field data structure description Parameter
+Mandatory
+Type
+Description
+id
+No
+String
+Specifies the security group ID, which takes effect for all NICs configured for the BMS.
+- If this parameter is not specified, the default security group will be bound to the BMS.
- If this parameter is required (in UUID format), use the ID of an existing security group. For details about how to obtain existing security groups, see "Querying Security Groups" in Virtual Private Cloud API Reference.
+ +
+Table 5 nics field data structure description Parameter
+Mandatory
+Type
+Description
+subnet_id
+Yes
+String
+Specifies the subnet information of a BMS NIC.
+The value must be the ID of the subnet (network_id) created in the VPC specified by vpcid and in the format of UUID. You can obtain the subnet ID (network_id) from the VPC console or by following the instructions in "Querying Subnets" in Virtual Private Cloud API Reference.
+port_id
+No
+String
+Specifies the BMS NIC ID. If this parameter is not left blank, a NIC is specified. In this case, subnet_id, security_groups, ip_address, ipv6_enable, and ipv6_bandwidth are invalid.
+You can obtain the NIC ID from the VPC console or by following the instructions in "Querying Ports" in Virtual Private Cloud API Reference.
+Constraints:
+- The NIC must be in DOWN state.
- The VPC ID of the NIC must match the VPC of the BMS.
ip_address
+No
+String
+Specifies the IPv4 address of a BMS NIC.
+Constraints:
+- If this parameter is left blank or set to "", an unused IP address in the subnet of this network is automatically assigned as the IP address of the NIC.
- If this parameter is specified, its value must be an unused IP address in the network segment of the subnet.
- The IP address cannot be specified when you create BMSs in a batch.
+
+Table 6 publicip field data structure description Parameter
+Mandatory
+Type
+Description
+id
+No
+String
+Specifies the ID of an existing EIP assigned to the BMS. The value is in UUID format. You can obtain the EIP ID from the network console or by following the instructions in "Querying EIPs" in Elastic IP API Reference.
+Constraints:
+- Only EIPs in the DOWN state can be assigned.
- Existing EIPs cannot be used for creating BMSs in a batch. That is, this parameter is invalid in such a case.
eip
+No
+Object
+Specifies the configuration for creating an EIP that will be automatically assigned to the BMS. For details, see Table 11.
++ + You can configure either but not both of id and eip in the publicip field.
++ +
+Table 7 root_volume field data structure description Parameter
+Mandatory
+Type
+Description
+volumetype
+Yes
+String
+Specifies the BMS system disk type. The disk type must match the available disk type.
+- SAS: high I/O disk type
- SSD: ultra-high I/O disk type
size
+Yes
+Integer
+Specifies the system disk size (GB). The value ranges from 40 to 1024.
+Constraints:
+The system disk size must be greater than or equal to the minimum system disk size of the image (min_disk attribute).
++ +
+Table 8 data_volumes field data structure description Parameter
+Mandatory
+Type
+Description
+volumetype
+Yes
+String
+Specifies the BMS data disk type. The disk type must match the available disk type.
+- SAS: high I/O disk type
- SSD: ultra-high I/O disk type
size
+Yes
+Integer
+Specifies the data disk size (GB). The value ranges from 10 to 32768.
+shareable
+No
+Boolean
+Specifies whether the disk is shareable.
+- true: shared EVS disk
- false: common EVS disk
The default value is false.
++ +
+Table 9 extendparam field data structure description Parameter
+Mandatory
+Type
+Description
+chargingMode
+No
+String
+Specifies the billing mode. Value range:
+postPaid: pay-per-use billing
+regionID
+No
+String
+Specifies the ID of the region where the BMS resides.
++ +
+Table 10 schedulerHints field data structure description Parameter
+Mandatory
+Type
+Description
+dec_baremetal
+No
+String
+Specifies whether to create the BMS in a DeC. The value can be share or dedicate.
+Constraints:
+- If this parameter is not specified, the default value is share.
- To create a BMS in a DeC, set this parameter to dedicate.
+ +
+Table 11 eip field data structure description Parameter
+Mandatory
+Type
+Description
+iptype
+Yes
+String
+Specifies the EIP type.
+Enumerated values: 5_bgp and 5_sbgp
+For details, see the publicip field in "Assigning an EIP" in Elastic IP API Reference.
+bandwidth
+Yes
+Object
+Specifies the EIP bandwidth. For details, see Table 12.
+extendparam
+Yes
+Object
+Provides additional information about the EIP. For details, see Table 13.
++ +
+Table 12 bandwidth field data structure description Parameter
+Mandatory
+Type
+Description
+name
+No
+String
+Specifies the bandwidth name.
+sharetype
+Yes
+String
+Specifies the bandwidth sharing type.
+Value PER indicates dedicated bandwidth and WHOLE indicates shared bandwidth.
+id
+No
+String
+Specifies the shared bandwidth ID. You can specify an existing shared bandwidth when applying for an EIP with a WHOLE bandwidth.
+NOTE:+This parameter is mandatory when sharetype is set to WHOLE.
+size
+Yes
+Integer
+- The value ranges from 5 Mbit/s to 2000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can view the bandwidth range of each region on the management console.)
- Specifies the bandwidth (Mbit/s). The minimum shared bandwidth is 5 Mbit/s by default.
NOTE:+- If a decimal fraction (for example 10.2) or a character string (for example 10) is specified, the specified value will be automatically converted to an integer. If the bandwidth is less than 300 Mbit/s, the step is 1 Mbit/s. If the bandwidth is from 300 Mbit/s to 1000 Mbit/s, the step is 50 Mbit/s. If the bandwidth is from 1000 Mbit/s to 2000 Mbit/s, the step is 1000 Mbit/s.
- This parameter is mandatory when sharetype is set to PER and is optional when sharetype is set to WHOLE with an ID specified.
chargemode
+No
+String
+Specifies the bandwidth billing mode.
+The value can be traffic or bandwidth.
+- If this field is not specified, the BMS is billed by bandwidth.
- If the field value is empty, the BMS is billed by bandwidth.
+
+Table 13 extendparam field data structure description for assigning an EIP Parameter
+Mandatory
+Type
+Description
+chargingMode
+Yes
+String
+Specifies the billing mode of an EIP. If bandwidth is charged by bandwidth, both prePaid and postPaid will be available for EIP. If bandwidth is charged by traffic, only postPaid will be available for EIP.
+Value range:
+- prePaid
- postPaid
+ +Example Request
- Creating a pay-per-use BMS
{ + "server": + { + "count": 1, + "extendparam": + { + "chargingMode": "postPaid" + }, + "vpcid": "8b4e7a59-2bb9-4daf-a31a-2e72db451a3e", + "name": "bms-local", + "imageRef": "b7d6d5a1-7588-421c-8730-8a2b5549e5d9", + "availability_zone": "eu-de-01", + "nics": [ + { + "subnet_id": "9cdc46bc-4d1a-44a9-af13-492f533d0299", + "ip_address": "" + }], + "flavorRef": "physical.comtest07.large.ondemand", + "adminPass": "Test", + "user_data": "IyEvYmluL2Jhc2gKZWNobyAncm9vdDpIdWF3ZWkxMicgfCBjaHBhc3N3ZCA7", + "metadata": + { + "admin_pass": "", + "BYOL": "false", + "op_svc_userid": "e81efc34179c4186bd2bd4f9a2378cac" + } + } +}+
+ +Response Parameters
++
+Table 14 Normal response Parameter
+Type
+Description
+order_id
+String
+Specifies the order ID returned after an order is submitted. You can query the order processing progress based on the ID.
+job_id
+String
+Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
++ +
+Table 15 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure [1]
+Specifies the error returned when a task submission encounters an exception. For details, see error data structure.
++
+Table 16 error data structure Parameter
+Type
+Description
+message
+String
+Specifies the error message.
+code
+String
+Specifies the error code.
++Example Response
- Normal response
{ + "order_id": "CS2009141523OQSEQ", + "job_id": "ff808081748b760c01748b7f80370003" +}+
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0107541808.html b/docs/bms/api-ref/en-us_topic_0107541808.html index 551cb9bf..22bec982 100644 --- a/docs/bms/api-ref/en-us_topic_0107541808.html +++ b/docs/bms/api-ref/en-us_topic_0107541808.html @@ -31,7 +31,7 @@++Parent topic: BMS Lifecycle Management+BMS.0002
BMS has not been launched.
+BMS has not been launched.
The BMS service is unavailable.
BMS.0011
The images do not support BMS.
+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.0219
+Failed to change the BMS name.
+OpenStack nova change ServerName fail.
+Contact technical support.
+400
BMS.0018
@@ -251,7 +262,7 @@BMS.0025
The number of BMSs exceeds the quota.
+The number of BMSs exceeds the quota.
The number of cloud servers has reached the maximum allowed.
BMS.0026
The number of BMS CPUs exceeds the quota.
+The number of BMS CPUs exceeds the quota.
The number of CPU cores used by all cloud servers has reached the maximum allowed.
BMS.0027
The BMS memory exceeds the quota.
+The BMS memory exceeds the quota.
The memory space used by all cloud servers has reached the maximum allowed.
BMS.0028
The number of BMSs and that of CPUs exceed the quotas.
+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.
BMS.0029
The number of BMSs and the memory exceed the quotas.
+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.
BMS.0030
The BMS memory and the number of CPUs exceed the quotas.
+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.
BMS.0031
The number of BMSs, the number of CPUs, and the memory exceed the quotas.
+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.
BMS.0032
Contact technical support to apply for a BMS.
+Contact technical support to apply for a BMS.
Token check fail.
BMS.0034
Currently, BMSs cannot be automatically provisioned.
+Currently, BMSs cannot be automatically provisioned.
Not support create Bare Metal Server.
BMS.0106
The AZ of data disks is different from that of the BMS.
+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.
+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.
+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.
+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.
+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.
BMS.1002
The number of data disks that can be attached to the BMS exceeds the quota.
+The number of data disks that can be attached to the BMS exceeds the quota.
Attach volume fail, server %s attachment num over limit.
BMS.1004
The number of shared data disks that can be attached to the BMS exceeds the quota.
+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.
BMS.1006
The running status of the BMS cannot be obtained.
+The running status of the BMS cannot be obtained.
Server %s info is null or its status or its metadata is null.
BMS.1009
The data disk has been attached to the BMS.
+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.
BMS.3035
No matching disk is found for the BMS.
+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.
+Ensure that the disk matches the BMS or contact technical support.
400
@@ -616,7 +627,7 @@BMS.0201
The parameters for creating the BMS are incorrectly configured.
+The parameters for creating the BMS are incorrectly configured.
Fail to check the baremetal server params, reason: %s.
Change or delete the BMS quantity.
400
+400
BMS.0206
+BMS.0206
Invalid name.
+The name contains invalid characters.
The length of baremetal server name[%s] is %s.
+The baremetal server name [%s] is include invalid char.
Change the name as required.
+Change the name as prompted.
400
BMS.0207
No IP address can be specified when BMSs are created in a batch.
+No IP address can be specified when BMSs are created in a batch.
VPC is illegal, reason: %s.
BMS.0114
The disk to be detached is not in the disk list of the BMS.
+The disk to be detached is not in the disk list of the BMS.
Volume %s is not in server %s attach volume list.
BMS.0039
The BMS has been shut down.
+The BMS has been shut down.
Server is stopped, not allow to stop.
BMS.0040
The BMS does not exist.
+The BMS does not exist.
The server does not exist.
BMS.0035
The BMS is being powered on and no other operations are allowed.
+The BMS is being powered on and no other operations are allowed.
Server is powering on, not allow to %s.
BMS.0036
The BMS is being powered off and no other operations are allowed.
+The BMS is being powered off and no other operations are allowed.
Server is powering off, not allow to %s.
BMS.0038
The BMS is running and cannot be started.
+The BMS is running and cannot be started.
Server is running, not allow to start.
See the returned error message or contact technical support.
+Do not start the BMS again.
400
@@ -913,7 +924,7 @@BMS.0071
If an EIP has been specified for creating the BMS, no other EIP can be created for the BMS.
+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.
BMS.0072
An EIP cannot be used to create multiple BMSs.
+An EIP cannot be used to create multiple BMSs.
An existing EIP cannot be assigned to the ECSs created in batches.
BMS.0360
The disk has been frozen and cannot be operated for the BMS.
+The disk has been frozen and cannot be operated for the BMS.
This operation cannot be performed because EVS Disk %s is frozen.
BMS.0395
Windows BMSs do not support remote login.
+Windows BMSs do not support remote login.
The server[%s] is windows system and can not support remote login.
Changing the BMS Name
+++Function
This API is used to change the name of a BMS.
++Constraints
The new name must meet the following requirements:
+Contain 1 to 63 characters, consisting of letters (case-insensitive), digits, underscores (_), hyphens (-), and periods (.).
++ This API can only be used to change the BMS name. The hostname will not be changed. The new name takes effect after the BMS is restarted.
++URI
PUT /v1/{project_id}/baremetalservers/{server_id}
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
- Request parameters
++ + +
+Parameter
+Mandatory
+Type
+Description
+server
+Yes
+Object
+Specifies the BMS data structure. For details, see Table 2.
+
- Example request++ +
1PUT https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/95bf2490-5428-432c-ad9b-5e3406f869dd +
++ +1 +2 +3 +4 +5 +6
{ + "server": + { + "name": "new-server-test" + } +} +
+Response
- Response parameters
++ +
+Parameter
+Type
+Description
+server
+Object
+Specifies BMS information. For details, see Table 3.
++ +
+Table 3 server field data structure description Parameter
+Type
+Description
+name
+String
+Specifies the BMS name.
+id
+String
+Specifies the unique ID of the BMS.
+status
+String
+Specifies the BMS status.
+- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
created
+String
+Specifies the time when the BMS was created.
+The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T03:30:52Z.
+updated
+String
+Specifies the time when the BMS was last updated.
+The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T04:30:52Z.
+flavor
+Object
+Specifies the BMS flavor. For details, see Table 6.
+image
+Object
+Specifies the BMS image. For details, see Table 7.
+tenant_id
+String
+Specifies the ID of the tenant owning the BMS. The value is in UUID format.
+This parameter specifies the same meaning as project_id.
+key_name
+String
+Specifies the SSH key name.
+user_id
+String
+Specifies the ID of the user to which the BMS belongs.
+metadata
+Object
+Specifies the BMS metadata. For details, see Table 9.
+hostId
+String
+Specifies the host ID of the BMS.
+addresses
+Object
+Specifies BMS network addresses. For details, see Table 10.
+security_groups
+Array of objects
+Specifies the security groups to which the BMS belongs. For details, see Table 12.
+links
+Array of objects
+Specifies shortcut links of the BMS. For details, see Table 8.
+OS-DCF:diskConfig
+String
+Specifies the disk configuration method. This is an extended attribute. The value can be:
+- MANUAL: The API uses the partitioning scheme in the image and the file system to create a BMS. If the target flavor has a large disk, the API does not partition the remaining disk space.
- AUTO: The API uses a single partition with the same size as the disk of the target flavor to create a BMS. The API automatically adjusts the file system to adapt to the entire partition.
OS-EXT-AZ:availability_zone
+String
+Specifies the AZ where the BMS is located.
+OS-EXT-SRV-ATTR:host
+String
+Specifies the hostname of the BMS. This is an extended attribute.
+OS-EXT-SRV-ATTR:hypervisor_hostname
+String
+Specifies the hostname of the hypervisor.
+OS-EXT-SRV-ATTR:instance_name
+String
+Specifies the BMS alias. This is an extended attribute.
+OS-EXT-STS:power_state
+Integer
+Specifies the BMS power status. This is an extended attribute. Examples:
+- 0: indicates NO STATE.
- 1: indicates RUNNING.
- 4: indicates SHUTDOWN.
OS-EXT-STS:task_state
+String
+Specifies the BMS task status. This is an extended attribute. Examples:
+- rebooting: The BMS is being restarted.
- reboot_started: The BMS is normally restarted.
- reboot_started_hard: The BMS is forcibly restarted.
- powering-off: The BMS is being powered off.
- powering-on: The BMS is being powered on.
- rebuilding: The BMS is being rebuilt.
- scheduling: The BMS is being scheduled.
- deleting: The BMS is being deleted.
OS-EXT-STS:vm_state
+String
+Specifies the BMS status. This is an extended attribute. Examples:
+- active: The BMS is running.
- shutoff: The BMS is stopped.
- reboot: The BMS is restarted.
OS-SRV-USG:launched_at
+String
+Specifies the time when the BMS was started. This is an extended attribute.
+The timestamp format is ISO 8601, for example, 2019-05-25T03:40:25.000000.
+OS-SRV-USG:terminated_at
+String
+Specifies the time when the BMS was stopped. This is an extended attribute.
+The timestamp format is ISO 8601, for example, 2019-06-25T03:40:25.000000.
+os-extended-volumes:volumes_attached
+Array of objects
+Specifies the EVS disks attached to the BMS. For details, see Table 13.
+accessIPv4
+String
+This is a reserved attribute.
+accessIPv6
+String
+This is a reserved attribute.
+fault
+Object
+Specifies the cause of a BMS fault. For details, see Table 14.
+config_drive
+String
+This is a reserved attribute.
+progress
+Integer
+This is a reserved attribute.
+description
+String
+Specifies BMS information.
+host_status
+String
+Specifies the status of the host that accommodates the BMS.
+- UP: The nova-compute status is normal.
- UNKNOWN: The nova-compute status is unknown.
- DOWN: the nova-compute status is abnormal.
- MAINTENANCE: The nova-compute is in the maintenance state.
- Empty string: The BMS does not have host information.
OS-EXT-SRV-ATTR:hostname
+String
+Specifies the hostname of the BMS.
+OS-EXT-SRV-ATTR:reservation_id
+String
+Specifies the reserved BMS IDs in a batch creation situation.
+When BMSs are created in a batch, they have the same reservation_id.
+OS-EXT-SRV-ATTR:launch_index
+Integer
+Specifies the BMS startup sequence in a batch creation situation.
+OS-EXT-SRV-ATTR:kernel_id
+String
+Specifies the UUID of the kernel image when the AMI image is used. In other scenarios, leave this parameter blank.
+OS-EXT-SRV-ATTR:ramdisk_id
+String
+Specifies the UUID of the Ramdisk image when the AMI image is used. In other scenarios, leave this parameter blank.
+OS-EXT-SRV-ATTR:root_device_name
+String
+Specifies the device name of the BMS system disk, for example, /dev/sdb.
+OS-EXT-SRV-ATTR:user_data
+String
+Specifies the user_data specified during BMS creation. The value is encoded using Base64 or an empty string.
+locked
+Boolean
+Specifies whether the BMS is locked.
+- true: The BMS is locked.
- false: The BMS is not locked.
tags
+Array of strings
+Specifies tags of the BMS.
+sys_tags
+Array of objects
+Specifies system tags of the BMS. For details, see Table 4.
+enterprise_project_id
+String
+Specifies the enterprise project ID.
+os:scheduler_hints
+Object
+Specifies the BMS scheduling information. For details, see Table 5.
++ +
+Table 4 sys_tags field data structure description Parameter
+Type
+Description
+key
+String
+Specifies the system tag key.
+value
+String
+Specifies the system tag value.
++ +
+Table 5 os:scheduler_hints field data structure description Parameter
+Type
+Description
+group
+Array of strings
+Specifies the BMS group ID in UUID format.
++ +
+Table 6 flavor field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the flavor ID.
+links
+Array of objects
+Specifies shortcut links of the flavor. For details, see Table 8.
++ +
+Table 7 image field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the image ID of the BMS.
+links
+Array of objects
+Specifies shortcut links of the BMS image. For details, see Table 8.
++ +
+Table 8 links field data structure description Parameter
+Type
+Description
+rel
+String
+Specifies the shortcut link marker name. The value can be:
+- self: resource link that contains the version number. It is used when immediate tracing is required.
- bookmark: resource link that can be stored for a long time.
href
+String
+Specifies the corresponding shortcut link.
++ +
+Table 9 metadata field data structure description Parameter
+Type
+Description
+key
+String
+Specifies the key and value pair of the metadata.
+Each key or value contains a maximum of 255 characters.
++ +
+Table 10 addresses field data structure description Parameter
+Type
+Description
+vpc_id
+Array of objects
+Specifies the VPC used by the BMS.
+- key: indicates the ID of the VPC used by the BMS.
- value: indicates the VPC details. For details, see Table 11.
+ +
+Table 11 address field data structure description Parameter
+Type
+Description
+addr
+String
+Specifies the IP address.
+version
+Integer
+Specifies the type of the IP address. The value can be 4 or 6.
+- 4: The type of the IP address is IPv4.
- 6: The type of the IP address is IPv6.
OS-EXT-IPS-MAC:mac_addr
+String
+Specifies the MAC address. This is an extended attribute.
+OS-EXT-IPS:type
+String
+Specifies the IP address assignment mode. This is an extended attribute.
+OS-EXT-IPS:port_id
+String
+Specifies the port ID corresponding to the IP address.
++ +
+Table 12 security_groups field data structure description Parameter
+Type
+Description
+name
+String
+- If no security group is specified during BMS creation, the default value is used.
- When creating a BMS, you need to specify the ID of an existing security group (in UUID format).
+ +
+Table 13 os-extended-volumes:volumes_attached field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the EVS disk ID.
+delete_on_termination
+Boolean
+Specifies whether to delete the disk when deleting the BMS.
+- true: Yes
- false: No
+
+Table 14 fault field data structure description Parameter
+Type
+Description
+message
+String
+Specifies the fault information.
+code
+Integer
+Specifies the fault code.
+details
+String
+Specifies the fault details.
+created
+String
+Specifies the time when a fault occurred.
+The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T03:30:52Z.
+
- Example response++ +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88
{ + "server": { + "tenant_id": "c685484a8cc2416b97260938705deb65", + "addresses": { + "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ + { + "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77", + "OS-EXT-IPS:type": "fixed", + "OS-EXT-IPS:port_id": "0c111191-9785-49e6-8b42-66ef2802bd8f", + "addr": "192.168.0.107", + "version": 4 + } + ] + }, + "metadata": { + "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" + }, + "OS-EXT-STS:task_state": null, + "OS-DCF:diskConfig": "MANUAL", + "OS-EXT-AZ:availability_zone": "az-dc-1", + "links": [ + { + "rel": "self", + "href": "https://bms.az0.dc1.domainname.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" + }, + { + "rel": "bookmark", + "href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" + } + ], + "OS-EXT-STS:power_state": 1, + "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", + "os-extended-volumes:volumes_attached": [ + { + "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" + }, + { + "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" + }, + { + "id": "86e801c3-acc6-465d-890c-d43ba493f553" + }, + { + "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" + } + ], + "OS-EXT-SRV-ATTR:host": "bms.az-dc-1", + "image": { + "links": [ + { + "rel": "bookmark", + "href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" + } + ], + "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" + }, + "OS-SRV-USG:terminated_at": null, + "accessIPv4": "", + "accessIPv6": "", + "created": "2017-05-24T06:14:05Z", + "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", + "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", + "key_name": "KeyPair-JX", + "flavor": { + "links": [ + { + "rel": "bookmark", + "href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" + } + ], + "id": "physical.83.medium" + }, + "security_groups": [ + { + "name": "0011b620-4982-42e4-ad12-47c95ca495c4" + } + ], + "config_drive": "", + "OS-EXT-STS:vm_state": "active", + "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", + "user_id": "1311c433dd9b408886f57d695c229cbe", + "name": "bms-83", + "progress": 0, + "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", + "updated": "2017-05-25T03:40:25Z", + "status": "ACTIVE" + } + } +
+Returned Values
Normal values +++
+Returned Values
+Description
+200
+The request has been successfully processed.
+For details about other returned values, see Status Codes.
++Error Codes
See Error Codes.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0107658564.html b/docs/bms/api-ref/en-us_topic_0107658564.html new file mode 100644 index 00000000..8830bcfc --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0107658564.html @@ -0,0 +1,220 @@ + + +++Parent topic: BMS Status Management+Attaching an EVS Disk to a BMS
+++Function
This API is used to attach EVS disks to a BMS as data disks after the BMS is created if existing disks are insufficient or cannot meet requirements.
++Constraints
- EVS disks cannot be attached to a BMS in a batch.
- A maximum of 40 EVS disks can be attached to a BMS.
- A bootable disk cannot be attached to a BMS.
- A disk cannot be attached to a BMS in the PAUSED state. The state is indicated by the OS-EXT-STS:vm_state parameter.
- Only a shared disk or a disk in the available state can be attached to a BMS.
- Only EVS disks whose device type is SCSI can be attached to a BMS.
+URI
POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
- Request parameters
++ +
+Parameter
+Mandatory
+Type
+Description
+volumeAttachment
+Yes
+Object
+Specifies the disks to be attached. For details, see Table 2.
++
+Table 2 volumeAttachment field data structure description Parameter
+Mandatory
+Type
+Description
+volumeId
+Yes
+String
+Specifies the ID of the disk to be attached to a BMS.
+You can obtain the disk ID from the EVS console or by calling the "Querying EVS Disks" API in Elastic Volume Service API Reference.
+device
+No
+String
+Specifies the mount point, such as /dev/sda and /dev/sdb.
+The new disk mount point cannot be the same as an existing one.
+The mount point must be specified based on the sequence of existing device names. If this parameter is left blank or set to "", the system automatically generates a mount point.
+ - Example request++ +
1POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/attachvolume +
++ +1 +2 +3 +4 +5 +6
{ + "volumeAttachment": { + "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", + "device": "" + } +} +
+ +Response
- Response parameters
+
+Table 3 Normal response Parameter
+Type
+Description
+job_id
+String
+Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
++ +
+Table 4 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure
+Specifies the error returned when a task submission encounters an exception. For details, see Table 5.
++
+Table 5 error data structure Parameter
+Type
+Description
+message
+String
+Specifies the error message.
+code
+String
+Specifies the error code.
++Example Response
- Normal response++ +
1 +2 +3
{ + "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" +} +
+Returned Values
Normal values +++
+Returned Value
+Description
+202
+The request has been accepted, but the processing has been delayed.
+For details about other returned values, see Status Codes.
++Error Codes
See Error Codes.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0107658627.html b/docs/bms/api-ref/en-us_topic_0107658627.html new file mode 100644 index 00000000..1eb86f15 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0107658627.html @@ -0,0 +1,84 @@ + + +++Parent topic: BMS Disk Management+Detaching an EVS Disk from a BMS
+++Function
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 attached to a mount point other than /dev/sda function as data disks and can be detached from a running or stopped BMS.
+
+Constraints
If a BMS is stopped, disks can be detached from it without any constraints on the OS. If a BMS is running, the constraints are as follows:
+- Before detaching an EVS disk from a Linux BMS, log in to the BMS, run the unmount command to disassociate the disk to be detached from the file system, and ensure that no program is reading data from or writing data to the disk. Otherwise, the disk will fail to be detached.
- Before detaching an EVS disk from a Windows BMS, ensure that no program is reading data from or writing data to the disk. Otherwise, data will be lost.
+URI
DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id}
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
+attachment_id
+Yes
+Specifies the IDs of the EVS disks attached to the BMS.
++Request
++Response
See Task ID Response.
++Returned Values
Normal values +++
+Returned Value
+Description
+202
+The request has been accepted, but the processing has been delayed.
+For details about other returned values, see Status Codes.
++Error Codes
See Error Codes.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0113746488.html b/docs/bms/api-ref/en-us_topic_0113746488.html new file mode 100644 index 00000000..86a51a43 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0113746488.html @@ -0,0 +1,21 @@ + + +++Parent topic: BMS Disk Management+BMS Lifecycle Management
+ ++ + ++ diff --git a/docs/bms/api-ref/en-us_topic_0113746489.html b/docs/bms/api-ref/en-us_topic_0113746489.html new file mode 100644 index 00000000..6ea0ec96 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0113746489.html @@ -0,0 +1,1010 @@ + + +++Parent topic: BMS APIs+Querying BMS Details
+++Function
This API is used to query BMS details.
++URI
GET /v1/{project_id}/baremetalservers/{server_id}
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request Parameters
None
++Example Request
Querying details about a BMS (ID: 53206ed0-56de-4d6b-b7ee-ffc62ca26f43)+++ +1GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43 +
+Response Parameters
++ +
+Parameter
+Type
+Description
+server
+Object
+Specifies BMS information. For details, see Table 2.
++ +
+Table 2 server field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the BMS ID in UUID format.
+user_id
+String
+Specifies the ID of the user to which the BMS belongs. The value is in UUID format.
+name
+String
+Specifies the BMS name.
+created
+String
+Specifies the time when the BMS was created.
+The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T03:30:52Z.
+updated
+String
+Specifies the time when the BMS was updated.
+The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2019-05-22T04:30:52Z.
+tenant_id
+String
+Specifies the ID of the tenant owning the BMS. The value is in UUID format.
+This parameter specifies the same meaning as project_id.
+hostId
+String
+Specifies the host ID of the BMS.
+addresses
+Map<String,Array of address objects>
+Specifies the VPC used by the BMS.
+key: indicates the ID of the VPC used by the BMS.
+value indicates the VPC details.
+key_name
+String
+Specifies the key pair that is used to authenticate the BMS.
+image
+Object
+Specifies the BMS image. For details, see Table 4.
+flavor
+Object
+Specifies the BMS flavor. For details, see Table 6.
+security_groups
+Array of objects
+Specifies the security groups to which the BMS belongs. For details, see Table 7.
+accessIPv4
+String
+This is a reserved attribute.
+accessIPv6
+String
+This is a reserved attribute.
+status
+String
+Specifies the BMS status.
+Value range:
+- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
progress
+Integer
+This is a reserved attribute.
+config_drive
+String
+Specifies whether to configure the config drive partition for the BMS.
+The value can be True or an empty string.
+metadata
+object
+Specifies the BMS metadata. For details, see Table 11.
+NOTE:+Metadata includes system default fields and the fields set by users.
+OS-EXT-STS:task_state
+String
+Specifies the BMS task status. This is an extended attribute. Examples:
+- rebooting: The BMS is being restarted.
- reboot_started: The BMS is normally restarted.
- reboot_started_hard: The BMS is forcibly restarted.
- powering-off: The BMS is being powered off.
- powering-on: The BMS is being powered on.
- rebuilding: The BMS is being rebuilt.
- scheduling: The BMS is being scheduled.
- deleting: The BMS is being deleted.
OS-EXT-STS:vm_state
+String
+Specifies the BMS status. This is an extended attribute. Examples:
+- active: The BMS is running.
- shutoff: The BMS is stopped.
- reboot: The BMS is restarted.
OS-EXT-SRV-ATTR:host
+String
+Specifies the hostname of the BMS. This is an extended attribute.
+OS-EXT-SRV-ATTR:instance_name
+String
+Specifies the BMS alias. This is an extended attribute.
+OS-EXT-STS:power_state
+Integer
+Specifies the BMS power status. This is an extended attribute. Examples:
+- 0: indicates NO STATE.
- 1: indicates RUNNING.
- 4: indicates SHUTDOWN.
OS-EXT-SRV-ATTR:hypervisor_hostname
+String
+Specifies the hostname of the hypervisor.
+OS-EXT-AZ:availability_zone
+String
+Specifies the AZ where the BMS is located.
+OS-DCF:diskConfig
+String
+Specifies the disk configuration. This is an extended attribute. The value can be:
+- MANUAL: The API uses the partitioning scheme in the image and the file system to create a BMS. If the target flavor has a large disk, the API does not partition the remaining disk space.
- AUTO: The API uses a single partition with the same size as the disk of the target flavor to create a BMS. The API automatically adjusts the file system to adapt to the entire partition.
fault
+Object
+Specifies the cause of a BMS fault. For details, see Table 8.
+OS-SRV-USG:launched_at
+String
+Specifies the time when the BMS was started.
+The timestamp format is ISO 8601, for example, 2019-05-22T03:23:59.000000.
+OS-SRV-USG:terminated_at
+String
+Specifies the time when the BMS was deleted.
+The timestamp format is ISO 8601, for example, 2019-05-22T04:23:59.000000.
+os-extended-volumes:volumes_attached
+Array of objects
+Specifies the disks attached to the BMS. For details, see Table 9.
+description
+String
+Specifies BMS information.
+host_status
+String
+Specifies the status of the host that accommodates the BMS.
+- UP: The nova-compute status is normal.
- UNKNOWN: The nova-compute status is unknown.
- DOWN: the nova-compute status is abnormal.
- MAINTENANCE: The nova-compute is in the maintenance state.
- Empty string: The BMS does not have host information.
OS-EXT-SRV-ATTR:hostname
+String
+Specifies the hostname of the BMS.
+OS-EXT-SRV-ATTR:reservation_id
+String
+Specifies the reserved BMS IDs in a batch creation situation.
+When BMSs are created in a batch, they have the same reservation_id.
+OS-EXT-SRV-ATTR:launch_index
+Integer
+Specifies the BMS startup sequence in a batch creation situation.
+OS-EXT-SRV-ATTR:kernel_id
+String
+Specifies the UUID of the kernel image when the AMI image is used. In other scenarios, leave this parameter blank.
+OS-EXT-SRV-ATTR:ramdisk_id
+String
+Specifies the UUID of the Ramdisk image when the AMI image is used. In other scenarios, leave this parameter blank.
+OS-EXT-SRV-ATTR:root_device_name
+String
+Specifies the device name of the BMS system disk, for example, /dev/sda.
+OS-EXT-SRV-ATTR:user_data
+String
+Specifies the user_data specified during BMS creation. The value is encoded using Base64 or an empty string.
+locked
+Boolean
+Specifies whether the BMS is locked.
+- true: The BMS is locked.
- false: The BMS is not locked.
tags
+Array of strings
+Specifies tags of the BMS.
+os:scheduler_hints
+Object
+Specifies scheduling information of the BMS. For details, see Table 10.
+sys_tags
+Array of objects
+Specifies system tags of the BMS. For details, see Table 12.
++ +
+Table 3 address field data structure description Parameter
+Type
+Description
+version
+String
+Specifies the IP address version.
+- 4: indicates IPv4.
- 6: indicates IPv6.
addr
+String
+Specifies the IP address.
+OS-EXT-IPS:type
+String
+Specifies the IP address type.
+- fixed: indicates the private IP address.
- floating: indicates the EIP.
OS-EXT-IPS-MAC:mac_addr
+String
+Specifies the MAC address.
+OS-EXT-IPS:port_id
+String
+Specifies the port ID corresponding to the IP address.
++ +
+Table 4 image field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the image ID in UUID format.
+name
+String
+Specifies the image name.
+__os_type
+String
+Specifies the image type.
+The value can be:
+- Linux (including SUSE, Red Hat, CentOS, Oracle Linux, EulerOS, and Ubuntu)
- Windows
- Other (ESXi)
links
+Array of objects
+Specifies shortcut links of the image. For details, see Table 5.
++ +
+Table 5 links field data structure description Parameter
+Type
+Description
+rel
+String
+Specifies the shortcut link marker name.
+href
+String
+Specifies the corresponding shortcut link.
++ +
+Table 6 flavor field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the flavor ID of the BMS.
+name
+String
+Specifies the flavor name of the BMS.
+disk
+String
+Specifies the system disk size in the BMS flavor. The value 0 indicates that the disk size is not limited.
+vcpus
+String
+Specifies the number of CPU cores in the BMS flavor.
+ram
+String
+Specifies the memory size (MB) in the BMS flavor.
++ +
+Table 7 security_groups field data structure description Parameter
+Type
+Description
+name
+String
+Specifies the security group name.
+id
+String
+Specifies the security group ID.
++ +
+Table 8 fault field data structure description Parameter
+Type
+Description
+message
+String
+Specifies the fault information.
+code
+Integer
+Specifies the fault code.
+details
+String
+Specifies the fault details.
+created
+String
+Specifies the time when the fault occurred. The time is in ISO 8601 format.
++ +
+Table 9 os-extended-volumes:volumes_attached field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the disk ID in UUID format.
+delete_on_termination
+String
+Specifies whether to delete the disk when deleting the BMS.
+- true: Yes
- false: No
bootIndex
+String
+Specifies whether it is a boot disk. 0 specifies a boot disk, and -1 specifies a non-boot disk.
+device
+String
+Specifies the device name of the disk, for example, /dev/sdb.
++ +
+Table 10 os:scheduler_hints field data structure description Parameter
+Type
+Description
+dec_baremetal
+Array of strings
+Specifies whether to create the BMS in a DeC. The value can be share or dedicate.
++ + +
+Table 11 metadata field data structure description Parameter
+Type
+Description
+vpc_id
+String
+Specifies the ID of the VPC where the BMS is located.
+metering.image_id
+String
+Specifies the image ID of the BMS.
+metering.imagetype
+String
+Specifies the image type. The following types are supported:
+- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
baremetalPortIDList
+String
+Specifies NICs of the BMS.
+metering.resourcespeccode
+String
+Specifies the flavor code of the BMS in {Flavor ID}.{os_type} format, for example, physical.o2.medium.linux.
+metering.resourcetype
+String
+Specifies the resource type of the BMS. The value is __type_baremetal.
+image_name
+String
+Specifies the image name of the BMS.
+op_svc_userid
+String
+Specifies the user ID. You can obtain the user ID from My Credential on the management console.
+os_type
+String
+Specifies the OS type. The value can be Linux or Windows.
+__bms_support_evs
+String
+Specifies whether the BMS supports EVS disks.
+os_bit
+String
+Specifies the number of bits in the OS: 32 or 64.
++Example Response
++ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89
{ + "server": { + "id": "53206ed0-56de-4d6b-b7ee-ffc62ca26f43", + "name": "bms-test", + "addresses": { + "5849fdf1-9d79-4589-80c2-fe557990c417": [ + { + "version": "4", + "addr": "192.168.1.216", + "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:25:56:c3", + "OS-EXT-IPS:port_id": "9e62503b-094e-4c6e-bc95-f10bbfb455d5", + "OS-EXT-IPS:type": "fixed" + }, + { + "version": "4", + "addr": "10.154.72.77", + "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:25:56:c3", + "OS-EXT-IPS:port_id": "9e62503b-094e-4c6e-bc95-f10bbfb455d5", + "OS-EXT-IPS:type": "floating" + } + ] + }, + "flavor": { + "disk": "9309", + "vcpus": "32", + "ram": "193047", + "id": "physical.o2.medium", + "name": "physical.o2.medium" + }, + "accessIPv4": "", + "accessIPv6": "", + "status": "ACTIVE", + "progress": 0, + "hostId": "cd243addb5d2c64e89218180b7a3ed95abe6882e81c337cc563137df", + "updated": "2018-09-18T09:29:44Z", + "created": "2018-09-18T02:43:26Z", + "metadata": { + "metering.order_id": "CS1809181040HCFC2", + "metering.image_id": "8589958c-6bc7-40c6-b81b-3fe4cd2e3d85", + "baremetalPortIDList": "[9e62503b-094e-4c6e-bc95-f10bbfb455d5]", + "metering.resourcespeccode": "physical.o2.medium.linux", + + "image_name": "redhat_7_2", + "op_svc_userid": "745973c535ec4d4caba86f6f9419ff6d", + "metering.resourcetype": "__type_baremetal", + + "metering.product_id": "00301-74069-0--0", + "os_bit": "64", + "vpc_id": "5849fdf1-9d79-4589-80c2-fe557990c417", + "os_type": "Linux", + "chargingMode": "1" + }, + "tags": [ + "__type_baremetal" + ], + "description": "bms-6e18", + "locked": false, + "image": { + "id": "8589958c-6bc7-40c6-b81b-3fe4cd2e3d85" + }, + "config_drive": "", + "tenant_id": "bbf1946d374b44a0a2a95533562ba954", + "user_id": "3fc5ab2b0c544979abcaafd86edd80e6", + "OS-EXT-STS:power_state": 1, + "OS-EXT-STS:vm_state": "active", + "OS-EXT-SRV-ATTR:host": "bms.dc1", + "OS-EXT-SRV-ATTR:instance_name": "instance-00154f94", + "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova002@2", + "OS-DCF:diskConfig": "MANUAL", + "OS-EXT-AZ:availability_zone": "az-dc-1", + "os:scheduler_hints": {}, + "OS-EXT-SRV-ATTR:root_device_name": "/dev/sda", + "OS-EXT-SRV-ATTR:ramdisk_id": "", + "enterprise_project_id": "2c7b6d77-9013-4d74-a221-2f612fc56372", + "OS-EXT-SRV-ATTR:user_data": "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRtTGM1REEkN3IvWFVZaEI0VG1YZ0FCT1F2SE4wOHNoWTVZcDYzUXFDTTVyMHpmWjhJLkJlNW92UlU2QW85a25QNlZUVnhkckF5RTJtdC40S0NxcXBBNUVuUVppNC4nIHwgY2hwYXNzd2QgLWU7", + "OS-SRV-USG:launched_at": "2018-09-18T02:46:07.954587", + "OS-EXT-SRV-ATTR:kernel_id": "", + "OS-EXT-SRV-ATTR:launch_index": 0, + "host_status": "UP", + "OS-EXT-SRV-ATTR:reservation_id": "r-08tuyo8v", + "OS-EXT-SRV-ATTR:hostname": "bms-6e18", + "sys_tags": [ + { + "key": "_sys_enterprise_project_id", + "value": "2c7b6d77-9013-4d74-a221-2f612fc56372" + } + ] + } +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0113746490.html b/docs/bms/api-ref/en-us_topic_0113746490.html new file mode 100644 index 00000000..c4c9b640 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0113746490.html @@ -0,0 +1,23 @@ + + +++Parent topic: BMS Lifecycle Management+BMS Status Management
+ +++ diff --git a/docs/bms/api-ref/en-us_topic_0113746491.html b/docs/bms/api-ref/en-us_topic_0113746491.html new file mode 100644 index 00000000..e3177aec --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0113746491.html @@ -0,0 +1,19 @@ + + +-
+
- Changing the BMS Name
+
+ - Reinstalling the BMS OS
+
+ - Starting BMSs
+
+ - Restarting BMSs
+
+ - Stopping BMSs
+
+
++Parent topic: BMS APIs+BMS Disk Management
+ +++ diff --git a/docs/bms/api-ref/en-us_topic_0114885743.html b/docs/bms/api-ref/en-us_topic_0114885743.html index de96711a..8caf495a 100644 --- a/docs/bms/api-ref/en-us_topic_0114885743.html +++ b/docs/bms/api-ref/en-us_topic_0114885743.html @@ -1,7 +1,7 @@ --
+
- Attaching an EVS Disk to a BMS
+
+ - Detaching an EVS Disk from a BMS
+
+ - Querying EVS Disks Attached to a BMS
+
+
++Parent topic: BMS APIs+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.
+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.
@@ -27,7 +27,7 @@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.
+You can obtain the flavor ID from the BMS console or using the Querying BMS Flavors (Native OpenStack API) API.
Request
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0118683801.html b/docs/bms/api-ref/en-us_topic_0118683801.html new file mode 100644 index 00000000..8dfd5a7b --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0118683801.html @@ -0,0 +1,15 @@ + + +
1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/flavors/physical.s2.medium/os-extra_specs +
- Example request
@@ -54,8 +54,8 @@1GET https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/flavors/physical.s2.medium/os-extra_specs
Object
Specifies the key-value pair of a BMS flavor.
-- capabilities:cpu_arch: specifies the CPU architecture of the BMS. The value can be x86_64 (for x86 servers) or aarch64 (for ARM servers).
- baremetal:disk_detail: specifies the disk description.
- capabilities:hypervisor_type: specifies the hypervisor type. The value is fixed at ironic.
- baremetal:__support_evs: specifies whether to support EVS disks. The value can be true or false. If the flavor does not contain this parameter, EVS disks are not supported either.
- baremetal:extBootType: specifies the boot device of the BMS. The value can be LocalDisk (local disk) or Volume (EVS disk).
- baremetal:net_num: specifies the number of NICs that can be attached to a BMS.
- baremetal:netcard_detail: specifies description of the NIC.
- baremetal:cpu_detail: specifies description of the CPU.
- resource_type: specifies the resource type. The value is fixed at ironic.
- baremetal:memory_detail: specifies description of the memory.
Specifies the key-value pair of a BMS flavor.
+- capabilities:cpu_arch: specifies the CPU architecture of the BMS. The value can be x86_64 (for x86 servers) or aarch64 (for ARM servers).
- baremetal:disk_detail: specifies the disk description.
- capabilities:hypervisor_type: specifies the hypervisor type. The value is fixed at ironic.
- baremetal:__support_evs: specifies whether to support EVS disks. The value can be true or false. If the flavor does not contain this parameter, EVS disks are not supported either.
- baremetal:extBootType: specifies the boot device of the BMS. The value can be LocalDisk (local disk) or Volume (EVS disk).
- baremetal:net_num: specifies the number of NICs that can be attached to a BMS.
- baremetal:netcard_detail: specifies description of the NIC.
- baremetal:cpu_detail: specifies description of the CPU.
- resource_type: specifies the resource type. The value is fixed at ironic.
- baremetal:memory_detail: specifies description of the memory.
{ - "extra_specs": { - "capabilities:cpu_arch": "x86_64", - "baremetal:disk_detail": "SAS 8T", - "capabilities:hypervisor_type": "ironic", - "baremetal:__support_evs": "true", - "baremetal:extBootType": "LocalDisk", - "capabilities:board_type": "s2m", - "baremetal:net_num": "2", - "baremetal:netcard_detail": "2*10GE", - "baremetal:cpu_detail": "2*8coreIntel Xeon E5-2667 V43.2GHz", - "resource_type": "ironic", - "baremetal:memory_detail": "256GB DDR4 RAM(GB)" - } -} +15
{ + "extra_specs": { + "capabilities:cpu_arch": "x86_64", + "baremetal:disk_detail": "SAS 8T", + "capabilities:hypervisor_type": "ironic", + "baremetal:__support_evs": "true", + "baremetal:extBootType": "LocalDisk", + "capabilities:board_type": "s2m", + "baremetal:net_num": "2", + "baremetal:netcard_detail": "2*10GE", + "baremetal:cpu_detail": "2*8coreIntel Xeon E5-2667 V43.2GHz", + "resource_type": "ironic", + "baremetal:memory_detail": "256GB DDR4 RAM(GB)" + } +}
Task Management
+ ++ + ++ diff --git a/docs/bms/api-ref/en-us_topic_0118696596.html b/docs/bms/api-ref/en-us_topic_0118696596.html new file mode 100644 index 00000000..989e7b41 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0118696596.html @@ -0,0 +1,354 @@ + + +++Parent topic: BMS APIs+Querying Task Statuses
+++Function
This API is used to query the execution status of a task.
+After a task, such as creating a BMS or attaching disks, is delivered, job_id is returned, based on which you can query the execution status of the task.
++URI
GET /v1/{project_id}/jobs/{job_id}
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+job_id
+Yes
+Specifies the task ID.
++Request
++Response
- Response parameters
++ +
+Parameter
+Type
+Description
+status
+String
+Specifies the task status.
+- SUCCESS: The task is successful.
- RUNNING: The task is running.
- FAIL: The task failed.
- INIT: The task is being initialized.
entities
+Object
+Specifies the task object. For details, see Table 2.
+The displayed information varies depending on the task type. For operations related to BMSs, server_id is displayed. For operations related to NICs, nic_id is displayed. If subtasks exist, details about the subtasks are also displayed.
+job_id
+String
+Specifies the task ID.
+job_type
+String
+Specifies the task type. The value can be:
+- baremetalBatchCreate: creating BMSs in a batch
- baremetalBatchOperate: changing the power status of BMSs in a batch.
- baremetalAttachVolume: attaching a disk
- baremetalDetachVolume: detaching a disk
begin_time
+String
+Specifies the time when the job started.
+The timestamp format is ISO 8601, for example, 2019-04-25T20:04:47.591Z.
+end_time
+String
+Specifies the time when the job ended.
+The timestamp format is ISO 8601, for example, 2019-04-26T20:04:47.591Z.
+error_code
+String
+Specifies the error code returned upon a task execution failure.
+fail_reason
+String
+Specifies the cause of a task execution failure.
+message
+String
+Specifies the message returned when an error occurs.
+code
+String
+Specifies the error code returned when an error occurs.
+For details about error codes, see section Status Codes.
++ +
+Table 2 entities field data structure description Parameter
+Type
+Description
+sub_jobs_total
+Integer
+Specifies the number of subtasks. If the task has no subtasks, the value of this parameter is 0.
+sub_jobs
+Array of objects
+Specifies the execution information about a subtask. If the task has no subtasks, the value of this parameter is left blank. For details, see Table 3.
++ + +
+Table 3 sub_jobs field data structure description Parameter
+Type
+Description
+status
+String
+Specifies the task status.
+- SUCCESS: The task is successful.
- RUNNING: The task is running.
- FAIL: The task failed.
- INIT: The task is being initialized.
entities
+Array of objects
+Specifies the task object. The displayed information varies depending on the task type. For operations related to BMSs, server_id is displayed. For operations related to NICs, nic_id is displayed.
+For details, see Table 4.
+job_id
+String
+Specifies the task ID.
+job_type
+String
+Specifies the task type. The value can be:
+- baremetalSingleCreate: creating a single BMS
- baremetalSingleOperate: changing the power status of a single BMS
begin_time
+String
+Specifies the time when the job started.
+The timestamp format is ISO 8601, for example, 2019-04-25T20:04:47.591Z.
+end_time
+String
+Specifies the time when the job ended.
+The timestamp format is ISO 8601, for example, 2019-04-26T20:04:47.591Z.
+error_code
+String
+Specifies the error code returned upon a task execution failure.
+fail_reason
+String
+Specifies the cause of a task execution failure.
+message
+String
+Specifies the message returned when an error occurs.
+code
+String
+Specifies the error code returned when an error occurs.
+For details about error codes, see section Status Codes.
+ - Example response++ +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26
{ + "status": "SUCCESS", + "entities": { + "sub_jobs_total": 1, + "sub_jobs": [ + { + "status": "SUCCESS", + "entities": { + "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d" + }, + "job_id": "2c9eb2c5544cbf6101544f0635672b60", + "job_type": "baremetalSingleCreate", + "begin_time": "2019-04-25T20:04:47.591Z", + "end_time": "2019-04-25T20:08:21.328Z", + "error_code": null, + "fail_reason": null + } + ] + }, + "job_id": "2c9eb2c5544cbf6101544f0602af2b4f", + "job_type": "baremetalBatchCreate", + "begin_time": "2019-04-25T20:04:34.604Z", + "end_time": "2019-04-25T20:08:41.593Z", + "error_code": null, + "fail_reason": null +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0126150310.html b/docs/bms/api-ref/en-us_topic_0126150310.html new file mode 100644 index 00000000..8db1d6f7 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0126150310.html @@ -0,0 +1,310 @@ + + +++Parent topic: Task Management+Reinstalling the BMS OS
+++Function
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. Password and key pair injection are supported during OS reinstallation.
++ To check whether a BMS is quickly provisioned, use the Querying Details About Flavors and Extended Flavor Information API.
+This is an asynchronous API. Calling the API successfully indicates that the task is delivered successfully. To check whether the task is successful, use the Querying Task Statuses API.
++Constraints
- For BMSs created from private images, ensure that Cloud-Init (for Linux) or Cloudbase-Init (for Windows) has been installed for the image. If an image without Cloud-Init or Cloudbase-Init is used, this API cannot inject a key pair or password. Cloud-Init or Cloudbase-Init has been installed for public images by default.
- You are not allowed to perform other operations when reinstalling the OS. Otherwise, reinstalling the OS will fail.
- You can reinstall the OS only on a BMS that is stopped or for which OS reinstallation has failed.
- An encrypted password will be used as the value of user_data for Linux images.
+URI
POST /v1/{project_id}/baremetalservers/{server_id}/reinstallos
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
- Request parameters
++ +
+Parameter
+Mandatory
+Type
+Description
+os-reinstall
+Yes
+Object
+Specifies the operation of reinstalling the BMS OS. For details, see Table 2.
++ +
+Table 2 os-reinstall field data structure description Parameter
+Mandatory
+Type
+Description
+adminpass
+No
+String
+Specifies the initial login password of the BMS administrator account.
+The Linux administrator is root, and the Windows administrator is Administrator.
+Recommended password complexity requirements are as follows:
+- The password contains 8 to 26 characters.
- Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?
- The password cannot contain the username or the username in reverse.
NOTE:+- For Windows BMSs, the password cannot contain more than two consecutive characters in the username.
- For Linux BMSs, user_data can be used to inject a password. In this case, adminpass is invalid.
- Either adminpass or keyname can be set.
- If both adminpass and keyname are empty, user_data in metadata must be set.
keyname
+No
+String
+Specifies the key pair name.
+You can create a key pair using the Creating and Importing an SSH Key Pair (Native OpenStack API) API, or query existing key pairs using the Querying SSH Key Pairs (Native OpenStack API) API.
+userid
+No
+String
+Specifies the user ID. You can obtain the user ID from My Credential on the management console.
+metadata
+No
+Object
+Specifies the BMS metadata. For details, see Table 3.
++
+Table 3 metadata field data structure description Parameter
+Mandatory
+Type
+Description
+BYOL
+No
+String
+Specifies whether a user has the license of an image.
+- If this parameter is set to true, the license file delivered with the image is used, indicating that BYOL is used.
- If this parameter is set to a value other than true, BYOL is not used, and the license file provided by the cloud platform must be used.
The default value is not true, indicating that BYOL is not used.
+user_data
+No
+String
+Specifies the Linux image root password injected during the BMS OS reinstallation. It is a user-defined initial password.
+Note: The password change script must be encoded using Base64.
+Recommended password complexity requirements are as follows:
+- Contains 8 to 26 characters.
- Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?
An example is as follows:
+- Use a plaintext password (risky in security), for example, cloud.1234.++ +
1 +2
#!/bin/bash +echo 'root:Cloud.1234' | chpasswd ; +
- Use a password.++ +
1 +2
#!/bin/bash +echo 'root:$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig/GpOkLcOhab9smJoLKYm/Tf9Hcwa6DpiPDhdHfGEAPajFmLZa0YDd910' | chpasswd -e +
- This script must be encoded using Base64.
where, $6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig is the ciphertext password, which can be generated as follows:
+- Generate an encrypted salt value.++ +
1 +2
[root@test linux]# python -c "import crypt, getpass, pwd;print crypt.mksalt()" +$6$V6azyeLwcD3CHlpY +
- Generate a ciphertext password based on the salt value.++ +
1 +2
[root@test linux]# python -c "import crypt, getpass, pwd;print crypt.crypt('Cloud.1234','\$6\$V6azyeLwcD3CHlpY')" + $6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig/GpOkLcOhab9smJoLKYm/Tf9Hcwa6DpiPDhdHfGEAPajFmLZa0YDd910 +
- After the ciphertext is generated, the password change script must be encoded using Base64.
- Example request++ +
1POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/reinstallos +
++ +1 +2 +3 +4 +5 +6 +7 +8 +9
{ + "os-reinstall": { + "keyname": "KeyPair-350b", + "userid": "7e25b1da389f4697a79df3a0e5bd494e", + "metadata": { + "user_data": "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiR0Y0pZamUkNGhhUHlNZFR4VWVHc2dTMWFmL1NsMm4vbXZzdy5wSFdjbTVBc084OWFhUFhGNXUvVnJ5OXJiYmZZSW45SmZac2k3SlRmd2Z6djJPbTBHRFZUZTd6RDEnIHwgY2hwYXNzd2QgLWU7" + } + } +} +
+ +Response
- Response parameters
+
+Table 4 Normal response Parameter
+Type
+Description
+job_id
+String
+Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
++ +
+Table 5 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure
+Specifies the error returned when a task submission encounters an exception. For details, see Table 6.
++
+Table 6 error data structure Parameter
+Type
+Description
+message
+String
+Specifies the error message.
+code
+String
+Specifies the error code.
++Example Response
- Normal response
{ + "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" +}++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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0129082263.html b/docs/bms/api-ref/en-us_topic_0129082263.html new file mode 100644 index 00000000..650b7a23 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0129082263.html @@ -0,0 +1,459 @@ + + +++Parent topic: BMS Status Management+Querying Details About BMSs
+++Function
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 frozen.
++ +URI
GET /v1/{project_id}/baremetalservers/detail?flavor={flavor}&name={name}&status={status}&limit={limit}&offset={offset}&tags={tags}&reservation_id={reservation_id}&enterprise_project_id={enterprise_project_id}
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
++
+Table 2 Parameters for querying BMS details Parameter
+Mandatory
+Type
+Description
+flavor
+No
+String
+Specifies the ID of the BMS flavor.
+name
+No
+String
+Specifies the BMS name.
+status
+No
+String
+Specifies the BMS status.
+Value range:
+- ACTIVE: Running, Stopping, Deleting
- BUILD: Creating
- ERROR: Faulty
- HARD_REBOOT: Forcibly Restarting
- REBOOT: Restarting
limit
+No
+Integer
+Specifies the number of BMSs displayed on each page. The default value is 25 and maximum value is 1000.
+offset
+No
+Integer
+This API is a pagination query API. offset indicates the page number (the start page number is 1). The returned value contains the number of BMSs and details about the BMSs.
+- If offset is specified:
BMSs are displayed by pages based on the limit value. By default, the limit value is 1000. The BMSs and total number of BMSs on the offset page are displayed. The maximum number of BMSs is the value of limit. If the number of BMSs is less than the value of limit, the actual number of BMSs is displayed.
+ - If offset is not specified:
- If limit is specified: The BMSs and total number of BMSs are displayed. The maximum number of BMSs is the value of limit. If the number of BMSs is less than the value of limit, the actual number of BMSs is displayed.
- If limit is not specified: 25 BMSs are displayed on each page. Details about the BMSs on the first page are displayed. If the number of BMSs is less than 25, the actual number of BMSs is displayed.
tags
+No
+String
+Specifies the BMS tag. The value can be:
+- __type_baremetal: internal tag of the system
- Other custom tags
reservation_id
+No
+String
+Specifies the reserved ID, which can be used to query BMSs created in a batch.
++Request
+ ++Response
- Response parameters
++
+Parameter
+Type
+Description
+servers
+List data structure
+Specifies details about BMSs. For details, see Querying BMS Details.
+The returned details vary depending on the query level.
+count
+Integer
+Specifies the number of BMSs that match the filters.
+ - Example response++ +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140
{ + "count": 2, + "servers": [ + { + "id": "b544be62-1b3b-4982-ad98-572b002ac23b", + "name": "bms-test1", + "addresses": { + "5849fdf1-9d79-4589-80c2-fe557990c417": [ + { + "version": "4", + "addr": "192.168.1.63", + "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:3a:8d:f1", + "OS-EXT-IPS:port_id": "c79d2813-94c9-4135-973e-cbf5d23e78e6", + "OS-EXT-IPS:type": "fixed" + } + ] + }, + "flavor": { + "disk": "9309", + "vcpus": "32", + "ram": "193047", + "id": "physical.s1.medium.ondemand", + "name": "physical.s1.medium.ondemand" + }, + "accessIPv4": "", + "accessIPv6": "", + "status": "ACTIVE", + "progress": 0, + "hostId": "cd243addb5d2c64e89218180b7a3ed95abe6882e81c337cc563137df", + "updated": "2018-09-10T01:20:58Z", + "created": "2018-09-06T09:29:27Z", + "metadata": { + "baremetalPortIDList": "[c79d2813-94c9-4135-973e-cbf5d23e78e6]", + "chargingMode": "0" + }, + "tags": [ + "__type_baremetal" + ], + "description": "bms-test1", + "locked": false, + "config_drive": "", + "tenant_id": "bbf1946d374b44a0a2a95533562ba954", + "user_id": "0c50494c5816425eb05c40b5e81ab65a", + "key_name": "KeyPair-dec-jx", + "OS-EXT-STS:power_state": 1, + "OS-EXT-STS:vm_state": "active", + "OS-EXT-SRV-ATTR:host": "bms.dc1", + "OS-EXT-SRV-ATTR:instance_name": "instance-0014bdc2", + "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova002@2", + "OS-DCF:diskConfig": "MANUAL", + "OS-EXT-AZ:availability_zone": "az-dc-1", + "os:scheduler_hints": {}, + "OS-EXT-SRV-ATTR:root_device_name": "/dev/vda", + "OS-EXT-SRV-ATTR:ramdisk_id": "", + "enterprise_project_id": "0", + "OS-SRV-USG:launched_at": "2018-09-06T09:30:36.000000", + "OS-EXT-SRV-ATTR:kernel_id": "", + "OS-EXT-SRV-ATTR:launch_index": 0, + "host_status": "UP", + "OS-EXT-SRV-ATTR:reservation_id": "r-qjad3fv0", + "OS-EXT-SRV-ATTR:hostname": "bms-test1", + "sys_tags": [ + { + "key": "_sys_enterprise_project_id", + "value": "0" + } + ] + }, + { + "id": "a1541cfc-8ac3-43e9-a70d-b8d4b395b256", + "name": "bms_test2", + "addresses": { + "5849fdf1-9d79-4589-80c2-fe557990c417": [ + { + "version": "4", + "addr": "192.168.1.50", + "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:8f:38:2c", + "OS-EXT-IPS:port_id": "460aa585-9f83-4719-9527-fc39ebaca9aa", + "OS-EXT-IPS:type": "fixed" + } + ] + }, + "flavor": { + "disk": "9309", + "vcpus": "32", + "ram": "193047", + "id": "physical.s1.medium", + "name": "physical.s1.medium" + }, + "accessIPv4": "", + "accessIPv6": "", + "status": "SHUTOFF", + "hostId": "cd243addb5d2c64e89218180b7a3ed95abe6882e81c337cc563137df", + "updated": "2018-09-06T10:00:25Z", + "created": "2018-08-30T12:40:47Z", + "metadata": { + "metering.order_id": "CS18083020422CNV9", + "baremetalPortIDList": "[460aa585-9f83-4719-9527-fc39ebaca9aa]", + "metering.product_id": "00301-167001-0--0", + "chargingMode": "1" + }, + "tags": [ + "__type_baremetal", + "_sys_enterprise_project_id=9dd1131d-71fd-40fe-8f14-3fe6b6b5ef8b", + "key1=value1", + "three=3", + "two=2" + ], + "description": "bms_test2", + "locked": false, + "config_drive": "", + "tenant_id": "bbf1946d374b44a0a2a95533562ba954", + "user_id": "3fc5ab2b0c544979abcaafd86edd80e6", + "key_name": "KeyPair-hec-tzy", + "OS-EXT-STS:power_state": 4, + "OS-EXT-STS:vm_state": "stopped", + "OS-EXT-SRV-ATTR:host": "bms.dc1", + "OS-EXT-SRV-ATTR:instance_name": "instance-0014581b", + "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova002@2", + "OS-DCF:diskConfig": "MANUAL", + "OS-EXT-AZ:availability_zone": "az-dc-1", + "os:scheduler_hints": {}, + "OS-EXT-SRV-ATTR:root_device_name": "/dev/vda", + "OS-EXT-SRV-ATTR:ramdisk_id": "", + "enterprise_project_id": "0", + "OS-SRV-USG:launched_at": "2018-08-30T12:42:10.000000", + "OS-EXT-SRV-ATTR:kernel_id": "", + "OS-EXT-SRV-ATTR:launch_index": 0, + "host_status": "UP", + "OS-EXT-SRV-ATTR:reservation_id": "r-i5w3yc9a", + "OS-EXT-SRV-ATTR:hostname": "bms-test2", + "sys_tags": [ + { + "key": "_sys_enterprise_project_id", + "value": "0" + } + ] + } + ] +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0130145446.html b/docs/bms/api-ref/en-us_topic_0130145446.html new file mode 100644 index 00000000..13b7f93e --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0130145446.html @@ -0,0 +1,165 @@ + + +++Parent topic: BMS Lifecycle Management+Querying EVS Disks Attached to a BMS
+++Function
This API is used to query EVS disks attached to a BMS.
++URI
GET /v1/{project_id}/baremetalservers/{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 details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
++Response
- Response parameters
++ +
+Parameter
+Type
+Description
+volumeAttachments
+Array of objects
+Specifies disks attached to a BMS. For details, see Table 2.
++
+Table 2 volumeAttachments field data structure description Parameter
+Type
+Description
+device
+String
+Specifies the mount directory, for example, dev/sdd.
+id
+String
+Specifies the ID of the attached resource.
+serverId
+String
+Specifies the ID of the BMS to which the disk is attached.
+volumeId
+String
+Specifies the ID of the disk attached to the BMS.
+ - Example response++ +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16
{ + "volumeAttachments": [ + { + "device": "/dev/sdd", + "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", + "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", + "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803" + }, + { + "device": "/dev/sdc", + "id": "a26887c6-c47b-4654-abb5-dfadf7d3f804", + "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", + "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f804" + } + ] +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0131036397.html b/docs/bms/api-ref/en-us_topic_0131036397.html new file mode 100644 index 00000000..d4991dcf --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131036397.html @@ -0,0 +1,21 @@ + + +++Parent topic: BMS Disk Management+BMS NIC Management
+ +++ diff --git a/docs/bms/api-ref/en-us_topic_0131036398.html b/docs/bms/api-ref/en-us_topic_0131036398.html new file mode 100644 index 00000000..5d25e3b3 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131036398.html @@ -0,0 +1,212 @@ + + +-
+
- Querying NICs Attached to a BMS
+
+ - Attaching NICs to a BMS
+
+ - Detaching NICs from a BMS
+
+ - Modifying Attributes of a BMS NIC
+
+
++Parent topic: BMS APIs+Querying NICs Attached to a BMS
+++Function
This API is used to query information about NICs attached to a BMS, such as the IP address and MAC address of each NIC.
++URI
GET /v1/{project_id}/baremetalservers/{server_id}/os-interface
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
++Response
- Response parameters
++ +
+Parameter
+Type
+Description
+interfaceAttachments
+Array of objects
+Specifies BMS NICs. For details, see Table 2.
++ + +
+Table 2 interfaceAttachments field data structure description Parameter
+Type
+Description
+port_state
+String
+Specifies the NIC port status. The value can be ACTIVE, BUILD, or DOWN.
+fixed_ips
+Array of objects
+Specifies private IP addresses of NICs. For details, see Table 3.
+net_id
+String
+Specifies the ID of the subnet (network_id) to which the NIC ports belong.
+port_id
+String
+Specifies the ID of the NIC port.
+mac_addr
+String
+Specifies the MAC address of the NIC.
+driver_mode
+String
+Specifies the NIC driver type in Guest OS. The value can be virtio or hinic. The default value is virtio.
+pci_address
+String
+Specifies the BDF number of the NIC in Linux Guest OS.
+ - Example response++ +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16
{ + "interfaceAttachments": [ + { + "port_state": "ACTIVE", + "fixed_ips": [ + { + "subnet_id": "a5052101-11e1-4f3d-a5fa-f6ba6791219c", + "ip_address": "192.168.1.147" + } + ], + "net_id": "ad0fadbf-4bc1-472c-a030-5310e53b3818", + "port_id": "bb585b04-f2a2-4528-9064-fd0aeb4e15a9", + "mac_addr": "fa:16:3e:3b:58:fc" + } + ] +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0131054288.html b/docs/bms/api-ref/en-us_topic_0131054288.html index 0202de79..b940c73e 100644 --- a/docs/bms/api-ref/en-us_topic_0131054288.html +++ b/docs/bms/api-ref/en-us_topic_0131054288.html @@ -8,7 +8,20 @@ -++Parent topic: BMS NIC Management+2022-10-30
+2023-05-06
+Added the following content:
+BMS APIs, Task Responses, and Appendix
+2023-02-28
+Modified the following content:
+Added new error codes and updated existing error codes in Error Codes.
+Added constraints in Creating BMSs.
+2022-10-30
Modified the following content:
Modified some API descriptions, including adding response parameters, modifying parameter descriptions, and modifying example formats.
diff --git a/docs/bms/api-ref/en-us_topic_0131326851.html b/docs/bms/api-ref/en-us_topic_0131326851.html new file mode 100644 index 00000000..32520180 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131326851.html @@ -0,0 +1,15 @@ + + +BMS Flavor Management
+ ++ + ++ diff --git a/docs/bms/api-ref/en-us_topic_0131326852.html b/docs/bms/api-ref/en-us_topic_0131326852.html new file mode 100644 index 00000000..44fb01a8 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131326852.html @@ -0,0 +1,430 @@ + + +++Parent topic: BMS APIs+Querying Details About Flavors and Extended Flavor Information
+++Function
This API is used to query details about BMS flavors and extended flavor information. You can call this API to query the value of parameter baremetal:extBootType to check whether a flavor supports quick BMS provisioning.
++URI
GET /v1/{project_id}/baremetalservers/flavors?availability_zone={availability_zone}
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
++Request
++Response
- Response parameters
++ +
+Parameter
+Type
+Description
+flavors
+Array of objects
+Specifies BMS flavors. For details, see Table 2.
++ +
+Table 2 flavors field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a BMS flavor.
+name
+String
+Specifies the name of a BMS flavor.
+vcpus
+String
+Specifies the number of CPU cores in a BMS flavor.
+ram
+Integer
+Specifies the memory size (MB) in a BMS flavor.
+disk
+String
+Specifies the system disk size in a BMS flavor. The value 0 indicates that the disk size is not limited.
+swap
+String
+This is a reserved attribute.
+OS-FLV-EXT-DATA:ephemeral
+Integer
+This is a reserved attribute.
+OS-FLV-DISABLED:disabled
+Boolean
+This is a reserved attribute.
+rxtx_factor
+Float
+This is a reserved attribute.
+rxtx_quota
+String
+This is a reserved attribute.
+rxtx_cap
+String
+This is a reserved attribute.
+os-flavor-access:is_public
+Boolean
+Specifies whether a flavor is public.
+false indicates a private flavor and true indicates a public flavor.
+links
+Array of objects
+Specifies shortcut links of a flavor. For details, see Table 3.
+os_extra_specs
+Object
+Specifies extended fields of a BMS flavor. For details, see Table 4.
++ +
+Table 3 links field data structure description Parameter
+Type
+Description
+rel
+String
+Specifies the shortcut link marker name. The value can be:
+- self: resource link that contains the version number. It is used when immediate tracing is required.
- bookmark: resource link that can be stored for a long time.
href
+String
+Specifies the corresponding shortcut link.
+type
+String
+Specifies the shortcut link type.
++
+Table 4 os_extra_specs field data structure description Parameter
+Type
+Description
+resource_type
+String
+Specifies the resource type of a flavor. The value is ironic.
+capabilities:cpu_arch
+String
+Specifies the CPU architecture of the BMS. The value can be:
+- x86_64 (applicable to x86 servers)
- aarch64 (applicable to ARM servers)
baremetal:disk_detail
+String
+Specifies physical disk specifications.
+capabilities:hypervisor_type
+String
+Specifies a flavor of the Ironic type.
+baremetal:__support_evs
+String
+Specifies whether a flavor supports EVS disks.
+- true
- false
If the flavor of a BMS does not contain this parameter, EVS disks cannot be attached to the BMS.
+baremetal:extBootType
+String
+Specifies the boot source of the BMS.
+- LocalDisk: local disk
- Volume: EVS disk (quick provisioning)
capabilities:board_type
+String
+Specifies the type of a BMS flavor in the format of flavor abbreviation. For example, if the flavor name is physical.o2.medium, the flavor type is o2m.
+baremetal:net_num
+String
+Specifies the maximum number of NICs on the BMS.
+baremetal:netcard_detail
+String
+Specifies physical NIC specifications.
+baremetal:cpu_detail
+String
+Specifies physical CPU specifications.
+baremetal:memory_detail
+String
+Specifies physical memory specifications.
+cond:operation:status
+String
+Specifies the status of a BMS flavor. If this parameter is not set, its default value is normal.
+- normal: indicates normal commercial use of the flavor.
- abandon: indicates that the flavor has been disabled (not displayed).
- sellout: indicates that the flavor has been sold out.
- obt: indicates that the flavor is under OBT.
- promotion: indicates the recommended flavor (commercial use, which is similar to normal).
cond:operation:az
+String
+Specifies the status of a BMS flavor in an AZ.
+This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the cond:operation:status parameter is used by default.
+Its format is az (xx). xx indicates the status of a BMS flavor in an AZ, and it is mandatory.
+For example, a flavor is for commercial use in AZ0 and AZ3, sold out in AZ1, for OBT in AZ2, and is canceled in other AZs. Then, set parameters as follows:
+- cond:operation:status: abandon
- cond:operation:az: az0(normal), az1(sellout), az2(obt), az3(promotion)
NOTE:+Configure this parameter if the flavor status in an AZ is different from the cond:operation:status value.
+ - Example response++ +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43
{ + "flavors": [ + { + "id": "physical.kl1.3xlarge", + "name": "physical.kl1.3xlarge", + "vcpus": "24", + "ram": 321729, + "disk": "6707", + "swap": "", + "links": [ + { + "rel": "self", + "href": "https://compute.Region.dc1.domainname.com/v2/bbf1946d374b44a0a2a95533562ba954/flavors/physical.kl1.3xlarge", + "type": null + }, + { + "rel": "bookmark", + "href": "https://compute.Region.dc1.domainname.com/bbf1946d374b44a0a2a95533562ba954/flavors/physical.kl1.3xlarge", + "type": null + } + ], + "OS-FLV-EXT-DATA:ephemeral": 0, + "rxtx_factor": 1, + "OS-FLV-DISABLED:disabled": false, + "rxtx_quota": null, + "rxtx_cap": null, + "os-flavor-access:is_public": false, + "os_extra_specs": { + "capabilities:cpu_arch": "x86_64", + "baremetal:disk_detail": "SAS SSD:2*800G Raid 1 + NVMe SSD Card1.6T", + "capabilities:hypervisor_type": "ironic", + "baremetal:__support_evs": "true", + "baremetal:extBootType": "LocalDisk", + "capabilities:board_type": "o2m", + "baremetal:net_num": "2", + "baremetal:netcard_detail": "2 x 2*10GE", + "baremetal:cpu_detail": "Intel Xeon E5-2667 V4 (2*8core* 3.2 GHz)", + "resource_type": "ironic", + "baremetal:memory_detail": "256GB DDR4 RAM(GB)" + } + } + ] +} +
+Returned Values
Normal values +++
+Returned Values
+Description
+200
+The request has been successfully processed.
+For details about other returned values, see Status Codes.
++Error Codes
See Error Codes.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0131356391.html b/docs/bms/api-ref/en-us_topic_0131356391.html new file mode 100644 index 00000000..3e9964b6 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131356391.html @@ -0,0 +1,239 @@ + + +++Parent topic: BMS Flavor Management+Starting BMSs
+++Function
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 the task is delivered successfully. To check whether the task is successful, use the Querying Task Statuses API.
++URI
POST /v1/{project_id}/baremetalservers/action
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
++Request
- Request parameters+ +
In the request, the parameters to start BMSs must be sent with field os-start. For details, see the example request.
++ +
+Parameter
+Mandatory
+Type
+Description
+os-start
+Yes
+Object
+Specifies the operation to start BMSs. For details, see Table 2.
++ +
+Table 2 os-start field data structure description Parameter
+Mandatory
+Type
+Description
+servers
+Yes
+Array of objects
+Specifies BMS IDs. For details, see Table 3.
++
+Table 3 servers field data structure description Parameter
+Mandatory
+Type
+Description
+id
+Yes
+String
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
+ - Example request++ +
1POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action +
++ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12
{ + "os-start": { + "servers": [ + { + "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" + }, + { + "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" + } + ] + } +} +
+Response
- Normal response
+
+Table 4 Normal response Parameter
+Type
+Description
+job_id
+String
+Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
+- Abnormal response
+ + +
+Table 5 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure
+Specifies the error returned when a task submission encounters an exception. For details, see Table 6.
++Example Response
- Normal response++ +
1 +2 +3
{ + "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0131356392.html b/docs/bms/api-ref/en-us_topic_0131356392.html new file mode 100644 index 00000000..73122287 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131356392.html @@ -0,0 +1,251 @@ + + +++Parent topic: BMS Status Management+Restarting BMSs
+++Function
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 that the task is delivered successfully. To check whether the task is successful, use the Querying Task Statuses API.
++URI
POST /v1/{project_id}/baremetalservers/action
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
++Request
- Request parameters+ +
In the request, the parameters to restart BMSs must be sent using the parameter reboot. For details, see the example request.
++ +
+Parameter
+Mandatory
+Type
+Description
+reboot
+Yes
+Object
+Specifies the operation to restart BMSs. For details, see Table 2.
++ +
+Table 2 reboot field data structure description Parameter
+Mandatory
+Type
+Description
+type
+Yes
+String
+Specifies the BMS reboot type.
+- SOFT: soft restart (invalid)
- HARD: hard restart (default)
servers
+Yes
+Array of objects
+Specifies BMS IDs. For details, see Table 3.
++
+Table 3 servers field data structure description Parameter
+Mandatory
+Type
+Description
+id
+Yes
+String
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
+ - Example request++ +
1POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action +
++ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13
{ + "reboot": { + "type": "HARD", + "servers": [ + { + "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" + }, + { + "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" + } + ] + } +} +
+Response
- Normal response
+
+Table 4 Normal response Parameter
+Type
+Description
+job_id
+String
+Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
+- Abnormal response
+ + +
+Table 5 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure
+Specifies the error returned when a task submission encounters an exception. For details, see Table 6.
++Example response
- Normal response++ +
1 +2 +3
{ + "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0131356393.html b/docs/bms/api-ref/en-us_topic_0131356393.html new file mode 100644 index 00000000..6b29e753 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131356393.html @@ -0,0 +1,251 @@ + + +++Parent topic: BMS Status Management+Stopping BMSs
+++Function
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 task is delivered successfully. To check whether the task is successful, use the Querying Task Statuses API.
++URI
POST /v1/{project_id}/baremetalservers/action
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
++Request
- Request parameters+ +
In the request, the parameters to stop BMSs must be sent using field os-stop. For details, see the example request.
++ +
+Parameter
+Mandatory
+Type
+Description
+os-stop
+Yes
+Object
+Specifies the operation to stop BMSs. For details, see Table 2.
++ +
+Table 2 os-stop field data structure description Parameter
+Mandatory
+Type
+Description
+servers
+Yes
+Array of objects
+Specifies BMS IDs. For details, see Table 3.
+type
+No
+String
+Specifies the BMS stop type.
+- SOFT: soft stop (invalid)
- HARD: hard stop (default)
+
+Table 3 servers field data structure description Parameter
+Mandatory
+Type
+Description
+id
+Yes
+String
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
+ - Example request++ +
1POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action +
++ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13
{ + "os-stop": { + "type": "HARD", + "servers": [ + { + "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" + }, + { + "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" + } + ] + } +} +
+Response
- Normal response
+
+Table 4 Normal response Parameter
+Type
+Description
+job_id
+String
+Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
+- Abnormal response
+ + +
+Table 5 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure
+Specifies the error returned when a task submission encounters an exception. For details, see Table 6.
++Example response
- Normal response++ +
1 +2 +3
{ + "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0131356398.html b/docs/bms/api-ref/en-us_topic_0131356398.html new file mode 100644 index 00000000..243d0258 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131356398.html @@ -0,0 +1,17 @@ + + +++Parent topic: BMS Status Management+Task Responses
+ +++ diff --git a/docs/bms/api-ref/en-us_topic_0131356399.html b/docs/bms/api-ref/en-us_topic_0131356399.html new file mode 100644 index 00000000..b85a18ae --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131356399.html @@ -0,0 +1,95 @@ + + +-
+
- Task ID Response
+
+ - Order ID Response
+
+
++Parent topic: Public Parameters+Task ID Response
+++Normal Response
++
+Table 1 Normal response Parameter
+Type
+Description
+job_id
+String
+Specifies the task ID after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
++Abnormal Response
++ + +
+Table 2 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure
+Specifies the error returned when a task submission encounters an exception. For details, see Table 3.
++Example Response
- Normal response++ +
1 +2 +3
{ + "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" +} +
- Abnormal response++ +
1 +2 +3
{ + "error": {"message": "", "code": XXX} +} +
++ diff --git a/docs/bms/api-ref/en-us_topic_0131356400.html b/docs/bms/api-ref/en-us_topic_0131356400.html new file mode 100644 index 00000000..bbe67a65 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131356400.html @@ -0,0 +1,104 @@ + + +++Parent topic: Task Responses+Order ID Response
+++Normal Response
++
+Table 1 Normal response Parameter
+Type
+Description
+order_id
+String
+Specifies the order ID returned after an order is submitted. You can query the order processing progress based on the ID.
+job_id
+String
+Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
++Abnormal Response
++ + +
+Table 2 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure [1]
+Specifies the error returned when a task submission encounters an exception. For details, see Table 3.
++Example Response
- Normal response++ +
1 +2 +3 +4
{ + "order_id": "CS2009141523OQSEQ", + "job_id": "ff808081748b760c01748b7f80370003" +} +
- Abnormal response++ +
1 +2 +3
{ + "error": {"message": "", "code": XXX} +} +
++ diff --git a/docs/bms/api-ref/en-us_topic_0131629814.html b/docs/bms/api-ref/en-us_topic_0131629814.html new file mode 100644 index 00000000..701ac861 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131629814.html @@ -0,0 +1,17 @@ + + +++Parent topic: Task Responses+BMS Password Management
+ ++ + ++ diff --git a/docs/bms/api-ref/en-us_topic_0131629816.html b/docs/bms/api-ref/en-us_topic_0131629816.html new file mode 100644 index 00000000..5dfb516a --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131629816.html @@ -0,0 +1,100 @@ + + +++Parent topic: BMS APIs+Obtaining the Password of a Windows BMS
+++Function
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 the installation of a Windows BMS.
+If the BMS is created from a private image, ensure that Cloudbase-Init has been installed. Cloudbase-Init is installed on public images by default.
++URI
GET /v1/{project_id}/baremetalservers/{server_id}/os-server-password
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
++Response
- Response parameters
++
+Parameter
+Type
+Description
+password
+String
+Specifies the password in ciphertext.
+ - Example response++ +
1 +2 +3
{ + "password": "UHC9+YW1xDC1Yu8Mg9n+tnOp7euEO/cW//9KgdJKWhr5w==" +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0131629817.html b/docs/bms/api-ref/en-us_topic_0131629817.html new file mode 100644 index 00000000..365d6fc5 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131629817.html @@ -0,0 +1,73 @@ + + +++Parent topic: BMS Password Management+Deleting the Password of a Windows BMS
+++Function
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 to your BMS. However, you cannot use the Get Password function to recover the BMS initial password.
+If the BMS is created from a private image, ensure that Cloudbase-Init has been installed. Cloudbase-Init is installed on public images by default.
++URI
DELETE /v1/{project_id}/baremetalservers/{server_id}/os-server-password
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
++Response
N/A
++Returned Values
Normal values +++
+Returned Value
+Description
+202
+The request has been accepted, but the processing has been delayed.
+For details about other returned values, see Status Codes.
++Error Codes
See Error Codes.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0131668048.html b/docs/bms/api-ref/en-us_topic_0131668048.html new file mode 100644 index 00000000..26d38853 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131668048.html @@ -0,0 +1,11 @@ + + +++Parent topic: BMS Password Management+API Use Instructions
++- 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.
++ diff --git a/docs/bms/api-ref/en-us_topic_0131703289.html b/docs/bms/api-ref/en-us_topic_0131703289.html new file mode 100644 index 00000000..69bc931c --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131703289.html @@ -0,0 +1,154 @@ + + +++Parent topic: BMS APIs+Updating BMS Metadata
+++Function
This API is used to update BMS metadata.
+- If the metadata does not contain the target field, the field is automatically added to the field.
- If the metadata contains the target field, the field value is automatically updated.
- If the field in the metadata is not requested, the field value remains unchanged.
+Constraints
The BMS must be in active, stopped, or paused state. The state is indicated by the OS-EXT-STS:vm_state parameter.
++URI
POST /v1/{project_id}/baremetalservers/{server_id}/metadata
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
++
+Table 2 Request parameters Parameter
+Mandatory
+Type
+Description
+metadata
+Yes
+Object
+Specifies the user-defined metadata key-value pair.
+If you do not specify any key-value pair, metadata will not be updated.
+key:
+It contains a maximum of 255 Unicode characters which can be letters, digits, hyphens (-), underscores (_), colons (:), and periods (.). key cannot be left blank.
+value:
+It contains a maximum of 255 Unicode characters.
+- Example request++ +
1POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata +
++ +1 +2 +3 +4 +5
{ + "metadata": { + "key": "value" + } +} +
+Response
++
+Table 3 Parameter description Parameter
+Mandatory
+Type
+Description
+metadata
+Yes
+Object
+Specifies the user-defined metadata key-value pair.
+If you do not specify any key-value pair, metadata will not be updated.
+key:
+It contains a maximum of 255 Unicode characters which can be letters, digits, hyphens (-), underscores (_), colons (:), and periods (.). key cannot be left blank.
+value:
+It contains a maximum of 255 Unicode characters.
+- Example response++ +
1 +2 +3 +4 +5
{ + "metadata":{ + "key": "value" + } +} +
+Returned Values
Normal values +++
+Returned Values
+Description
+200
+The request has been successfully processed.
+For details about other returned values, see Status Codes.
++Error Codes
See Error Codes.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0131703308.html b/docs/bms/api-ref/en-us_topic_0131703308.html new file mode 100644 index 00000000..86b2b9d1 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131703308.html @@ -0,0 +1,15 @@ + + +++Parent topic: BMS Metadata Management+BMS Metadata Management
+ ++ + ++ diff --git a/docs/bms/api-ref/en-us_topic_0131920832.html b/docs/bms/api-ref/en-us_topic_0131920832.html new file mode 100644 index 00000000..35e838b8 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131920832.html @@ -0,0 +1,15 @@ + + +++Parent topic: BMS APIs+BMS Quota Management
+ ++ + ++ diff --git a/docs/bms/api-ref/en-us_topic_0131920833.html b/docs/bms/api-ref/en-us_topic_0131920833.html new file mode 100644 index 00000000..71e8708b --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0131920833.html @@ -0,0 +1,269 @@ + + +++Parent topic: BMS APIs+Querying Tenant Quotas
+++Function
This API is used to query the quotas of all resources for a specified tenant, including used quotas.
++URI
GET /v1/{project_id}/baremetalservers/limits
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
++Request Parameters
None
++Example Request
Querying the quotas of a tenant (project ID: bbf1946d374b44a0a2a95533562ba954)+++ +1GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/limits +
+Response Parameters
++
+Parameter
+Type
+Description
+absolute
+Object
+Specifies tenant quotas. For details, see Table 2.
++ + Value -1 indicates that the quantity is unlimited.
++
+Table 2 absolute field data structure description Parameter
+Type
+Description
+maxTotalInstances
+Integer
+Specifies the maximum number of BMSs you can create.
+maxTotalCores
+Integer
+Specifies the maximum number of CPUs you can use.
+maxTotalRAMSize
+Integer
+Specifies the maximum memory (MB) you can use.
+maxTotalKeypairs
+Integer
+Specifies the maximum number of SSH key pairs you can use.
+maxServerMeta
+Integer
+Specifies the maximum length of the metadata you can use.
+maxServerGroups
+Integer
+Specifies the maximum number of server groups.
+maxServerGroupMembers
+Integer
+Specifies the maximum number of BMSs in a server group.
+totalServerGroupsUsed
+Integer
+Specifies the number of used server groups.
+maxSecurityGroups
+Integer
+Specifies the maximum number of security groups you can use.
+NOTE:+The quota limit complies with the VPC quota limit.
+maxSecurityGroupRules
+Integer
+Specifies the maximum number of security group rules that you can configure in a security group.
+NOTE:+The quota limit complies with the VPC quota limit.
+maxTotalFloatingIps
+Integer
+Specifies the maximum number of EIPs you can use.
+maxImageMeta
+Integer
+Specifies the maximum length of the image metadata.
+totalInstancesUsed
+Integer
+Specifies the number of the used BMSs.
+totalCoresUsed
+Integer
+Specifies the number of used CPUs.
+totalRAMUsed
+Integer
+Specifies the used memory (MB).
+totalSecurityGroupsUsed
+Integer
+Specifies the number of used security groups.
+totalFloatingIpsUsed
+Integer
+Specifies the number of used EIPs.
++Example Response
++ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23
{ + "absolute": { + "maxServerMeta": 128, + "maxPersonality": 5, + "maxImageMeta": 128, + "maxPersonalitySize": 10240, + "maxSecurityGroupRules": 20, + "maxTotalKeypairs": 100, + "totalRAMUsed": 799836, + "totalInstancesUsed": 21, + "maxSecurityGroups": 10, + "totalFloatingIpsUsed": 0, + "maxTotalCores": -1, + "totalSecurityGroupsUsed": 1, + "maxTotalFloatingIps": 10, + "maxTotalInstances": 100, + "totalCoresUsed": 148, + "maxTotalRAMSize": -1, + "maxServerGroups": -1, + "maxServerGroupMembers": -1, + "totalServerGroupsUsed": 1 + } +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0132973615.html b/docs/bms/api-ref/en-us_topic_0132973615.html new file mode 100644 index 00000000..f2c07cb1 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0132973615.html @@ -0,0 +1,17 @@ + + +++Parent topic: BMS Quota Management+API Version Query
+ ++ + ++ diff --git a/docs/bms/api-ref/en-us_topic_0132973804.html b/docs/bms/api-ref/en-us_topic_0132973804.html new file mode 100644 index 00000000..e0460dde --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0132973804.html @@ -0,0 +1,181 @@ + + +++Parent topic: BMS APIs+Querying API Versions
+++Function
This API is used to query all available API versions of the BMS service.
++ +URI
GET /
++Response
- Response parameters
++ +
+Parameter
+Type
+Description
+versions
+Array of objects
+Specifies API versions of the BMS service. For details, see Table 1.
++ +
+Table 1 versions field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the API version ID.
+links
+Array of objects
+Specifies the API URL. For details, see Table 2.
+min_version
+String
+Specifies the earliest micro API version that is supported.
+status
+String
+Specifies the API version status.
+- CURRENT: indicates a primary version.
- SUPPORTED: indicates an earlier version which is still supported.
- DEPRECATED: indicates a deprecated version which may be deleted later.
updated
+String
+Specifies the release date of an API version.
+The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2018-09-30T00:00:00Z.
+version
+String
+Specifies the latest micro API version that is supported.
++
+Table 2 links field data structure description Parameter
+Type
+Description
+href
+String
+Specifies the API URL.
+rel
+String
+Specifies the API URL dependency. The value can be:
+- self: resource link that contains the version number. It is used when immediate tracing is required.
- bookmark: resource link that can be stored for a long time.
- Example response++ +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17
{ + "versions": [ + { + "id": "v1", + "links": [ + { + "href": "http://bms.xxx.com/v1/", + "rel": "self" + } + ], + "min_version": "", + "status": "CURRENT", + "updated": "2018-09-30T00:00:00Z", + "version": "" + } + ] +} +
+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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0132973805.html b/docs/bms/api-ref/en-us_topic_0132973805.html new file mode 100644 index 00000000..816413ca --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0132973805.html @@ -0,0 +1,198 @@ + + +++Parent topic: API Version Query+Querying an API Version
+++ + +Function
This API is used to query a specified API version of the BMS service.
++Response
- Response parameters
++ +
+Parameter
+Type
+Description
+version
+Object
+Specifies a specified API version of the BMS service. For details, see Table 2.
++ +
+Table 2 version field data structure description Parameter
+Type
+Description
+id
+String
+Specifies the API version ID.
+links
+Array of objects
+Specifies the API URL. For details, see Table 3.
+min_version
+String
+Specifies the earliest micro API version that is supported.
+status
+String
+Specifies the API version status.
+- CURRENT: indicates a primary version.
- SUPPORTED: indicates an earlier version that is still supported.
- DEPRECATED: indicates a deprecated version that may be deleted later.
updated
+String
+Specifies the release date of an API version.
+The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2018-09-30T00:00:00Z.
+version
+String
+Specifies the latest micro API version that is supported.
++
+Table 3 links field data structure description Parameter
+Type
+Description
+href
+String
+Specifies the API URL.
+rel
+String
+Specifies the API URL dependency. The value can be:
+- self: resource link that contains the version number. It is used when immediate tracing is required.
- bookmark: resource link that can be stored for a long time.
- Example response++ +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15
{ + "version": { + "id": "v1", + "links": [ + { + "href": "http://bms.xxx.com/v1/", + "rel": "self" + } + ], + "min_version": "", + "status": "CURRENT", + "updated": "2018-09-30T00:00:00Z", + "version": "" + } +} +
+Returned Values
Normal values +++
+Return Value
+Description
+200
+The request has been successfully processed.
+For details about other returned values, see Status Codes.
++Error Codes
See Error Codes.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0134720582.html b/docs/bms/api-ref/en-us_topic_0134720582.html index ca8ed12d..8b5f8887 100644 --- a/docs/bms/api-ref/en-us_topic_0134720582.html +++ b/docs/bms/api-ref/en-us_topic_0134720582.html @@ -6,7 +6,7 @@++Parent topic: API Version Query+URI
GET /
Request Message
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0134720583.html b/docs/bms/api-ref/en-us_topic_0134720583.html index 99e0ae3f..c788e2b2 100644 --- a/docs/bms/api-ref/en-us_topic_0134720583.html +++ b/docs/bms/api-ref/en-us_topic_0134720583.html @@ -26,7 +26,7 @@
1GET https://{ECS Endpoint}/ +
- Example request
@@ -103,21 +103,21 @@ 12 13 14 -151GET https://{ECS Endpoint}/
{ - "versions": [ - { - "links": [ - { - "rel": "self", - "href": "https://192.168.82.231:443/v2/" - } - ], - "id": "v2.0", - "updated": "2018-09-21T12:33:21Z", - "status": "SUPPORTED" - } - ] -} +15
{ + "versions": [ + { + "links": [ + { + "rel": "self", + "href": "https://192.168.82.231:443/v2/" + } + ], + "id": "v2.0", + "updated": "2018-09-21T12:33:21Z", + "status": "SUPPORTED" + } + ] +}
- Example request
Request Message
- Request parameters -
- Example requestdiff --git a/docs/bms/api-ref/en-us_topic_0171277623.html b/docs/bms/api-ref/en-us_topic_0171277623.html new file mode 100644 index 00000000..f19119a6 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0171277623.html @@ -0,0 +1,11 @@ + + +
1GET https://{ECS Endpoint}/v2 +
- Example request
@@ -134,32 +134,32 @@ 23 24 25 -261GET https://{ECS Endpoint}/v2
{ - "version": { - "min_version": "", - "media-types": [ - { - "type": "application/vnd.openstack.compute+json;version=2", - "base": "application/json" - } - ], - "links": [ - { - "rel": "self", - "href": "https://ecs.service.domain.com:443/v2/" - }, - { - "rel": "describedby", - "href": "http://docs.openstack.org/", - "type": "text/html" - } - ], - "id": "v2.0", - "updated": "1999-02-20T11:33:21Z", - "version": "", - "status": "SUPPORTED" - } -} +26
{ + "version": { + "min_version": "", + "media-types": [ + { + "type": "application/vnd.openstack.compute+json;version=2", + "base": "application/json" + } + ], + "links": [ + { + "rel": "self", + "href": "https://ecs.service.domain.com:443/v2/" + }, + { + "rel": "describedby", + "href": "http://docs.openstack.org/", + "type": "text/html" + } + ], + "id": "v2.0", + "updated": "1999-02-20T11:33:21Z", + "version": "", + "status": "SUPPORTED" + } +}
Appendix
+ ++ ++ diff --git a/docs/bms/api-ref/en-us_topic_0171277624.html b/docs/bms/api-ref/en-us_topic_0171277624.html new file mode 100644 index 00000000..061b2cfb --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0171277624.html @@ -0,0 +1,53 @@ + + +Obtaining a Project ID
+++Scenarios
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 Calling an API
You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.
+The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints.
+The following is an example response. The value of id is the project ID.
+{ + "projects": [ + { + "domain_id": "65382450e8f64ac0870cd180d14e684b", + "is_domain": false, + "parent_id": "65382450e8f64ac0870cd180d14e684b", + "name": "project_name", + "description": "", + "links": { + "next": null, + "previous": null, + "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" + }, + "id": "a4a5d4098fb4474fa22cd05f897d6b99", + "enabled": true + } + ], + "links": { + "next": null, + "previous": null, + "self": "https://www.example.com/v3/projects" + } +}++Obtain a Project ID from the Console
A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:+- Log in to the management console.
- Click the username and select My Credentials from the drop-down list.
On the My Credentials page, view project IDs in the project list.
+Figure 1 Viewing project IDs+
In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.
+
++ + + \ No newline at end of file diff --git a/docs/bms/api-ref/en-us_topic_0173933989.html b/docs/bms/api-ref/en-us_topic_0173933989.html index 2be23a53..149a2ac2 100644 --- a/docs/bms/api-ref/en-us_topic_0173933989.html +++ b/docs/bms/api-ref/en-us_topic_0173933989.html @@ -1,6 +1,6 @@ -++Parent topic: Appendix+BMS Metadata Management
+BMS Metadata Management
-
diff --git a/docs/bms/api-ref/en-us_topic_0191726734.html b/docs/bms/api-ref/en-us_topic_0191726734.html
new file mode 100644
index 00000000..441ea07c
--- /dev/null
+++ b/docs/bms/api-ref/en-us_topic_0191726734.html
@@ -0,0 +1,138 @@
+
+
+
- This API can only be used to delete pay-per-use BMSs.
- Request parameters
++ + +
+Parameter
+Mandatory
+Type
+Description
+servers
+Yes
+Array of objects
+Specifies the BMSs to be deleted. For details, see Table 2.
+delete_publicip
+Yes
+Boolean
+Specifies whether to delete the EIP bound to the BMS when the BMS is deleted. If you choose not to delete the EIP, the system only unbinds the EIP from the BMS and reserves the EIP.
+The value can be true or false. The default value is false.
+- true: The EIP bound to the BMS is deleted when the BMS is deleted.
- false: The EIP is unbound from the BMS when the BMS is deleted, but not deleted.
delete_volume
+No
+Boolean
+Specifies whether to delete a data disk attached to the BMS when the BMS is deleted. If you choose not to delete the data disk, the system only detaches the disk from the BMS and reserves the disk.
+The value can be true or false. The default value is false.
+- true: The data disk attached to the BMS is deleted when the BMS is deleted.
- false: The data disk is detached from the BMS when the BMS is deleted, but not deleted.
- Example request
{ + "servers": [ + { + "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" + } + ], + "delete_publicip": false, + "delete_volume": false +}+ - Request parameters
++ +
+Parameter
+Mandatory
+Type
+Description
+nics
+Yes
+Array of objects
+Specifies the NICs to be attached. For details, see Table 2.
+Constraints:
+Currently, you can concurrently attach a maximum of 10 NICs to a BMS. If more than 10 NICs are attached concurrently, the attachment may fail.
++ + +
+Table 2 nics field data structure description Parameter
+Mandatory
+Type
+Description
+subnet_id
+Yes
+String
+Specifies the subnet ID of the NIC.
+You can obtain the subnet ID (in UUID format) from the console or by referring to in Virtual Private Cloud API Reference.
+Constraints:
+- If subnet_id is specified, the value of quota:min_rate will be used as the minimum NIC bandwidth by default.
- If subnet_id is specified, the value of quota:vif_multiqueue_num will be used as the number of queues for a NIC by default.
- For details about quota:min_rate and quota:vif_multiqueue_num, see Querying Details About extra_specs Parameters of a BMS Flavor (Native OpenStack API).
security_groups
+No
+Array of objects
+Specifies the security groups for the NIC. For details, see Table 3.
+Constraints:
+This parameter is valid only when subnet_id is specified. It is mandatory when subnet_id is used to attach NICs across tenants.
+ip_address
+No
+String
+Specifies the IP address of the NIC. If this parameter is left blank, the IP address is automatically assigned.
+Constraints:
+This parameter is valid only if subnet_id is specified.
+ - Example request
{ + "nics": [ + { + "subnet_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23", + "security_groups": [ + { + "id": "f0ac4394-7e4a-4409-9701-ba8be283dbc3" + } + ] + } + ] +}+ - Response parameters
- Normal response++ +
1 +2 +3
{ + "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" +} +
- Request parameters
++ + +
+Parameter
+Mandatory
+Type
+Description
+nics
+Yes
+Array of objects
+Specifies the NICs to be detached. For details, see Table 2.
+ - Example request
{ + "nics": [ + { + "id": "d32019d3-bc6e-4319-9c1d-6722fc136a23" + } + ] +}+ - Response parameters
- Normal response++ +
1 +2 +3
{ + "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" +} +
- Request parameters
++ + +
+Parameter
+Mandatory
+Type
+Description
+interface_attachment
+Yes
+Object
+Specifies the attribute to be modified. For details, see Table 2.
+ - Example request
{ + "interface_attachment" : { + "delete_on_termination": false + } +}+
Deleting BMSs
+++Function
This API is used to delete specified BMSs in a batch or one by one.
++Constraints
+URI
POST /v1/{project_id}/baremetalservers/delete
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
++Request
+Response
See Task ID Response.
++Returned Values
Normal values +++
+Returned Value
+Description
+200
+The request has been successfully processed.
+For details about other returned values, see Status Codes.
++Error Codes
See Error Codes.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0229339177.html b/docs/bms/api-ref/en-us_topic_0229339177.html new file mode 100644 index 00000000..ea5b23d7 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0229339177.html @@ -0,0 +1,250 @@ + + +++Parent topic: BMS Lifecycle Management+Attaching NICs to a BMS
+++Function
This API is used to attach one or more NICs to a BMS.
++URI
POST /v1/{project_id}/baremetalservers/{server_id}/nics
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
+ +Response
+ +
+Table 4 Normal response Parameter
+Type
+Description
+job_id
+String
+Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
++ +
+Table 5 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure
+Specifies the error returned when a task submission encounters an exception. For details, see Table 6.
++
+Table 6 error data structure Parameter
+Type
+Description
+message
+String
+Specifies the error message.
+code
+String
+Specifies the error code.
++Example 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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0229339178.html b/docs/bms/api-ref/en-us_topic_0229339178.html new file mode 100644 index 00000000..e1acd5f2 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0229339178.html @@ -0,0 +1,197 @@ + + +++Parent topic: BMS NIC Management+Detaching NICs from a BMS
+++Function
This API is used to detach one or more NICs from a BMS.
++ The primary NIC of a BMS has routing rules configured and cannot be detached.
++URI
POST /v1/{project_id}/baremetalservers/{server_id}/nics/delete
+Table 1 lists the parameters. +++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
++Request
+ +Response
+ +
+Table 3 Normal response Parameter
+Type
+Description
+job_id
+String
+Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.
+For details about how to query the task execution status based on job_id, see Querying Task Statuses.
++ +
+Table 4 Abnormal response Parameter
+Type
+Description
+error
+Dictionary data structure
+Specifies the error returned when a task submission encounters an exception. For details, see Table 5.
++
+Table 5 error data structure Parameter
+Type
+Description
+message
+String
+Specifies the error message.
+code
+String
+Specifies the error code.
++Example 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.
+++ diff --git a/docs/bms/api-ref/en-us_topic_0229339179.html b/docs/bms/api-ref/en-us_topic_0229339179.html new file mode 100644 index 00000000..15aea7b8 --- /dev/null +++ b/docs/bms/api-ref/en-us_topic_0229339179.html @@ -0,0 +1,125 @@ + + +++Parent topic: BMS NIC Management+Modifying Attributes of a BMS NIC
+++Function
This API is used to specify whether to delete a NIC when the BMS is deleted or the NIC is detached.
++URI
PUT /v1/{project_id}/baremetalservers/{server_id}/os-interface/{port_id}
+Table 1 lists the parameters.
+ ++
+Table 1 Parameter description Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+For details about how to obtain the project ID, see Obtaining a Project ID.
+server_id
+Yes
+Specifies the BMS ID.
+You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).
+port_id
+Yes
+Specifies the BMS NIC ID.
++Request
+Response
None
++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.
+++ diff --git a/docs/bms/api-ref/public_sys-resources/imageclose.gif b/docs/bms/api-ref/public_sys-resources/imageclose.gif new file mode 100644 index 00000000..3a3344af Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/imageclose.gif differ diff --git a/docs/bms/api-ref/public_sys-resources/imageclosehover.gif b/docs/bms/api-ref/public_sys-resources/imageclosehover.gif new file mode 100644 index 00000000..8699d5e3 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/imageclosehover.gif differ diff --git a/docs/bms/api-ref/public_sys-resources/imagemax.gif b/docs/bms/api-ref/public_sys-resources/imagemax.gif new file mode 100644 index 00000000..99c07dc2 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/imagemax.gif differ diff --git a/docs/bms/api-ref/public_sys-resources/imagemaxhover.gif b/docs/bms/api-ref/public_sys-resources/imagemaxhover.gif new file mode 100644 index 00000000..d01d77d6 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/imagemaxhover.gif differ diff --git a/docs/bms/api-ref/public_sys-resources/macFFBgHack.png b/docs/bms/api-ref/public_sys-resources/macFFBgHack.png new file mode 100644 index 00000000..ec811470 Binary files /dev/null and b/docs/bms/api-ref/public_sys-resources/macFFBgHack.png differ++Parent topic: BMS NIC Management+ - Example request
- Example request
- Example request
- Example request
- Example request
- Example request
- Example request