From c5b496f0d7057f2cd625c4dfa2dc21ba2cc66e47 Mon Sep 17 00:00:00 2001 From: "Huijuan, Wang" Date: Wed, 21 Aug 2024 14:15:39 +0000 Subject: [PATCH] ECS API 20240812 version Reviewed-by: Pristromskaia, Margarita Co-authored-by: Huijuan, Wang Co-committed-by: Huijuan, Wang --- docs/ecs/api-ref/en-us_topic_0020212656.html | 4 ++-- docs/ecs/api-ref/en-us_topic_0020212658.html | 18 ++++++++-------- docs/ecs/api-ref/en-us_topic_0020212659.html | 14 ++++++------- docs/ecs/api-ref/en-us_topic_0020212676.html | 2 +- docs/ecs/api-ref/en-us_topic_0024734483.html | 14 ++++++++++--- docs/ecs/api-ref/en-us_topic_0065817705.html | 6 +++--- docs/ecs/api-ref/en-us_topic_0110472767.html | 14 ++++++------- docs/ecs/api-ref/en-us_topic_0167957246.html | 22 +++++++++++++++----- 8 files changed, 57 insertions(+), 37 deletions(-) diff --git a/docs/ecs/api-ref/en-us_topic_0020212656.html b/docs/ecs/api-ref/en-us_topic_0020212656.html index b21a79c3..e4e203e2 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212656.html +++ b/docs/ecs/api-ref/en-us_topic_0020212656.html @@ -405,12 +405,12 @@ "links": [ { "rel": "self", - "href": "https://ecs.region.xxx.com/v1.0/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", + "href": "https://ecs.region.example.com/v1.0/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "type": null }, { "rel": "bookmark", - "href": "https://ecs.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", + "href": "https://ecs.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "type": null } ], diff --git a/docs/ecs/api-ref/en-us_topic_0020212658.html b/docs/ecs/api-ref/en-us_topic_0020212658.html index b8c5f280..6102160c 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212658.html +++ b/docs/ecs/api-ref/en-us_topic_0020212658.html @@ -163,7 +163,7 @@

String

Specifies the swap partition size required by the ECS flavor.

-

This parameter has not been used. Its default value is "".

+

This parameter has not been used. Its default value is "".

OS-FLV-EXT-DATA:ephemeral

@@ -171,7 +171,7 @@

Integer

Specifies the temporary disk size. This is an extended attribute.

-

This parameter has not been used. Its default value is 0.

+

This parameter has not been used. Its default value is 0.

OS-FLV-DISABLED:disabled

@@ -179,7 +179,7 @@

Boolean

Specifies whether the ECS flavor has been disabled. This is an extended attribute.

-

This parameter has not been used. Its default value is false.

+

This parameter has not been used. Its default value is false.

rxtx_factor

@@ -187,7 +187,7 @@

Float

Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS.

-

This parameter has not been used. Its default value is 1.0.

+

This parameter has not been used. Its default value is 1.0.

os-flavor-access:is_public

@@ -195,7 +195,7 @@

Boolean

Specifies whether a flavor is available to all tenants. This is an extended attribute.

-
  • true: indicates that a flavor is available to all tenants.
  • false: indicates that a flavor is available only to certain tenants.
+
  • true: indicates that a flavor is available to all tenants.
  • false: indicates that a flavor is available only to certain tenants.

Default value: true

@@ -246,11 +246,11 @@ GET https://{endpoint}/v2.1 "name": "c3.2xlarge.2", "links": [ { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", + "href": "https://compute.region.example.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "self" }, { - "href": "https://compute.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", + "href": "https://compute.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "bookmark" } ], @@ -268,11 +268,11 @@ GET https://{endpoint}/v2.1 "name": "c3.2xlarge.4", "links": [ { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.4", + "href": "https://compute.region.example.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.4", "rel": "self" }, { - "href": "https://compute.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.4", + "href": "https://compute.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.4", "rel": "bookmark" } ], diff --git a/docs/ecs/api-ref/en-us_topic_0020212659.html b/docs/ecs/api-ref/en-us_topic_0020212659.html index 9058ab8c..d057a787 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212659.html +++ b/docs/ecs/api-ref/en-us_topic_0020212659.html @@ -112,7 +112,7 @@

String

Specifies the swap partition size required by the ECS flavor.

-

This parameter has not been used. Its default value is "".

+

This parameter has not been used. Its default value is "".

OS-FLV-EXT-DATA:ephemeral

@@ -120,7 +120,7 @@

Integer

Specifies the temporary disk size. This is an extended attribute.

-

This parameter has not been used. Its default value is 0.

+

This parameter has not been used. Its default value is 0.

OS-FLV-DISABLED:disabled

@@ -128,7 +128,7 @@

Boolean

Specifies whether the ECS flavor has been disabled. This is an extended attribute.

-

This parameter has not been used. Its default value is false.

+

This parameter has not been used. Its default value is false.

rxtx_factor

@@ -136,7 +136,7 @@

Float

Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS.

-

This parameter has not been used. Its default value is 1.0.

+

This parameter has not been used. Its default value is 1.0.

os-flavor-access:is_public

@@ -144,7 +144,7 @@

Boolean

Specifies whether a flavor is available to all tenants. This is an extended attribute.

-
  • true: indicates that a flavor is available to all tenants.
  • false: indicates that a flavor is available only to certain tenants.
+
  • true: indicates that a flavor is available to all tenants.
  • false: indicates that a flavor is available only to certain tenants.

Default value: true

@@ -195,11 +195,11 @@ GET https://{endpoint}/v2.1 "name": "c3.2xlarge.2", "links": [ { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", + "href": "https://compute.region.example.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "self" }, { - "href": "https://compute.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", + "href": "https://compute.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "bookmark" } ], diff --git a/docs/ecs/api-ref/en-us_topic_0020212676.html b/docs/ecs/api-ref/en-us_topic_0020212676.html index 746b344f..2b97af66 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212676.html +++ b/docs/ecs/api-ref/en-us_topic_0020212676.html @@ -67,7 +67,7 @@ -
Table 4 keypair field description

Parameter

+
diff --git a/docs/ecs/api-ref/en-us_topic_0024734483.html b/docs/ecs/api-ref/en-us_topic_0024734483.html index 6be54439..8f43cca0 100644 --- a/docs/ecs/api-ref/en-us_topic_0024734483.html +++ b/docs/ecs/api-ref/en-us_topic_0024734483.html @@ -8,7 +8,15 @@ - + + + @@ -312,12 +312,12 @@ "links": [ { "rel": "self", - "href": "https://compute-ext.region.xxx.com/v1.0/743b4c0428d94531b9f2add666642e6b/flavors/c3.15xlarge.2", + "href": "https://compute-ext.region.example.com/v1.0/743b4c0428d94531b9f2add666642e6b/flavors/c3.15xlarge.2", "type": null }, { "rel": "bookmark", - "href": "https://compute-ext.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.15xlarge.2", + "href": "https://compute-ext.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.15xlarge.2", "type": null } ], diff --git a/docs/ecs/api-ref/en-us_topic_0167957246.html b/docs/ecs/api-ref/en-us_topic_0167957246.html index 33f2a980..8c28b644 100644 --- a/docs/ecs/api-ref/en-us_topic_0167957246.html +++ b/docs/ecs/api-ref/en-us_topic_0167957246.html @@ -165,7 +165,7 @@
Table 4 keypair field description

Parameter

Type

2024-07-23

+

2024-08-12

+

Modified the following content:

+

Modified parameter description of availability_zone in Creating an ECS.

+

Modified parameter description of injected_file_path_bytes in Querying Tenant Quotas.

+

Added parameter CB_CSBS_BACKUP in Data Structure for Creating ECSs.

+

2024-07-23

Modified the following content:

Modified the description about the parameter name and added the parameter description in Creating an ECS.

@@ -266,13 +274,13 @@

2018-05-31

Modified the following content:

-
  • Fixed 59 UAT issues in Elastic Cloud Server API Reference 27.
+
  • Fixed 59 UAT issues in Elastic Cloud Server API Reference 27.

2018-05-21

Modified the following content:

- +

2018-03-30

diff --git a/docs/ecs/api-ref/en-us_topic_0065817705.html b/docs/ecs/api-ref/en-us_topic_0065817705.html index 51d35a15..08480860 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817705.html +++ b/docs/ecs/api-ref/en-us_topic_0065817705.html @@ -179,11 +179,11 @@ GET https://{endpoint}/v2. "id": "s3.xlarge.1", "links": [ { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/s3.xlarge.1", + "href": "https://compute.region.example.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/s3.xlarge.1", "rel": "self" }, { - "href": "https://compute.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/s3.xlarge.1", + "href": "https://compute.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/s3.xlarge.1", "rel": "bookmark" } ], @@ -193,7 +193,7 @@ GET https://{endpoint}/v2. "id": "s3.xlarge.2", "links": [ { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/s3.xlarge.2", + "href": "https://compute.region.example.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/s3.xlarge.2", "rel": "self" }, { diff --git a/docs/ecs/api-ref/en-us_topic_0110472767.html b/docs/ecs/api-ref/en-us_topic_0110472767.html index 6ed0e901..9f38fb5e 100644 --- a/docs/ecs/api-ref/en-us_topic_0110472767.html +++ b/docs/ecs/api-ref/en-us_topic_0110472767.html @@ -182,7 +182,7 @@

String

Specifies the swap partition size required by the ECS flavor.

-

This parameter has not been used. Its default value is "".

+

This parameter has not been used. Its default value is "".

OS-FLV-EXT-DATA:ephemeral

@@ -190,7 +190,7 @@

Integer

Specifies the temporary disk size. This is an extended attribute.

-

This parameter has not been used. Its default value is 0.

+

This parameter has not been used. Its default value is 0.

OS-FLV-DISABLED:disabled

@@ -217,7 +217,7 @@

String

Specifies the software constraints of the network bandwidth that can be used by the ECS.

-

This parameter has not been used. Its default value is null.

+

This parameter has not been used. Its default value is null.

rxtx_cap

@@ -225,7 +225,7 @@

String

Specifies the hardware constraints of the network bandwidth that can be used by the ECS.

-

This parameter has not been used. Its default value is null.

+

This parameter has not been used. Its default value is null.

os-flavor-access:is_public

@@ -233,7 +233,7 @@

Boolean

Specifies whether a flavor is available to all tenants. This is an extended attribute.

-
  • true: indicates that a flavor is available to all tenants.
  • false: indicates that a flavor is available only to certain tenants.
+
  • true: indicates that a flavor is available to all tenants.
  • false: indicates that a flavor is available only to certain tenants.

Default value: true
-

ipv6_bandwidth Field Description

This field is used by the following APIs:
  • Creating ECSs /v1/{project_id}/cloudservers
+

ipv6_bandwidth Field Description

This field is used by the following APIs:
  • Creating ECSs /v1/{project_id}/cloudservers
@@ -194,7 +194,7 @@

extendparam Field Description for Creating Disks

This field is used by the following APIs:

  • Creating ECSs /v1/{project_id}/cloudservers
-
Table 5 ipv6_bandwidth field description

Parameter

@@ -475,7 +487,7 @@

extra_dhcp_opts Field Description

This field is used by the following APIs:
  • Creating ECSs: /v1/{project_id}/cloudservers
-
Table 6 extendparam field description for creating disks

Parameter

+
@@ -252,6 +252,18 @@ + + + + +
Table 6 extendparam field description for creating disks

Parameter

Mandatory

Specifies the ID of the region where the ECS resides.

CB_CSBS_BACKUP

+

No

+

String

+

Specifies a CSBS policy ID and CSBS vault ID.

+

For example, a CSBS policy ID obtained on the console is fdcaa27d-5be4-4f61-afe3-09ff79162c04.

+

A CSBS vault ID is 332a9408-463f-436a-9e92-78dad95d1ac4.

+

The CB_CSBS_BACKUP value is "{\"policy_id\":\"fdcaa27d-5be4-4f61-afe3-09ff79162c04\",\"vault_id\":\"332a9408-463f-436a-9e92-78dad95d1ac4\"}".

+
@@ -427,7 +439,7 @@

Array of strings

Creates ECSs on a dedicated or shared host.

-

The value of this parameter can be dedicated or shared.

+

The value of this parameter can be dedicated or shared.

dedicated_host_id

@@ -435,7 +447,7 @@

Array of strings

Specifies the dedicated host ID.

-
NOTE:

A DeH ID takes effect only when tenancy is set to dedicated.

+
NOTE:

A DeH ID takes effect only when tenancy is set to dedicated.
Table 13 extra_dhcp_opts field description

Parameter

+
Table 13 extra_dhcp_opts field description

Parameter

Mandatory