From c8d7a6f7c1a43f76ab78f26e899159a09e4c02aa Mon Sep 17 00:00:00 2001 From: "Zheng, Xiu" Date: Tue, 28 Feb 2023 10:52:22 +0000 Subject: [PATCH] CSS API 20230223 Version Reviewed-by: Pruthi, Vineet Co-authored-by: Zheng, Xiu Co-committed-by: Zheng, Xiu --- docs/css/api-ref/ALL_META.TXT.json | 28 ++-------- docs/css/api-ref/CLASS.TXT.json | 26 ++-------- docs/css/api-ref/css_03_0018.html | 26 +++------- docs/css/api-ref/css_03_0019.html | 20 ++++++-- docs/css/api-ref/css_03_0023.html | 2 +- docs/css/api-ref/css_03_0024.html | 24 +++++++-- docs/css/api-ref/css_03_0026.html | 15 ++---- docs/css/api-ref/css_03_0031.html | 4 +- docs/css/api-ref/css_03_0032.html | 2 +- docs/css/api-ref/css_03_0034.html | 18 +++---- docs/css/api-ref/css_03_0040.html | 4 -- docs/css/api-ref/css_03_0056.html | 2 +- docs/css/api-ref/css_03_0071.html | 9 +--- docs/css/api-ref/css_03_0078.html | 28 +++++----- docs/css/api-ref/css_03_0079.html | 28 +++++----- docs/css/api-ref/css_03_0081.html | 28 +++++----- docs/css/api-ref/css_03_0082.html | 31 ++++++----- docs/css/api-ref/css_03_0083.html | 29 +++++------ .../api-ref/en-us_image_0000001289590960.png | Bin 0 -> 51740 bytes .../api-ref/en-us_image_0000001342150645.png | Bin 0 -> 9530 bytes docs/css/api-ref/iam_02_0008.html | 48 ++++++++++++++---- docs/css/api-ref/iam_02_0511.html | 9 +--- .../public_sys-resources/icon-arrowdn.gif | Bin 68 -> 1887 bytes .../public_sys-resources/icon-arrowrt.gif | Bin 70 -> 1890 bytes 24 files changed, 181 insertions(+), 200 deletions(-) create mode 100644 docs/css/api-ref/en-us_image_0000001289590960.png create mode 100644 docs/css/api-ref/en-us_image_0000001342150645.png diff --git a/docs/css/api-ref/ALL_META.TXT.json b/docs/css/api-ref/ALL_META.TXT.json index 6c4865a6..15898acc 100644 --- a/docs/css/api-ref/ALL_META.TXT.json +++ b/docs/css/api-ref/ALL_META.TXT.json @@ -33,7 +33,7 @@ "uri":"css_03_0056.html", "product_code":"css", "code":"4", - "des":"In CSS, Elasticsearch 7.6.2 and 7.9.3 and Kibana 7.6.2 and 7.9.3 are supported.", + "des":"In CSS, Elasticsearch 7.6.2, 7.9.3 and 7.10.2 and Kibana 7.6.2, 7.9.3 and 7.10.2 are supported.", "doc_type":"api", "kw":"Supported Cluster Versions,Before You Start,API Reference", "title":"Supported Cluster Versions", @@ -369,30 +369,10 @@ "title":"Obtaining a Project ID and Name", "githuburl":"" }, - { - "uri":"css_03_0073.html", - "product_code":"css", - "code":"38", - "des":"Table 1 describes the common request parameters.", - "doc_type":"api", - "kw":"Common Request Parameters,Common Parameters,API Reference", - "title":"Common Request Parameters", - "githuburl":"" - }, - { - "uri":"css_03_0074.html", - "product_code":"css", - "code":"39", - "des":"Table 1 describes common response headers.", - "doc_type":"api", - "kw":"Common Response Parameters,Common Parameters,API Reference", - "title":"Common Response Parameters", - "githuburl":"" - }, { "uri":"css_03_0075.html", "product_code":"css", - "code":"40", + "code":"38", "des":"Table 1 describes the status code.", "doc_type":"api", "kw":"Status Code,Common Parameters,API Reference", @@ -402,7 +382,7 @@ { "uri":"css_03_0076.html", "product_code":"css", - "code":"41", + "code":"39", "des":"No data is returned if an API fails to be invoked. You can locate the cause of an error according to the error code of each API. When the API calling fails, HTTPS status ", "doc_type":"api", "kw":"Error Code,Common Parameters,API Reference", @@ -412,7 +392,7 @@ { "uri":"css_03_0024.html", "product_code":"css", - "code":"42", + "code":"40", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/css/api-ref/CLASS.TXT.json b/docs/css/api-ref/CLASS.TXT.json index 5478c5d5..d49c535a 100644 --- a/docs/css/api-ref/CLASS.TXT.json +++ b/docs/css/api-ref/CLASS.TXT.json @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"In CSS, Elasticsearch 7.6.2 and 7.9.3 and Kibana 7.6.2 and 7.9.3 are supported.", + "desc":"In CSS, Elasticsearch 7.6.2, 7.9.3 and 7.10.2 and Kibana 7.6.2, 7.9.3 and 7.10.2 are supported.", "product_code":"css", "title":"Supported Cluster Versions", "uri":"css_03_0056.html", @@ -332,24 +332,6 @@ "p_code":"36", "code":"37" }, - { - "desc":"Table 1 describes the common request parameters.", - "product_code":"css", - "title":"Common Request Parameters", - "uri":"css_03_0073.html", - "doc_type":"api", - "p_code":"36", - "code":"38" - }, - { - "desc":"Table 1 describes common response headers.", - "product_code":"css", - "title":"Common Response Parameters", - "uri":"css_03_0074.html", - "doc_type":"api", - "p_code":"36", - "code":"39" - }, { "desc":"Table 1 describes the status code.", "product_code":"css", @@ -357,7 +339,7 @@ "uri":"css_03_0075.html", "doc_type":"api", "p_code":"36", - "code":"40" + "code":"38" }, { "desc":"No data is returned if an API fails to be invoked. You can locate the cause of an error according to the error code of each API. When the API calling fails, HTTPS status ", @@ -366,7 +348,7 @@ "uri":"css_03_0076.html", "doc_type":"api", "p_code":"36", - "code":"41" + "code":"39" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -375,6 +357,6 @@ "uri":"css_03_0024.html", "doc_type":"api", "p_code":"", - "code":"42" + "code":"40" } ] \ No newline at end of file diff --git a/docs/css/api-ref/css_03_0018.html b/docs/css/api-ref/css_03_0018.html index 1c708ca7..995cf480 100644 --- a/docs/css/api-ref/css_03_0018.html +++ b/docs/css/api-ref/css_03_0018.html @@ -217,13 +217,6 @@

Tags of a cluster.

-

period

- -

Boolean

- -

Whether the cluster is billed.

- - @@ -247,7 +240,7 @@

String

-

Engine version number.

+

Engine version number.

@@ -389,7 +382,7 @@ "id": "c8c90973-924d-4201-b9ff-f32279c87d0e", "name": "css-5492-ess-esn-1-1", "specCode": "css.xlarge.2", - "azCode": "cn-cmcc1a-01" + "azCode": "eu-de-01" } ], "updated": "2020-12-01T07:47:34", @@ -407,13 +400,12 @@ "cmkId": "00f05033-f8ac-4ceb-a1ce-4072fadb6b28", "actionProgress": {}, "actions": [], - "tags": [], - "period": false + "tags": [] }, { "datastore": { "type": "elasticsearch", - "version": "6.2.3" + "version": "7.6.2" }, "instances": [ { @@ -422,7 +414,7 @@ "id": "a24adddb-1553-4873-9978-9d064418f903", "name": "css-1d01-ess-esn-1-1", "specCode": "css.xlarge.2", - "azCode": "cn-cmcc1a-01" + "azCode": "eu-de-01" } ], "updated": "2020-11-26T10:08:44", @@ -440,8 +432,7 @@ "cmkId": "", "actionProgress": {}, "actions": [], - "tags": [], - "period": false + "tags": [] }, { "datastore": { @@ -455,7 +446,7 @@ "id": "071c7ecf-a11d-45bd-9564-201ceb7cfae3", "name": "css-9b36-ess-esn-1-1", "specCode": "css.xlarge.2", - "azCode": "cn-cmcc1b-01" + "azCode": "eu-de-01" } ], "updated": "2020-11-13T14:33:24", @@ -473,8 +464,7 @@ "cmkId": "", "actionProgress": {}, "actions": [], - "tags": [], - "period": false + "tags": [] } ] } diff --git a/docs/css/api-ref/css_03_0019.html b/docs/css/api-ref/css_03_0019.html index 66dfaf92..06ffdddb 100644 --- a/docs/css/api-ref/css_03_0019.html +++ b/docs/css/api-ref/css_03_0019.html @@ -125,8 +125,8 @@

String

-

Whether communication is encrypted on the cluster. Available values include true and false. By default, communication is encrypted.

-
  • Value true indicates that communication is encrypted on the cluster.
  • Value false indicates that communication is not encrypted on the cluster.
+

Whether communication encryption is performed on the cluster. Available values include true and false. By default, communication encryption is disabled. When httpsEnable is set to true, authorityEnable must be set to true.

+
  • Value true indicates that communication encryption is performed on the cluster.
  • Value false indicates that communication encryption is not performed on the cluster.

authorityEnable

@@ -207,6 +207,17 @@

Subnet information. For details about related parameters, see Table 6.

+

availability_zone

+ +

No

+ +

String

+ +

Availability zone (AZ). A single AZ is created when this parameter is not specified.

+

Separate multiple AZs with commas (,), for example, az1,az2. AZs must be unique and ensure that the number of nodes be at least the number of AZs.

+

If the number of nodes is a multiple of the number of AZs, the nodes are evenly distributed to each AZ. If the number of nodes is not a multiple of the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.

+ + @@ -335,7 +346,7 @@

String

-

Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone, for example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

+

Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone, for example, 00:00 GMT+08:00 and 01:00 GMT+02:00.

prefix

@@ -509,7 +520,8 @@ "name": "ES-Test", "instanceNum": 4, "instance": { - "flavorRef": "css.large.8", + "availability_zone": "eu-de-01", + "flavorRef": "css.large.8", "volume": { "volume_type": "COMMON", "size": 100 diff --git a/docs/css/api-ref/css_03_0023.html b/docs/css/api-ref/css_03_0023.html index e0831aac..e400ea9d 100644 --- a/docs/css/api-ref/css_03_0023.html +++ b/docs/css/api-ref/css_03_0023.html @@ -144,7 +144,7 @@
{
   "versions": [
     {
-      "version": "6.2.3",
+      "version": "7.6.2",
       "flavors": [
         {
           "cpu": 1,
diff --git a/docs/css/api-ref/css_03_0024.html b/docs/css/api-ref/css_03_0024.html
index e28cf347..6480f186 100644
--- a/docs/css/api-ref/css_03_0024.html
+++ b/docs/css/api-ref/css_03_0024.html
@@ -8,7 +8,23 @@
 
 
 
-

2022-06-30

+

2023-02-23

+ +

Optimized the parameter description in: Creating a Cluster

+ + +

2022-09-14

+ +

Updated:

+ + + +

2022-07-28

+ +
  • Added Common Request Parameters and Common Response Parameters in Calling APIs.
  • Added cluster version 7.10.2.
+ + +

2022-06-30

  • Optimized API calling methods:
  • Optimized common contents: @@ -119,7 +135,7 @@

    2018-09-29

    -
    • Modified the parameter description in the following sections: +
      • Modified the parameter description in the following sections:
      • Deleted information related to the extendparam parameter and modified the example response.

        Manually Creating a Snapshot

      @@ -146,8 +162,8 @@
    • Modified the example response. Added the status code returned by the API for deleting a cluster.

      Deleting a Cluster

    • Modified the URI format. Added the status code returned by the API for obtaining the list of instance flavors.

      Obtaining the List of Instance Flavors

    • Modified the function description. Modify the example request. Added the status code returned by the API for automatically performing basic configurations for a cluster snapshot.

      (Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot

      -
    • Modified the description about the indices parameter in the request parameter table. Changed parameter names bakExpectedStartTime, bakKeepDay, and bakPeriod in the table of backup field data structure description to backupExpectedStartTime, backupKeepDay, and backupPeriod, respectively. Modified the example response. Added the status code returned by the API for manually creating a cluster snapshot.

      Manually Creating a Snapshot

      -
    • Changed parameter names bakExpectedStartTime, bakKeepDay, and bakPeriod in the table of backups field data structure description to backupExpectedStartTime, backupKeepDay, and backupPeriod, respectively. Modified the example response. Added the status code returned by the API for querying the list of snapshots.

      Querying the List of Snapshots

      +
    • Modified the description about the indices parameter in the request parameter table. Changed parameter names bakExpectedStartTime, bakKeepDay, and bakPeriod in the table of backup field data structure description to backupExpectedStartTime, backupKeepDay, and backupPeriod, respectively. Modified the example response. Added the status code returned by the API for manually creating a cluster snapshot.

      Manually Creating a Snapshot

      +
    • Changed parameter names bakExpectedStartTime, bakKeepDay, and bakPeriod in the table of backups field data structure description to backupExpectedStartTime, backupKeepDay, and backupPeriod, respectively. Modified the example response. Added the status code returned by the API for querying the list of snapshots.

      Querying the List of Snapshots

    • Modified the description in the request parameter table. Added the status code returned by the API for restoring snapshots.

      Restoring a Snapshot

    • Added the handling method for each error code.
    diff --git a/docs/css/api-ref/css_03_0026.html b/docs/css/api-ref/css_03_0026.html index 6da7060f..4930aca3 100644 --- a/docs/css/api-ref/css_03_0026.html +++ b/docs/css/api-ref/css_03_0026.html @@ -186,13 +186,6 @@

    Tags in a cluster.

    -

    period

    - -

    Boolean

    - -

    Whether the cluster is billed.

    - - @@ -216,7 +209,7 @@

    String

    -

    Engine version number.

    +

    Engine version number.

    @@ -346,7 +339,7 @@ "id": "c2f29369-1985-4028-8e72-89cbb96a299d", "name": "css-5977-ess-esn-1-1", "specCode": "css.xlarge.2", - "azCode": "cn-cmcc1a-01" + "azCode": "eu-de-01" } ], "updated": "2020-12-03T07:02:08", @@ -363,9 +356,7 @@ "diskEncrypted": false, "actionProgress": {}, "actions": [], - "tags": [], - "period": false - + "tags": [] }

Status Code

Table 7 describes the status code.

diff --git a/docs/css/api-ref/css_03_0031.html b/docs/css/api-ref/css_03_0031.html index f3cdd640..2be7bdec 100644 --- a/docs/css/api-ref/css_03_0031.html +++ b/docs/css/api-ref/css_03_0031.html @@ -64,7 +64,7 @@

String

-

Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone, for example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

+

Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone, for example, 00:00 GMT+08:00 and 01:00 GMT+02:00.

keepday

@@ -104,7 +104,7 @@
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/policy
 {
     "prefix":"snapshot",
-    "period":"16:00 GMT+08:00",
+    "period":"16:00 GMT+02:00",
     "keepday":7,
     "enable":"true"
 }
diff --git a/docs/css/api-ref/css_03_0032.html b/docs/css/api-ref/css_03_0032.html index 82b9c960..ea75e487 100644 --- a/docs/css/api-ref/css_03_0032.html +++ b/docs/css/api-ref/css_03_0032.html @@ -116,7 +116,7 @@
{
     "keepday":2,
-    "period":"16:00 GMT+08:00",
+    "period":"16:00 GMT+02:00",
     "prefix":"snapshot",
     "bucket":"es-backup",
     "basePath": "css_repository/tests", 
diff --git a/docs/css/api-ref/css_03_0034.html b/docs/css/api-ref/css_03_0034.html
index 284cf531..c548bbf8 100644
--- a/docs/css/api-ref/css_03_0034.html
+++ b/docs/css/api-ref/css_03_0034.html
@@ -244,7 +244,7 @@
 
 

String

-

Engine version number.

+

Engine version number.

@@ -257,10 +257,10 @@
{
    "backups": [
     {
-      "created": "2018-03-07T07:34:47",
+      "created": "2021-03-07T07:34:47",
       "datastore": {
         "type": "elasticsearch",
-        "version": "*.*.*"
+        "version": "7.6.2"
       },
       "description": "",
       "id": "e29d99c1-3d19-4ea4-ae8d-f252df76cbe9",
@@ -268,7 +268,7 @@
       "clusterName": "Es-xfx",
       "name": "snapshot-002",
       "status": "COMPLETED",
-      "updated": "2018-03-07T07:40:12",
+      "updated": "2021-03-07T07:40:12",
       "backupType": "1",
       "backupMethod": "manual",
       "backupExpectedStartTime": null,
@@ -277,17 +277,17 @@
       "indices": ".kibana,website2",
       "totalShards": 6,
       "failedShards": 0,
-      "version": "6.2.3",
+      "version": "7.6.2",
       "restoreStatus": "success",
       "startTime": 1520408087099,
       "endTime": 1520408412219,
       "bucketName": "obs-b8ed"
     },
     {
-      "created": "2018-03-06T15:42:37",
+      "created": "2021-03-06T15:42:37",
       "datastore": {
         "type": "elasticsearch",
-        "version": "6.2.3"
+        "version": "7.6.2"
       },
       "description": "",
       "id": "29a2254e-947f-4463-b65a-5f0b17515fae",
@@ -295,7 +295,7 @@
       "clusterName": "Es-xfx",
       "name": "snapshot-001",
       "status": "COMPLETED",
-      "updated": "2018-03-06T15:48:04",
+      "updated": "2021-03-06T15:48:04",
       "backupType": "1",
       "backupMethod": "manual",
       "backupExpectedStartTime": null,
@@ -304,7 +304,7 @@
       "indices": ".kibana",
       "totalShards": 1,
       "failedShards": 0,
-      "version": "6.2.3",
+      "version": "7.6.2",
       "restoreStatus": "none",
       "startTime": 1520350957275,
       "endTime": 1520351284357,
diff --git a/docs/css/api-ref/css_03_0040.html b/docs/css/api-ref/css_03_0040.html
index 250ba57c..142f59e7 100644
--- a/docs/css/api-ref/css_03_0040.html
+++ b/docs/css/api-ref/css_03_0040.html
@@ -10,10 +10,6 @@