diff --git a/docs/css/api-ref/ALL_META.TXT.json b/docs/css/api-ref/ALL_META.TXT.json
new file mode 100644
index 000000000..6c4865a6f
--- /dev/null
+++ b/docs/css/api-ref/ALL_META.TXT.json
@@ -0,0 +1,422 @@
+[
+ {
+ "uri":"css_03_0001.html",
+ "product_code":"css",
+ "code":"1",
+ "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":"Before You Start",
+ "title":"Before You Start",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0051.html",
+ "product_code":"css",
+ "code":"2",
+ "des":"Welcome to Cloud Search Service API Reference. Cloud Search Service (CSS) provides hosted, distributed search engine services. It is fully compatible with open-source Ela",
+ "doc_type":"api",
+ "kw":"Overview,Before You Start,API Reference",
+ "title":"Overview",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0053.html",
+ "product_code":"css",
+ "code":"3",
+ "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.",
+ "doc_type":"api",
+ "kw":"Endpoints,Before You Start,API Reference",
+ "title":"Endpoints",
+ "githuburl":""
+ },
+ {
+ "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.",
+ "doc_type":"api",
+ "kw":"Supported Cluster Versions,Before You Start,API Reference",
+ "title":"Supported Cluster Versions",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0057.html",
+ "product_code":"css",
+ "code":"5",
+ "des":"The CSS API is a self-developed API that complies with RESTful API design specifications. You can call CSS APIs to implement the CSS functions described in Table 1.",
+ "doc_type":"api",
+ "kw":"API Overview,API Reference",
+ "title":"API Overview",
+ "githuburl":""
+ },
+ {
+ "uri":"iam_01_0023.html",
+ "product_code":"css",
+ "code":"6",
+ "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":"Calling APIs",
+ "title":"Calling APIs",
+ "githuburl":""
+ },
+ {
+ "uri":"iam_02_0008.html",
+ "product_code":"css",
+ "code":"7",
+ "des":"This section describes the structure of a RESTful API request, and uses the API for Obtaining a User Token as an example to describe how to call an API. A token is a user",
+ "doc_type":"api",
+ "kw":"Making an API Request,Calling APIs,API Reference",
+ "title":"Making an API Request",
+ "githuburl":""
+ },
+ {
+ "uri":"iam_02_0510.html",
+ "product_code":"css",
+ "code":"8",
+ "des":"CSS supports token authentication.The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.A ",
+ "doc_type":"api",
+ "kw":"Authentication,Calling APIs,API Reference",
+ "title":"Authentication",
+ "githuburl":""
+ },
+ {
+ "uri":"iam_02_0511.html",
+ "product_code":"css",
+ "code":"9",
+ "des":"After sending a request, you will receive a response containing the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t",
+ "doc_type":"api",
+ "kw":"Returned Values,Calling APIs,API Reference",
+ "title":"Returned Values",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0008.html",
+ "product_code":"css",
+ "code":"10",
+ "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":"Cluster Management APIs",
+ "title":"Cluster Management APIs",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0019.html",
+ "product_code":"css",
+ "code":"11",
+ "des":"This API is used to create a cluster.Table 2 describes the request parameters.Table 11 describes the response parameters.Example requestExample response{\n \"cluster\": {\n ",
+ "doc_type":"api",
+ "kw":"Creating a Cluster,Cluster Management APIs,API Reference",
+ "title":"Creating a Cluster",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0018.html",
+ "product_code":"css",
+ "code":"12",
+ "des":"This API is used to query and display the cluster list and cluster status.NoneTable 2 describes the response parameters.Example requestExample request of querying cluster",
+ "doc_type":"api",
+ "kw":"Querying the List of Clusters,Cluster Management APIs,API Reference",
+ "title":"Querying the List of Clusters",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0026.html",
+ "product_code":"css",
+ "code":"13",
+ "des":"This API is used to query and display details about a cluster.NoneTable 2 describes the response parameters.Example requestExample responseTable 7 describes the status co",
+ "doc_type":"api",
+ "kw":"Querying Cluster Details,Cluster Management APIs,API Reference",
+ "title":"Querying Cluster Details",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0020.html",
+ "product_code":"css",
+ "code":"14",
+ "des":"This API is used to delete a cluster. All resources, including customer data, of the deleted cluster will be released. For data security reasons, create a snapshot for th",
+ "doc_type":"api",
+ "kw":"Deleting a Cluster,Cluster Management APIs,API Reference",
+ "title":"Deleting a Cluster",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0021.html",
+ "product_code":"css",
+ "code":"15",
+ "des":"This API is used to restart a cluster. Restarting the cluster will interrupt ongoing services.NoneExample requestExample responseTable 3 describes the status code.",
+ "doc_type":"api",
+ "kw":"Restarting a Cluster,Cluster Management APIs,API Reference",
+ "title":"Restarting a Cluster",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0025.html",
+ "product_code":"css",
+ "code":"16",
+ "des":"This API is used to scale out a cluster with only common nodes. Clusters with master, client, or cold data nodes cannot use this API.Table 2 describes the request paramet",
+ "doc_type":"api",
+ "kw":"Scaling Out a Cluster with only Common Nodes,Cluster Management APIs,API Reference",
+ "title":"Scaling Out a Cluster with only Common Nodes",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0038.html",
+ "product_code":"css",
+ "code":"17",
+ "des":"This API is used to scale out a cluster with special nodes. That is, if a cluster has master, client, or cold data nodes, this API is used for scale-out.Table 2 describes",
+ "doc_type":"api",
+ "kw":"Scaling Out a Cluster with Special Nodes,Cluster Management APIs,API Reference",
+ "title":"Scaling Out a Cluster with Special Nodes",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0023.html",
+ "product_code":"css",
+ "code":"18",
+ "des":"This API is used to query and display the IDs of supported instance flavors.NoneTable 2 describes the response parameters.Example requestGET /v1.0/6204a5bd270343b5885144c",
+ "doc_type":"api",
+ "kw":"Obtaining the List of Instance Flavors,Cluster Management APIs,API Reference",
+ "title":"Obtaining the List of Instance Flavors",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0050.html",
+ "product_code":"css",
+ "code":"19",
+ "des":"This API is used to download the HTTPS certificate file of the server.NoneExample requestExample responseAfter obtaining the preceding character string, run the following",
+ "doc_type":"api",
+ "kw":"Downloading a Certificate File,Cluster Management APIs,API Reference",
+ "title":"Downloading a Certificate File",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0077.html",
+ "product_code":"css",
+ "code":"20",
+ "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":"Tag Management APIs",
+ "title":"Tag Management APIs",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0078.html",
+ "product_code":"css",
+ "code":"21",
+ "des":"This API is used to query the tag information about a specified cluster.NoneTable 2 describes the response parameters.Example requestExample responseTable 4 describes the",
+ "doc_type":"api",
+ "kw":"Querying Tags of a Specified Cluster,Tag Management APIs,API Reference",
+ "title":"Querying Tags of a Specified Cluster",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0079.html",
+ "product_code":"css",
+ "code":"22",
+ "des":"This API is used to query all tags in a specified region.NoneTable 2 describes the response parameters.Example requestExample responseTable 4 describes the status code.",
+ "doc_type":"api",
+ "kw":"Querying All Tags,Tag Management APIs,API Reference",
+ "title":"Querying All Tags",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0083.html",
+ "product_code":"css",
+ "code":"23",
+ "des":"This API is used to add tags to a cluster. A cluster can have a maximum of 10 tags.NoneExample requestPOST /v1.0/458d905f22da49c39f609e3347d65723/css-cluster/4f3deec3-efa",
+ "doc_type":"api",
+ "kw":"Adding Tags to a Cluster,Tag Management APIs,API Reference",
+ "title":"Adding Tags to a Cluster",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0081.html",
+ "product_code":"css",
+ "code":"24",
+ "des":"This API is used to add or delete tags to or from a specified cluster in batches. Tag Management Service (TMS) uses this API to batch manage tags of a cluster. A cluster ",
+ "doc_type":"api",
+ "kw":"Adding or Deleting Cluster Tags in Batches,Tag Management APIs,API Reference",
+ "title":"Adding or Deleting Cluster Tags in Batches",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0082.html",
+ "product_code":"css",
+ "code":"25",
+ "des":"This API is used to delete specified cluster tags.NoneNoneExample requestDELETE /v1.0/458d905f22da49c39f609e3347d65723/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/ta",
+ "doc_type":"api",
+ "kw":"Deleting Specified Cluster Tags,Tag Management APIs,API Reference",
+ "title":"Deleting Specified Cluster Tags",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0010.html",
+ "product_code":"css",
+ "code":"26",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"api",
+ "kw":"Snapshot Management APIs",
+ "title":"Snapshot Management APIs",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0037.html",
+ "product_code":"css",
+ "code":"27",
+ "des":"The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapthos. If you have multiple clusters, an OBS buc",
+ "doc_type":"api",
+ "kw":"(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot,Snapshot Management",
+ "title":"(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0030.html",
+ "product_code":"css",
+ "code":"28",
+ "des":"Using this API will automatically enable the snapshot function.This API is used to modify the basic configurations of a cluster snapshot. The basic configurations include",
+ "doc_type":"api",
+ "kw":"Modifying Basic Configurations of a Cluster Snapshot,Snapshot Management APIs,API Reference",
+ "title":"Modifying Basic Configurations of a Cluster Snapshot",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0031.html",
+ "product_code":"css",
+ "code":"29",
+ "des":"This API is used to set parameters related to automatic snapshot creation. By default, a snapshot is created per day.Table 2 describes the request parameters.NoneExample ",
+ "doc_type":"api",
+ "kw":"Setting the Automatic Snapshot Creation Policy,Snapshot Management APIs,API Reference",
+ "title":"Setting the Automatic Snapshot Creation Policy",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0032.html",
+ "product_code":"css",
+ "code":"30",
+ "des":"This API is used to query the automatic snapshot creation policy for a cluster.NoneTable 2 describes the response parameters.Example requestExample responseTable 3 descri",
+ "doc_type":"api",
+ "kw":"Querying the Automatic Snapshot Creation Policy for a Cluster,Snapshot Management APIs,API Reference",
+ "title":"Querying the Automatic Snapshot Creation Policy for a Cluster",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0033.html",
+ "product_code":"css",
+ "code":"31",
+ "des":"This API is used to manually create a snapshot.Table 2 describes the request parameters.Table 3 describes the response parameters.Example requestExample responseTable 5 d",
+ "doc_type":"api",
+ "kw":"Manually Creating a Snapshot,Snapshot Management APIs,API Reference",
+ "title":"Manually Creating a Snapshot",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0034.html",
+ "product_code":"css",
+ "code":"32",
+ "des":"This API is used to query all snapshots of a cluster.NoneExample requestExample responseTable 5 describes the status code.",
+ "doc_type":"api",
+ "kw":"Querying the List of Snapshots,Snapshot Management APIs,API Reference",
+ "title":"Querying the List of Snapshots",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0035.html",
+ "product_code":"css",
+ "code":"33",
+ "des":"This API is used to manually restore a snapshot.Table 2 describes the request parameters.NoneExample requestExample responseThe return value is empty.Table 3 describes th",
+ "doc_type":"api",
+ "kw":"Restoring a Snapshot,Snapshot Management APIs,API Reference",
+ "title":"Restoring a Snapshot",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0036.html",
+ "product_code":"css",
+ "code":"34",
+ "des":"This API is used to delete a snapshot.NoneNoneExample requestTable 2 describes the status code.",
+ "doc_type":"api",
+ "kw":"Deleting a Snapshot,Snapshot Management APIs,API Reference",
+ "title":"Deleting a Snapshot",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0039.html",
+ "product_code":"css",
+ "code":"35",
+ "des":"This API is used to disable the snapshot function.NoneNoneExample requestTable 2 describes the status code.",
+ "doc_type":"api",
+ "kw":"Disabling the Snapshot Function,Snapshot Management APIs,API Reference",
+ "title":"Disabling the Snapshot Function",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0040.html",
+ "product_code":"css",
+ "code":"36",
+ "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":"Common Parameters",
+ "title":"Common Parameters",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0071.html",
+ "product_code":"css",
+ "code":"37",
+ "des":"A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.Log in to the console.In the upper right c",
+ "doc_type":"api",
+ "kw":"Obtaining a Project ID and Name,Common Parameters,API Reference",
+ "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",
+ "des":"Table 1 describes the status code.",
+ "doc_type":"api",
+ "kw":"Status Code,Common Parameters,API Reference",
+ "title":"Status Code",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0076.html",
+ "product_code":"css",
+ "code":"41",
+ "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",
+ "title":"Error Code",
+ "githuburl":""
+ },
+ {
+ "uri":"css_03_0024.html",
+ "product_code":"css",
+ "code":"42",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"api",
+ "kw":"Change History,API Reference",
+ "title":"Change History",
+ "githuburl":""
+ }
+]
\ No newline at end of file
diff --git a/docs/css/api-ref/CLASS.TXT.json b/docs/css/api-ref/CLASS.TXT.json
new file mode 100644
index 000000000..5478c5d57
--- /dev/null
+++ b/docs/css/api-ref/CLASS.TXT.json
@@ -0,0 +1,380 @@
+[
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"css",
+ "title":"Before You Start",
+ "uri":"css_03_0001.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"1"
+ },
+ {
+ "desc":"Welcome to Cloud Search Service API Reference. Cloud Search Service (CSS) provides hosted, distributed search engine services. It is fully compatible with open-source Ela",
+ "product_code":"css",
+ "title":"Overview",
+ "uri":"css_03_0051.html",
+ "doc_type":"api",
+ "p_code":"1",
+ "code":"2"
+ },
+ {
+ "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.",
+ "product_code":"css",
+ "title":"Endpoints",
+ "uri":"css_03_0053.html",
+ "doc_type":"api",
+ "p_code":"1",
+ "code":"3"
+ },
+ {
+ "desc":"In CSS, Elasticsearch 7.6.2 and 7.9.3 and Kibana 7.6.2 and 7.9.3 are supported.",
+ "product_code":"css",
+ "title":"Supported Cluster Versions",
+ "uri":"css_03_0056.html",
+ "doc_type":"api",
+ "p_code":"1",
+ "code":"4"
+ },
+ {
+ "desc":"The CSS API is a self-developed API that complies with RESTful API design specifications. You can call CSS APIs to implement the CSS functions described in Table 1.",
+ "product_code":"css",
+ "title":"API Overview",
+ "uri":"css_03_0057.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"5"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"css",
+ "title":"Calling APIs",
+ "uri":"iam_01_0023.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"6"
+ },
+ {
+ "desc":"This section describes the structure of a RESTful API request, and uses the API for Obtaining a User Token as an example to describe how to call an API. A token is a user",
+ "product_code":"css",
+ "title":"Making an API Request",
+ "uri":"iam_02_0008.html",
+ "doc_type":"api",
+ "p_code":"6",
+ "code":"7"
+ },
+ {
+ "desc":"CSS supports token authentication.The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.A ",
+ "product_code":"css",
+ "title":"Authentication",
+ "uri":"iam_02_0510.html",
+ "doc_type":"api",
+ "p_code":"6",
+ "code":"8"
+ },
+ {
+ "desc":"After sending a request, you will receive a response containing the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t",
+ "product_code":"css",
+ "title":"Returned Values",
+ "uri":"iam_02_0511.html",
+ "doc_type":"api",
+ "p_code":"6",
+ "code":"9"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"css",
+ "title":"Cluster Management APIs",
+ "uri":"css_03_0008.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"10"
+ },
+ {
+ "desc":"This API is used to create a cluster.Table 2 describes the request parameters.Table 11 describes the response parameters.Example requestExample response{\n \"cluster\": {\n ",
+ "product_code":"css",
+ "title":"Creating a Cluster",
+ "uri":"css_03_0019.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"11"
+ },
+ {
+ "desc":"This API is used to query and display the cluster list and cluster status.NoneTable 2 describes the response parameters.Example requestExample request of querying cluster",
+ "product_code":"css",
+ "title":"Querying the List of Clusters",
+ "uri":"css_03_0018.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"12"
+ },
+ {
+ "desc":"This API is used to query and display details about a cluster.NoneTable 2 describes the response parameters.Example requestExample responseTable 7 describes the status co",
+ "product_code":"css",
+ "title":"Querying Cluster Details",
+ "uri":"css_03_0026.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"13"
+ },
+ {
+ "desc":"This API is used to delete a cluster. All resources, including customer data, of the deleted cluster will be released. For data security reasons, create a snapshot for th",
+ "product_code":"css",
+ "title":"Deleting a Cluster",
+ "uri":"css_03_0020.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"14"
+ },
+ {
+ "desc":"This API is used to restart a cluster. Restarting the cluster will interrupt ongoing services.NoneExample requestExample responseTable 3 describes the status code.",
+ "product_code":"css",
+ "title":"Restarting a Cluster",
+ "uri":"css_03_0021.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"15"
+ },
+ {
+ "desc":"This API is used to scale out a cluster with only common nodes. Clusters with master, client, or cold data nodes cannot use this API.Table 2 describes the request paramet",
+ "product_code":"css",
+ "title":"Scaling Out a Cluster with only Common Nodes",
+ "uri":"css_03_0025.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"16"
+ },
+ {
+ "desc":"This API is used to scale out a cluster with special nodes. That is, if a cluster has master, client, or cold data nodes, this API is used for scale-out.Table 2 describes",
+ "product_code":"css",
+ "title":"Scaling Out a Cluster with Special Nodes",
+ "uri":"css_03_0038.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"17"
+ },
+ {
+ "desc":"This API is used to query and display the IDs of supported instance flavors.NoneTable 2 describes the response parameters.Example requestGET /v1.0/6204a5bd270343b5885144c",
+ "product_code":"css",
+ "title":"Obtaining the List of Instance Flavors",
+ "uri":"css_03_0023.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"18"
+ },
+ {
+ "desc":"This API is used to download the HTTPS certificate file of the server.NoneExample requestExample responseAfter obtaining the preceding character string, run the following",
+ "product_code":"css",
+ "title":"Downloading a Certificate File",
+ "uri":"css_03_0050.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"19"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"css",
+ "title":"Tag Management APIs",
+ "uri":"css_03_0077.html",
+ "doc_type":"api",
+ "p_code":"10",
+ "code":"20"
+ },
+ {
+ "desc":"This API is used to query the tag information about a specified cluster.NoneTable 2 describes the response parameters.Example requestExample responseTable 4 describes the",
+ "product_code":"css",
+ "title":"Querying Tags of a Specified Cluster",
+ "uri":"css_03_0078.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"21"
+ },
+ {
+ "desc":"This API is used to query all tags in a specified region.NoneTable 2 describes the response parameters.Example requestExample responseTable 4 describes the status code.",
+ "product_code":"css",
+ "title":"Querying All Tags",
+ "uri":"css_03_0079.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"22"
+ },
+ {
+ "desc":"This API is used to add tags to a cluster. A cluster can have a maximum of 10 tags.NoneExample requestPOST /v1.0/458d905f22da49c39f609e3347d65723/css-cluster/4f3deec3-efa",
+ "product_code":"css",
+ "title":"Adding Tags to a Cluster",
+ "uri":"css_03_0083.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"23"
+ },
+ {
+ "desc":"This API is used to add or delete tags to or from a specified cluster in batches. Tag Management Service (TMS) uses this API to batch manage tags of a cluster. A cluster ",
+ "product_code":"css",
+ "title":"Adding or Deleting Cluster Tags in Batches",
+ "uri":"css_03_0081.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"24"
+ },
+ {
+ "desc":"This API is used to delete specified cluster tags.NoneNoneExample requestDELETE /v1.0/458d905f22da49c39f609e3347d65723/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/ta",
+ "product_code":"css",
+ "title":"Deleting Specified Cluster Tags",
+ "uri":"css_03_0082.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"25"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"css",
+ "title":"Snapshot Management APIs",
+ "uri":"css_03_0010.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"26"
+ },
+ {
+ "desc":"The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapthos. If you have multiple clusters, an OBS buc",
+ "product_code":"css",
+ "title":"(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot",
+ "uri":"css_03_0037.html",
+ "doc_type":"api",
+ "p_code":"26",
+ "code":"27"
+ },
+ {
+ "desc":"Using this API will automatically enable the snapshot function.This API is used to modify the basic configurations of a cluster snapshot. The basic configurations include",
+ "product_code":"css",
+ "title":"Modifying Basic Configurations of a Cluster Snapshot",
+ "uri":"css_03_0030.html",
+ "doc_type":"api",
+ "p_code":"26",
+ "code":"28"
+ },
+ {
+ "desc":"This API is used to set parameters related to automatic snapshot creation. By default, a snapshot is created per day.Table 2 describes the request parameters.NoneExample ",
+ "product_code":"css",
+ "title":"Setting the Automatic Snapshot Creation Policy",
+ "uri":"css_03_0031.html",
+ "doc_type":"api",
+ "p_code":"26",
+ "code":"29"
+ },
+ {
+ "desc":"This API is used to query the automatic snapshot creation policy for a cluster.NoneTable 2 describes the response parameters.Example requestExample responseTable 3 descri",
+ "product_code":"css",
+ "title":"Querying the Automatic Snapshot Creation Policy for a Cluster",
+ "uri":"css_03_0032.html",
+ "doc_type":"api",
+ "p_code":"26",
+ "code":"30"
+ },
+ {
+ "desc":"This API is used to manually create a snapshot.Table 2 describes the request parameters.Table 3 describes the response parameters.Example requestExample responseTable 5 d",
+ "product_code":"css",
+ "title":"Manually Creating a Snapshot",
+ "uri":"css_03_0033.html",
+ "doc_type":"api",
+ "p_code":"26",
+ "code":"31"
+ },
+ {
+ "desc":"This API is used to query all snapshots of a cluster.NoneExample requestExample responseTable 5 describes the status code.",
+ "product_code":"css",
+ "title":"Querying the List of Snapshots",
+ "uri":"css_03_0034.html",
+ "doc_type":"api",
+ "p_code":"26",
+ "code":"32"
+ },
+ {
+ "desc":"This API is used to manually restore a snapshot.Table 2 describes the request parameters.NoneExample requestExample responseThe return value is empty.Table 3 describes th",
+ "product_code":"css",
+ "title":"Restoring a Snapshot",
+ "uri":"css_03_0035.html",
+ "doc_type":"api",
+ "p_code":"26",
+ "code":"33"
+ },
+ {
+ "desc":"This API is used to delete a snapshot.NoneNoneExample requestTable 2 describes the status code.",
+ "product_code":"css",
+ "title":"Deleting a Snapshot",
+ "uri":"css_03_0036.html",
+ "doc_type":"api",
+ "p_code":"26",
+ "code":"34"
+ },
+ {
+ "desc":"This API is used to disable the snapshot function.NoneNoneExample requestTable 2 describes the status code.",
+ "product_code":"css",
+ "title":"Disabling the Snapshot Function",
+ "uri":"css_03_0039.html",
+ "doc_type":"api",
+ "p_code":"26",
+ "code":"35"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"css",
+ "title":"Common Parameters",
+ "uri":"css_03_0040.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"36"
+ },
+ {
+ "desc":"A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.Log in to the console.In the upper right c",
+ "product_code":"css",
+ "title":"Obtaining a Project ID and Name",
+ "uri":"css_03_0071.html",
+ "doc_type":"api",
+ "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",
+ "title":"Status Code",
+ "uri":"css_03_0075.html",
+ "doc_type":"api",
+ "p_code":"36",
+ "code":"40"
+ },
+ {
+ "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 ",
+ "product_code":"css",
+ "title":"Error Code",
+ "uri":"css_03_0076.html",
+ "doc_type":"api",
+ "p_code":"36",
+ "code":"41"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"css",
+ "title":"Change History",
+ "uri":"css_03_0024.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"42"
+ }
+]
\ No newline at end of file
diff --git a/docs/css/api-ref/PARAMETERS.txt b/docs/css/api-ref/PARAMETERS.txt
new file mode 100644
index 000000000..6da8d5f07
--- /dev/null
+++ b/docs/css/api-ref/PARAMETERS.txt
@@ -0,0 +1,3 @@
+version=""
+language="en-us"
+type=""
\ No newline at end of file
diff --git a/docs/css/api-ref/css_03_0001.html b/docs/css/api-ref/css_03_0001.html
new file mode 100644
index 000000000..3297a7cd9
--- /dev/null
+++ b/docs/css/api-ref/css_03_0001.html
@@ -0,0 +1,15 @@
+
+
+
Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
+
+
+
name
+
+
String
+
+
Cluster name.
+
+
+
created
+
+
String
+
+
Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
+
NOTE:
The returned cluster list is sorted by creation time in descending order. Specifically, the cluster with the latest creation time is at the top.
+
+
+
+
id
+
+
String
+
+
Cluster ID.
+
+
+
status
+
+
String
+
+
Return value.
+
100: Creating.
200: Available.
303: Unavailable, such as creation failed.
+
+
+
endpoint
+
+
String
+
+
IP address and port number of the user used to access the VPC.
+
+
+
actionProgress
+
+
Object
+
+
Cluster operation progress, which indicates the progress of cluster creation and expansion in percentage. CREATING specifies the progress of creation.
+
+
+
actions
+
+
Array of strings
+
+
Current behavior on a cluster. Value REBOOTING indicates that the cluster is being restarted, GROWING indicates that capacity expansion is being performed on the cluster, RESTORING indicates that the cluster is being restored, and SNAPSHOTTING indicates that the snapshot is being created.
+
+
+
failed_reasons
+
+
Object
+
+
Failure cause. If the cluster is in the available status, this parameter is not returned. For details, see Table 6.
+
+
+
httpsEnable
+
+
Boolean
+
+
Communication encryption status.
+
Value false indicates that communication encryption is not enabled.
+
Value true indicates that communication encryption is enabled.
+
+
+
authorityEnable
+
+
String
+
+
Whether to enable authentication. Available values include true and false. Authentication is disabled by default. When authentication is enabled, httpsEnable must be set to true.
+
Value true indicates that authentication is enabled for the cluster.
Value false indicates that authentication is disabled for the cluster.
+
+
+
diskEncrypted
+
+
Boolean
+
+
Whether disks are encrypted.
+
Value true indicates that disks are encrypted.
Value false indicates that disks are not encrypted.
Cluster. For details about related parameters, see Table 3.
+
+
+
+
+
+
+
Table 3 cluster field description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
instance
+
+
Yes
+
+
Object
+
+
Instance. For details about related parameters, see Table 4.
+
+
+
datastore
+
+
Yes
+
+
Object
+
+
Type of the data search engine. For details about related parameters, see Table 7.
+
+
+
name
+
+
Yes
+
+
String
+
+
Cluster name. It contains 4 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.
+
+
+
instanceNum
+
+
Yes
+
+
Integer
+
+
Number of clusters. The value range is 1 to 32.
+
+
+
backupStrategy
+
+
No
+
+
Object
+
+
Automatic snapshot creation. This function is disabled by default. For details about related parameters, see Table 8.
+
NOTE:
The automatic snapshot creation policy is enabled only if this parameter is specified.
+
+
+
+
diskEncryption
+
+
Yes
+
+
Object
+
+
Whether disks are encrypted. For details about related parameters, see Table 9.
+
+
+
httpsEnable
+
+
No
+
+
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.
+
+
+
authorityEnable
+
+
No
+
+
Boolean
+
+
Whether to enable authentication. Available values include true and false. Authentication is disabled by default. When authentication is enabled, httpsEnable must be set to true.
+
Value true indicates that authentication is enabled for the cluster.
Value false indicates that authentication is disabled for the cluster.
NOTE:
This parameter is supported in clusters 7.1.1 or later.
+
+
+
+
+
adminPwd
+
+
No
+
+
String
+
+
Password of the cluster user admin in security mode. This parameter is mandatory only when authorityEnable is set to true.
+
NOTE:
The administrator password must meet the following requirements:
The password can contain 8 to 32 characters.
Passwords must contain at least 3 of the following character types: uppercase letters, lowercase letters, numbers, and special characters (~!@#$%^&*()-_=+\\|[{}];:,<.>/?).
+
Weak password verification is required for a security cluster. You are advised to set a strong password.
Cluster type. The default value is Elasticsearch. Currently, the value can only be Elasticsearch.
+
+
+
+
+
+
+
Table 8 backupStrategy field description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
period
+
+
Yes
+
+
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.
+
+
+
prefix
+
+
Yes
+
+
String
+
+
Prefix of the name of the snapshot that is automatically created.
+
+
+
keepday
+
+
Yes
+
+
Integer
+
+
Number of days for which automatically created snapshots are reserved.
+
Value range: 1 to 90
+
+
+
bucket
+
+
No
+
+
String
+
+
OBS bucket used for storing backup. If there is snapshot data in an OBS bucket, only the OBS bucket will be used for backup storage and cannot be changed.
+
+
+
basePath
+
+
No
+
+
String
+
+
Storage path of the snapshot in the OBS bucket.
+
+
+
agency
+
+
No
+
+
String
+
+
IAM agency used to access OBS.
+
NOTE:
If none of the bucket, basePath, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency.
+
+
+
+
+
+
+
+
Table 9 diskEncryption field description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
systemEncrypted
+
+
Yes
+
+
String
+
+
Value 1 indicates encryption is performed, and value 0 indicates encryption is not performed.
+
+
+
systemCmkid
+
+
Yes
+
+
String
+
+
Key ID.
+
The Default Master Keys cannot be used to create grants. Specifically, you cannot use Default Master Keys whose aliases end with /default in KMS to create clusters.
After a cluster is created, do not delete the key used by the cluster. Otherwise, the cluster will become unavailable.
+
+
+
+
+
+
+
Table 10 tags field description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
key
+
+
Yes
+
+
String
+
+
Tag key. The value can contain 1 to 36 characters. Only digits, letters, hyphens (-) and underscores (_) are allowed.
+
+
+
value
+
+
Yes
+
+
String
+
+
Tag value. The value can contain 0 to 43 characters. Only digits, letters, hyphens (-) and underscores (_) are allowed.
The client should not repeat the request without modifications.
+
+
+
409
+
+
Conflict
+
+
The request could not be processed due to a conflict.
+
This status code indicates that the resource that the client attempts to create already exits, or the request fails to be processed because of the update of the conflict request.
+
+
+
412
+
+
Precondition Failed
+
+
The server does not meet one of the preconditions that the requester puts on the request.
This API is used to delete a cluster. All resources, including customer data, of the deleted cluster will be released. For data security reasons, create a snapshot for the cluster that you want to delete.
+
+
URI
DELETE /v1.0/{project_id}/clusters/{cluster_id}
+
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
cluster_id
+
+
Yes
+
+
String
+
+
ID of the cluster to be deleted.
+
+
+
+
+
+
+
Request
None
+
+
Response
None
+
+
Examples
Delete the cluster whose ID is 2a197c4d-5467-4003-931d-83ec49939cf.
Modified the description about the endpoint and actions parameters in the response parameter table. Added the status code returned by the API for querying the list of clusters.
Modified the description about the actions parameter in the response parameter table. Added the status code returned by the API for querying details about a cluster.
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.
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.
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.
Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
+
+
+
name
+
+
String
+
+
Cluster name.
+
+
+
created
+
+
String
+
+
Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
+
+
+
id
+
+
String
+
+
Cluster ID.
+
+
+
status
+
+
String
+
+
Return value.
+
100: The operation, such as instance creation, is in progress.
200: The cluster is available.
303: The cluster is unavailable.
+
+
+
endpoint
+
+
String
+
+
Indicates the IP address and port number of the user used to access the VPC.
+
+
+
actionProgress
+
+
Object
+
+
Cluster operation progress, which indicates the progress of cluster creation and expansion in percentage.
+
+
+
actions
+
+
Array of strings
+
+
Current behavior on a cluster. Value REBOOTING indicates that the cluster is being restarted, GROWING indicates that capacity expansion is being performed on the cluster, RESTORING indicates that the cluster is being restored, and SNAPSHOTTING indicates that the snapshot is being created.
+
+
+
failed_reasons
+
+
Object
+
+
Failure cause. If the cluster is in the Available state, this parameter is not returned. For details, see Table 5.
+
+
+
httpsEnable
+
+
Boolean
+
+
Communication encryption status.
+
Value false indicates that communication encryption is not enabled.
Value true indicates that communication encryption has been enabled.
+
+
+
authorityEnable
+
+
String
+
+
Whether to enable authentication. Available values include true and false. Authentication is disabled by default. When authentication is enabled, httpsEnable must be set to true.
+
Value true indicates that authentication is enabled for the cluster.
Value false indicates that authentication is disabled for the cluster.
+
+
+
diskEncrypted
+
+
Boolean
+
+
Whether disks are encrypted.
+
Value true indicates that disks are encrypted.
Value false indicates that disks are not encrypted.
OBS bucket used for index data backup. If there is snapshot data in an OBS bucket, only the OBS bucket is used and cannot be changed.
+
+
+
agency
+
+
Yes
+
+
String
+
+
IAM agency used to access OBS.
+
+
+
snapshotCmkId
+
+
No
+
+
String
+
+
Key ID used for snapshot encryption.
+
The Default Master Keys cannot be used to create grants. Specifically, you cannot use Default Master Keys whose aliases end with /default in KMS to encrypt snapshots.
If a snapshot has been stored in the OBS bucket, you cannot modify the parameters for encrypting the snapshot.
If the key used for encryption is in the Pending deletion or disable state, you cannot perform backup and restoration operations on the cluster. Specifically, new snapshots cannot be created for the cluster, and existing snapshots cannot be used for restoration. In this case, switch to the KMS management console and change the state of the target key to enable so that backup and restore operations are allowed on the cluster.
If the key used for encryption is deleted, backup and restore operations are not allowed on the cluster. In addition, the deleted key cannot be restored. Therefore, exercise caution when deleting a key.
You are advised to disable the automatic snapshot creation function if the key is deleted or is in the Pending deletion or disable state. In this condition, automatic snapshot creation is allowed based on the configured snapshot policy. However, all automatic snapshot creation tasks will fail, and the failed tasks are displayed in the failed task list in the Failed Tasks dialog box.
+
+
+
+
+
+
+
Response
None
+
+
Examples
Example request
+
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/setting
+{
+ "bucket":"test-bucket",
+ "agency":"usearch",
+ "snapshotCmkId":"42546bb1-8025-4ad1-868f-600729c341aea"
+}
Prefix of the snapshot name that is automatically created.
+
+
+
period
+
+
Yes
+
+
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.
+
+
+
keepday
+
+
Yes
+
+
Integer
+
+
Number of days that a snapshot can be retained. The value ranges from 1 to 90. The system automatically deletes snapshots that have been retained for the allowed maximum duration on the half hour.
+
+
+
enable
+
+
Yes
+
+
String
+
+
Value true indicates that the automatic snapshot creation policy is enabled, and value false indicates that the automatic snapshot creation policy is disabled.
+
+
+
deleteAuto
+
+
No
+
+
String
+
+
Whether to delete all automatically created snapshots when the automatic snapshot creation policy is disabled. The default value is false, indicating that snapshots that have been automatically created are not deleted when the automatic snapshot creation function is disabled. If this parameter is set to true, all automatically created snapshots are deleted when the automatic snapshot creation policy is disabled.
Snapshot name. The snapshot name must start with a letter and contains 4 to 64 characters consisting of only lowercase letters, digits, hyphens (-), and underscores (_).
+
+
+
description
+
+
No
+
+
String
+
+
Description of a snapshot. The value contains 0 to 256 characters, and angle brackets (<) and (>) are not allowed.
+
+
+
indices
+
+
No
+
+
String
+
+
Name of the index to be backed up. Multiple index names are separated by commas (,). By default, data of all indices is backed up. You can use the asterisk (*) to back up data of certain indices. For example, if you enter 2018-06*, then data of indices with the name prefix of 2018-06 will be backed up.
+
The value contains 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed.
ID of the cluster, to which the snapshot is to be restored.
+
+
+
indices
+
+
No
+
+
String
+
+
Name of the index to be restored. Multiple index names are separated by commas (,). By default, data of all indices is restored. You can use the asterisk (*) to back up data of certain indices. For example, if you enter 2018-06*, then data of indices with the name prefix of 2018-06 will be restored.
+
The value contains 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed.
+
+
+
renamePattern
+
+
No
+
+
String
+
+
Rule for defining the indices to be restored. The value contains a maximum of 1,024 characters.
+
Indices that meet the filtering condition specified by this parameter are restored. The filtering condition must be specified using regular expressions. The value contains 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?,) are not allowed.
+
+
+
renameReplacement
+
+
No
+
+
String
+
+
Rule for renaming an index. The value contains 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?,) are not allowed. For example, value restored_index_$1 indicates that restored_ is added in front of the names of all restored indices.
+
The renamePattern and renameReplacement parameters must be both configured.
+
+
+
+
+
+
+
Response
None
+
+
Examples
Example request
+
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/29a2254e-947f-4463-b65a-5f0b17515fae/restore
+{
+ "targetCluster":"ea244205-d641-45d9-9dcb-ab2236bcd07e",
+ "indices":"myindex1,myindex2"
+}
(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot
+
The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapthos. If you have multiple clusters, an OBS bucket will be created for each cluster via this API during automatic configuration and consume your OBS quota. Too many OBS buckets will be difficult to manage. You are advised to perform operations in Modifying Basic Configurations of a Cluster Snapshot.
+
+
Function
This API is used to automatically set basic configurations for a cluster snapshot, including configuring OBS buckets and IAM agency.
+
OBS Bucket: Enter the location of the OBS bucket used for storing snapshots.
IAM Agency: Authorize you to use OBS in IAM so that snapshots must be stored in OBS.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/auto_setting
+
+
Table 1 Parameter description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID.
+
+
+
cluster_id
+
+
Yes
+
+
String
+
+
ID of the cluster where snapshots are to be backed up.
+
+
+
+
+
+
+
Request
None
+
+
Response
None
+
+
Examples
Example request
+
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/auto_setting
This API is used to scale out a cluster with special nodes. That is, if a cluster has master, client, or cold data nodes, this API is used for scale-out.
+
+
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/role_extend
Detailed description about the cluster scale-out request. For details, see Table 3.
+
+
+
+
+
+
+
Table 3 grow field description
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
type
+
+
Yes
+
+
String
+
+
Type of the instance to be scaled out. Select at least one from ess, ess-cold, ess-master, and ess-client.
+
You can only add instances, rather than increase storage capacity, on nodes of the ess-master and ess-client types.
+
+
+
nodesize
+
+
Yes
+
+
Integer
+
+
Number of instances to be scaled out. The total number of existing instances and newly added instances in a cluster cannot exceed 32.
+
+
+
disksize
+
+
Yes
+
+
Integer
+
+
Storage capacity of the instance to be expanded. The total storage capacity of existing instances and newly added instances in a cluster cannot exceed the maximum instance storage capacity allowed when a cluster is being created. In addition, you can expand the instance storage capacity for a cluster for up to six times.
This API is used to download the HTTPS certificate file of the server.
+
+
URI
GET /v1.0/dev/cluster/sslCert
+
+
Request
None
+
+
Response
+
Table 1 Parameter description
Parameter
+
+
Type
+
+
Description
+
+
+
+
certBase64
+
+
String
+
+
This string is obtained after the certificate file is transcoded using Base64. You need to run the following command to parse the string into a certificate file. The generated certificate file is saved in the folder where the command to be executed is located. In the following command, "$certBase64" indicates the string returned in the response message. The name of the generated certificate file is CloudSearchService.cert. You can specify another name for the certificate file, but must use .cert as the suffix of the name.
Welcome to Cloud Search Service API Reference. Cloud Search Service (CSS) provides hosted, distributed search engine services. It is fully compatible with open-source Elasticsearch and supports multi-condition retrieval, statistics, and reporting of structured and unstructured texts.
+
This document provides CSS API description, syntax, parameters, and examples. CSS provides APIs for cluster management and snapshot management. You can call these APIs to easily create, query, delete, restart, and scale clusters.
+
You can search for information you need according to Table 1.
+
Table 1 Overview
Chapter
+
+
Description
+
+
+
+
API Overview
+
+
API constituents and list
+
+
+
Environment Preparation
+
+
Prerequisites for using the APIs.
+
+
+
API Calling
+
+
Representational State Transfer (REST) message bodies, calling methods, and examples
+
+
+
APIs for each module
+
+
APIs provided by CSS
+
+
+
Common Parameters
+
+
Common parameters, status codes, and error codes of CSS APIs
An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.
The CSS API is a self-developed API that complies with RESTful API design specifications. You can call CSS APIs to implement the CSS functions described in Table 1.
+
+
Table 1 API description
Type
+
+
Description
+
+
+
+
Cluster Management APIs
+
+
You can use cluster management APIs to create clusters, scale out a cluster, view cluster details, and obtain instance specifications.
+
+
+
Snapshot Management APIs
+
+
Snapshots can be used to back up and restore data. You can use snapshot management APIs to create, restore, or delete a snapshot.
A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.
+
Obtaining a Project ID and Name from the Console
Log in to the console.
In the upper right corner of the page, click the username and choose My Credentials from the drop-down list. The My Credentials page is displayed.
In the project list, view the Project ID and Project Name.
Figure 1 Viewing the project ID and name
+
+
+
Obtaining a Project ID by Calling an API
The API for obtaining a project ID is GET https://{iam-endpoint}/v3/projects. {iam-endpoint} indicates the endpoint of IAM, which can be obtained from Endpoints.
+
The following is an example response. For example, if CSS is deployed in region xxx, the value of name in the response body is xxx. The value of id in projects is the project ID.
This parameter is mandatory for authentication using AK/SK.
+
+
Server domain name and port number of the resource being requested. The value can be obtained from the URL of the service API. The value is hostname[:port]. If the port number is not specified, the default port is used. The default port number for https is 443.
+
+
+
Content-Type
+
+
Yes
+
+
MIME type of the request body.
+
+
+
Content-Length
+
+
This parameter is mandatory for POST and PUT requests, but must be left blank for GET requests.
+
+
Length of the request body. The unit is byte.
+
+
+
X-Project-Id
+
+
No
+
+
Project ID. This parameter is used to obtain the token for each project.
+
+
+
X-Auth-Token
+
+
No (This parameter is mandatory for authentication using tokens.)
This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server.
+
+
+
101
+
+
Switching Protocols
+
+
Switching protocols. The target protocol must be later than the source protocol.
+
For example, the current HTTPS protocol is switched to a later version.
+
+
+
200
+
+
OK
+
+
The request is processed successfully.
+
+
+
201
+
+
Created
+
+
The request for creating a resource has been fulfilled.
+
+
+
202
+
+
Accepted
+
+
The request has been accepted, but the processing has not been completed.
+
+
+
203
+
+
Non-Authoritative Information
+
+
The server successfully processed the request, but is returning information that may be from another source.
+
+
+
204
+
+
NoContent
+
+
The server has successfully processed the request, but has not returned any content.
+
The status code is returned in response to an HTTPS OPTIONS request.
+
+
+
205
+
+
Reset Content
+
+
The server has fulfilled the request, but the requester is required to reset the content.
+
+
+
206
+
+
Partial Content
+
+
The server has processed certain GET requests.
+
+
+
300
+
+
Multiple Choices
+
+
There are multiple options for the location of the requested resource. The response contains a list of resource characteristics and addresses from which the user or user agent (such as a browser) can choose the most appropriate one.
+
+
+
301
+
+
Moved Permanently
+
+
The requested resource has been assigned a new permanent URI, and the new URI is contained in the response.
+
+
+
302
+
+
Found
+
+
The requested resource resides temporarily under a different URI.
+
+
+
303
+
+
See Other
+
+
Retrieve a location.
+
The response to the request can be found under a different URI and should be retrieved using a GET or POST method.
+
+
+
304
+
+
Not Modified
+
+
The requested resource has not been modified. When the server returns this status code, it does not return any resources.
+
+
+
305
+
+
Use Proxy
+
+
The requested resource must be accessed through a proxy.
+
+
+
306
+
+
Unused
+
+
The HTTPS status code is no longer used.
+
+
+
400
+
+
BadRequest
+
+
Invalid request.
+
The client should not repeat the request without modifications.
+
+
+
401
+
+
Unauthorized
+
+
The status code is returned after the client provides the authentication information, indicating that the authentication information is incorrect or invalid.
+
+
+
402
+
+
Payment Required
+
+
This status code is reserved for future use.
+
+
+
403
+
+
Forbidden
+
+
The server understood the request, but is refusing to fulfill it.
+
The client should not repeat the request without modifications.
+
+
+
404
+
+
NotFound
+
+
The requested resource cannot be found.
+
The client should not repeat the request without modifications.
+
+
+
405
+
+
MethodNotAllowed
+
+
The method specified in the request is not supported for the requested resource.
+
The client should not repeat the request without modifications.
+
+
+
406
+
+
Not Acceptable
+
+
The server cannot fulfill the request according to the content characteristics of the request.
+
+
+
407
+
+
Proxy Authentication Required
+
+
This status code is similar to 401, but indicates that the client must first authenticate itself with the proxy.
+
+
+
408
+
+
Request Time-out
+
+
The request timed out.
+
The client may repeat the request without modifications at any later time.
+
+
+
409
+
+
Conflict
+
+
The request could not be processed due to a conflict.
+
This status code indicates that the resource that the client attempts to create already exits, or the request fails to be processed because of the update of the conflict request.
+
+
+
410
+
+
Gone
+
+
The requested resource is no longer available.
+
The status code indicates that the requested resource has been deleted.
+
+
+
411
+
+
Length Required
+
+
The server refuses to process the request without a defined Content-Length.
+
+
+
412
+
+
Precondition Failed
+
+
The server does not meet one of the preconditions that the requester puts on the request.
+
+
+
413
+
+
Request Entity Too Large
+
+
The request is larger than that a server is able to process. The server may close the connection to prevent the client from continuing the request. If the server cannot process the request temporarily, the response will contain a Retry-After header field.
+
+
+
414
+
+
Request-URI Too Large
+
+
The URI provided was too long for the server to process.
+
+
+
415
+
+
Unsupported Media Type
+
+
The server is unable to process the media format in the request.
+
+
+
416
+
+
Requested range not satisfiable
+
+
The requested range is invalid.
+
+
+
417
+
+
Expectation Failed
+
+
The server fails to meet the requirements of the Expect request-header field.
+
+
+
422
+
+
UnprocessableEntity
+
+
The request is well-formed but is unable to be processed due to semantic errors.
+
+
+
429
+
+
TooManyRequests
+
+
The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, it is advisable for the client to re-initiate requests after the time specified in the Retry-After header of the response expires.
+
+
+
500
+
+
InternalServerError
+
+
The server is able to receive the request but it could not understand the request.
+
+
+
501
+
+
Not Implemented
+
+
The server does not support the requested function.
+
+
+
502
+
+
Bad Gateway
+
+
The server is acting as a gateway or proxy and receives an invalid request from a remote server.
+
+
+
503
+
+
ServiceUnavailable
+
+
The requested service is invalid.
+
The client should not repeat the request without modifications.
+
+
+
504
+
+
ServerTimeout
+
+
The request cannot be fulfilled within a given time. This status code is returned to the client only when the Timeout parameter is specified in the request.
+
+
+
505
+
+
HTTP Version not supported
+
+
The server does not support the HTTPS protocol version used in the request.
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 code 4xx or 5xx is returned. The returned message body contains the specific error code and error information. If you fail to locate the cause of the error, contact technical support and provide the error code for troubleshooting.
+
+
Status Code
+
+
Error Code
+
+
Error Message
+
+
Measure
+
+
+
+
400
+
+
CSS.0001
+
+
The parameter is incorrect.
+
+
Check the parameter settings according to the returned information.
+
+
+
500
+
+
CSS.0005
+
+
Server error.
+
+
Contact technical support.
+
+
+
400
+
+
CSS.0006
+
+
The request body is empty. Enter a request parameter.
+
+
Enter the request parameters.
+
+
+
202
+
+
CSS.0011
+
+
This operation cannot be performed because another operation is being performed on the instance or the instance is faulty. Please try again later.
+
+
Try again later.
+
+
+
403
+
+
CSS.0015
+
+
Resource not found or permission denied.
+
+
Change the resource ID or check the access permission.
+
+
+
404
+
+
CSS.0022
+
+
The instance does not exist or has been deleted.
+
+
Change the instance ID.
+
+
+
403
+
+
CSS.0032
+
+
The current user has no operation permissions.
+
+
Check the permissions.
+
+
+
400
+
+
CSS.0045
+
+
The token is incorrect.
+
+
Obtain the token again.
+
+
+
400
+
+
CSS.1112
+
+
The number of instances has reached the quota.
+
+
Delete some clusters or increase the quota.
+
+
+
400
+
+
CSS.3011
+
+
Invalid retention duration of the backup.
+
+
Change the allowed retention duration.
+
+
+
404
+
+
CSS.3027
+
+
The cluster does not exist.
+
+
Check whether the cluster ID is correct.
+
+
+
400
+
+
CSS.5007
+
+
The selected flavor does not exist.
+
+
Check whether the specifications are correct.
+
+
+
400
+
+
CSS.5009
+
+
The hard disk size is beyond the valid range.
+
+
Change the disk size.
+
+
+
400
+
+
CSS.5014
+
+
Invalid VPC ID.
+
+
Check whether the VPC ID is correct.
+
+
+
400
+
+
CSS.5015
+
+
Invalid subnet ID.
+
+
Check whether the subnet ID is correct.
+
+
+
400
+
+
CSS.5021
+
+
The VPC does not exist or does not belong to the user.
+
+
Check whether the VPC is correct.
+
+
+
400
+
+
CSS.5023
+
+
The security group does not exist or does not belong to the VPC.
+
+
Check whether the security group is correct.
+
+
+
400
+
+
CSS.5157
+
+
The CIDR does not exist or is invalid.
+
+
Check whether there are subnets in the VPC.
+
+
+
400
+
+
CSS.5036
+
+
The engine does not exist.
+
+
Check whether the datastore parameter setting is correct.
+
+
+
400
+
+
CSS.5047
+
+
The number of instances is beyond the valid range.
+
+
Check whether the number of instances is within the range.
+
+
+
409
+
+
CSS.5050
+
+
The cluster name already exists.
+
+
Change the cluster name.
+
+
+
400
+
+
CSS.5052
+
+
Invalid value of the AZ.
+
+
Change the AZ.
+
+
+
400
+
+
CSS.5055
+
+
Invalid flavor.
+
+
Modify the specifications.
+
+
+
400
+
+
CSS.5061
+
+
The hard disk type is invalid.
+
+
Change the hard disk type.
+
+
+
400
+
+
CSS.5071
+
+
The disk type does not match that in the XML configuration file.
+
+
Change the hard disk type.
+
+
+
400
+
+
CSS.5072
+
+
The security group ID is invalid.
+
+
Change the security group ID.
+
+
+
400
+
+
CSS.5074
+
+
The subnet does not belong to the VPC.
+
+
Change the subnet ID.
+
+
+
400
+
+
CSS.5077
+
+
Invalid cluster name.
+
+
Change the cluster name.
+
+
+
400
+
+
CSS.5078
+
+
The hard disk size is beyond the valid range.
+
+
Change the disk size.
+
+
+
400
+
+
CSS.5092
+
+
Invalid hard disk information.
+
+
Modify the hard disk information.
+
+
+
400
+
+
CSS.5093
+
+
Invalid specification information.
+
+
Modify the specification information.
+
+
+
412
+
+
CSS.5130
+
+
The agency name is invalid.
+
+
Change the agency name.
+
+
+
500
+
+
CSS.9999
+
+
Request processing failed.
+
+
Contact technical support.
+
+
+
NA
+
+
CSS.6000
+
+
Clusters fail to be created.
+
+
Try again later or contact technical support.
+
+
+
NA
+
+
CSS.6001
+
+
Cluster scale-out fails.
+
+
+
Try again later or contact technical support.
+
+
+
NA
+
+
CSS.6002
+
+
Failed to bind the elastic IP address to the cluster.
+
+
Try again later or contact technical support.
+
+
+
N/A
+
+
CSS.6003
+
+
Failed to restore the cluster.
+
+
Try again later or contact technical support.
+
+
+
N/A
+
+
CSS.6004
+
+
Failed to create a node.
+
+
Try again later or contact technical support.
+
+
+
N/A
+
+
CSS.6005
+
+
The initialization fails.
+
+
Perform the initialization again or contact technical support.
+
+
+
NA
+
+
CSS.6006
+
+
Failed to modify the specifications.
+
+
Perform the initialization again or contact technical support.
+
+
+
NA
+
+
CSS.6007
+
+
Failed to reset the password.
+
+
Reset the password.
+
+
+
N/A
+
+
CSS.6008
+
+
Failed to update the YML file.
+
+
Update the .yml file again or contact technical support.
+
+
+
N/A
+
+
CSS.6009
+
+
Failed to create the snapshot.
+
+
Try again later or contact technical support.
+
+
+
N/A
+
+
CSS.6010
+
+
Failed to restore the snapshot because the OBS object does not exist or has been deleted.
+
+
Check whether the configured OBS object exists.
+
+
+
N/A
+
+
CSS.6011
+
+
Failed to create the snapshot because the OBS bucket you select does not exist or has been deleted.
+
+
Check whether the OBS bucket exists.
+
+
+
N/A
+
+
CSS.6012
+
+
Failed to restore the snapshot because the OBS object does not exist or has been deleted.
+
+
Check whether the OBS bucket exists.
+
+
+
N/A
+
+
CSS.6013
+
+
The parameters cannot be modified because other operations are being performed on the cluster.
+
+
Modify parameters when the cluster is available.
+
+
+
N/A
+
+
CSS.6014
+
+
Some parameters cannot be modified.
+
+
Check whether the submitted parameter modification request contains a parameter value that cannot be modified. If yes, delete the parameter and try again.
This API is used to add or delete tags to or from a specified cluster in batches. Tag Management Service (TMS) uses this API to batch manage tags of a cluster. A cluster can have a maximum of 10 tags.
+
This API is an idempotent API. If the request body contains duplicate keys during tag creation, an error is reported.
When a tag is added:
The key cannot be left blank or be an empty string. It cannot contain the following characters: Non-printable ASCII characters (0-31), =, *, <, >, \, ,, |, /, letters, digits, hyphens (-), and underscores (_).
The value cannot be left blank but can be an empty string. It cannot contain the following characters: Non-printable ASCII characters (0-31), =, *, <, >, \, ,, |, /, letters, digits, hyphens (-), and underscores (_).
The key cannot be duplicate. If the key already exists in the database, the value will be overwritten.
+
When a tag is deleted:
If a to-be-deleted tag does not exist, the operation is considered successful by default. The value range of the tag character set is not verified.
The tag structure body cannot be missing, and the key cannot be left blank or be an empty string.
+
+
+
+
+
URI
POST /v1.0/{project_id}/css-cluster/{cluster_id}/tags/action
+
+
+
Table 1 Parameters
Parameter
+
+
Mandatory
+
+
Type
+
+
Description
+
+
+
+
project_id
+
+
Yes
+
+
String
+
+
Project ID
+
+
+
cluster_id
+
+
Yes
+
+
String
+
+
IDs of clusters to which tags are to be added or deleted in batches
This section describes the structure of a RESTful API request, and uses the API for Obtaining a User Token as an example to describe how to call an API. A token is a user's access credential, which contains the user identity and permission information. The obtained token is used to authenticate the calling of other APIs.
Protocol used to transmit requests. All APIs use HTTPS.
+
+
+
Endpoint
+
+
Domain name or IP address of the server running the REST service. The endpoint varies between services in different regions. It can be obtained from Endpoints.
+
+
+
resource-path
+
+
API access path for performing a specified operation. Obtain the value from the URI of the API. For example, the resource-path of the API for obtaining a user token is /v3/auth/tokens.
+
+
+
query-string
+
+
Query parameter, which is optional. Ensure that a question mark (?) is included before a query parameter that is in the format of "Parameter name=Parameter value". For example, limit=10 indicates that a maximum of 10 pieces of data is to be viewed.
+
+
+
+
+
+
+
For example, to obtain an IAM token in a region, obtain the endpoint of IAM for this region and the resource-path (/v3/auth/tokens) in the URI of the API used to obtain a user token. Then, construct the URI as follows:
https://<iam-endpoint>/v3/auth/tokens
+
+
To simplify the URI display, each API is provided with only a resource-path and a request method. This is because the URI-scheme value of all APIs is HTTPS, and the endpoints in a region are the same. Therefore, the two parts are omitted.
+
+
+
Request Methods
HTTP-based request methods, which are also called operations or actions, specify the type of operations that you are requesting.
+
GET: requests the server to return specified resources.
PUT: requests the server to update specified resources.
POST: requests the server to add resources or perform special operations.
DELETE: requests the server to delete specified resources, for example, an object.
HEAD: requests a server resource header.
PATCH: requests the server to update partial content of a specified resource. If the target resource does not exist, PATCH may create a resource.
+
If POST is displayed in the URI of the API for obtaining a user token, the request is as follows:
+
+POST https://{iam-endpoint}/v3/auth/tokens
+
+
Request Header
You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, add Content-Type that defines a request body type to request for the authentication information.
+
Common request headers are as follows:
+
Content-Type: specifies the request body type or format. This field is mandatory and its default value is application/json.
X-Auth-Token: specifies the user token, which is optional. This field is mandatory for token-based authentication. X-Auth-Token is the value of x-subject-token returned in response to the API used to obtain a user token.
In addition to supporting authentication using tokens, APIs support authentication using the access key ID (AK)/secret access key (SK), which uses SDKs to sign a request. During the signing, the Authorization (signature authentication information) and X-Sdk-Date (time when a request is sent) headers are automatically added to the request. For more details, see Authentication Using AK/SK.
+
+
+
The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
+
POST https://{iam-endpoint}/v3/auth/tokens
+Content-Type: application/json
+
+
Request Body
A request body conveys information other than the request header and is generally sent in a structured format defined by the request header field Content-Type.
+
The request body varies according to the APIs. Certain APIs do not require the request body, such as the GET and DELETE APIs.
+
In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project ID) with the actual values. To learn how to obtain a project ID, see Obtaining a Project ID and Name.
+
The scope parameter defines the application scope of the token, indicating that the obtained token can access only the resources in the specified project.
+
+
POST https://{iam-endpoint}/v3/auth/tokens
+Content-Type: application/json
+{
+ "auth": {
+ "identity": {
+ "methods": [
+ "password"
+ ],
+ "password": {
+ "user": {
+ "name": "username", //Username
+ "password": "********", //Login password
+ "domain": {
+ "name": "domainname " //Name of the account to which the user belongs
+ }
+ }
+ }
+ },
+ "scope": {
+ "project": {
+ "id": "xxxxxxxxxxxxxxxxxx" //Project ID
+ }
+ }
+ }
+}
+
If all data required by a request is available, you can send the request to call an API through curl, Postman, or coding. For the API of obtaining a user token, x-subject-token in the response header is the desired user token. Then, you can use the token to authenticate the calling of other APIs.
The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.
+
+
A token specifies certain permissions in a computer system. Authentication using a token adds the token to a request as its header during API calling to obtain permissions to operate APIs through IAM.
+
The API for obtaining a token is POST https://{IAM endpoint}/v3/auth/tokens. For details about how to obtain IAM endpoints, see Endpoints.
+
{
+ "auth": {
+ "identity": {
+ "methods": [
+ "password"
+ ],
+ "password": {
+ "user": {
+ "name": "username", //Username
+ "password": "********", //Login password
+ "domain": {
+ "name": "domainname" //Name of the account that the user belongs to
+ }
+ }
+ }
+ },
+ "scope": {
+ "project": {
+ "name": "xxxxxxxx" //Project name
+ }
+ }
+ }
+}
+
After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
+
POST https://{endpoint}/v3/auth/projects
+Content-Type: application/json
+X-Auth-Token: ABCDEFJ....
After sending a request, you will receive a response containing the status code, response header, and response body.
+
A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.
+
If status code 201 is returned for the calling of the API for obtaining a user token, the request is successful.
+
+
Response Header
A response header corresponds to a request header, for example, Content-Type.
+
Figure 1 shows the response header for the API of obtaining a user token, where x-subject-token is the desired user token. Then, you can use the token to authenticate the calling of other APIs.
+
Figure 1 Header of the response to the request for obtaining a user token
+
+
Response Body
A response body is generally returned in a structured format, corresponding to the Content-Type in the response header, and is used to transfer content other than the response header.
+
The following shows part of the response body for the API of obtaining a user token.
If an error occurs during API calling, the system returns an error code and a message to you. The following shows the format of an error response body:
+
{
+ "error_msg": "The format of message is error",
+ "error_code": "AS.0001"
+}
+
In the preceding information, error_code is an error code, and error_msg describes the error.
+
+
+
\ No newline at end of file
diff --git a/docs/css/api-ref/public_sys-resources/ExpandCollapse.js b/docs/css/api-ref/public_sys-resources/ExpandCollapse.js
new file mode 100644
index 000000000..3f1b7db00
--- /dev/null
+++ b/docs/css/api-ref/public_sys-resources/ExpandCollapse.js
@@ -0,0 +1 @@
+var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";var href="";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(href.substring(href.lastIndexOf("#")+1))}}catch(a){}};
\ No newline at end of file
diff --git a/docs/css/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/css/api-ref/public_sys-resources/caution_3.0-en-us.png
new file mode 100644
index 000000000..60f607621
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/caution_3.0-en-us.png differ
diff --git a/docs/css/api-ref/public_sys-resources/commonltr.css b/docs/css/api-ref/public_sys-resources/commonltr.css
new file mode 100644
index 000000000..c5480b0ab
--- /dev/null
+++ b/docs/css/api-ref/public_sys-resources/commonltr.css
@@ -0,0 +1 @@
+body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}
\ No newline at end of file
diff --git a/docs/css/api-ref/public_sys-resources/commonltr_print.css b/docs/css/api-ref/public_sys-resources/commonltr_print.css
new file mode 100644
index 000000000..a59823141
--- /dev/null
+++ b/docs/css/api-ref/public_sys-resources/commonltr_print.css
@@ -0,0 +1 @@
+body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm}
\ No newline at end of file
diff --git a/docs/css/api-ref/public_sys-resources/commonrtl.css b/docs/css/api-ref/public_sys-resources/commonrtl.css
new file mode 100644
index 000000000..f261da752
--- /dev/null
+++ b/docs/css/api-ref/public_sys-resources/commonrtl.css
@@ -0,0 +1,2 @@
+/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式
+*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre}
\ No newline at end of file
diff --git a/docs/css/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/css/api-ref/public_sys-resources/danger_3.0-en-us.png
new file mode 100644
index 000000000..47a9c7235
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/danger_3.0-en-us.png differ
diff --git a/docs/css/api-ref/public_sys-resources/delta.gif b/docs/css/api-ref/public_sys-resources/delta.gif
new file mode 100644
index 000000000..0d1b1f674
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/delta.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/deltaend.gif b/docs/css/api-ref/public_sys-resources/deltaend.gif
new file mode 100644
index 000000000..cc7da0fc8
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/deltaend.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/css/api-ref/public_sys-resources/icon-arrowdn.gif
new file mode 100644
index 000000000..84eec9be2
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/icon-arrowdn.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/css/api-ref/public_sys-resources/icon-arrowrt.gif
new file mode 100644
index 000000000..39583d168
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/icon-arrowrt.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/icon-caution.gif b/docs/css/api-ref/public_sys-resources/icon-caution.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/icon-caution.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/icon-danger.gif b/docs/css/api-ref/public_sys-resources/icon-danger.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/icon-danger.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/icon-huawei.gif b/docs/css/api-ref/public_sys-resources/icon-huawei.gif
new file mode 100644
index 000000000..a31d60f89
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/icon-huawei.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/icon-note.gif b/docs/css/api-ref/public_sys-resources/icon-note.gif
new file mode 100644
index 000000000..31be2b039
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/icon-note.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/icon-notice.gif b/docs/css/api-ref/public_sys-resources/icon-notice.gif
new file mode 100644
index 000000000..409070650
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/icon-notice.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/icon-tip.gif b/docs/css/api-ref/public_sys-resources/icon-tip.gif
new file mode 100644
index 000000000..c47bae05c
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/icon-tip.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/icon-warning.gif b/docs/css/api-ref/public_sys-resources/icon-warning.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/icon-warning.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/imageResize.js b/docs/css/api-ref/public_sys-resources/imageResize.js
new file mode 100644
index 000000000..37309ce3b
--- /dev/null
+++ b/docs/css/api-ref/public_sys-resources/imageResize.js
@@ -0,0 +1,18 @@
+/** IDP renames $ to $$$,jQueryHW2 */
+var $$$, jQueryHW2;
+jQueryHW2 = $$$ = $;
+
+function image_size(a) {
+ $$$(window).on('load', function () {
+ $$$(a).each(function () {
+ var e = $$$(this);
+ var f = e.width();
+ var d = e.height();
+ var b = f;
+ var c = d;
+ e.click(function () {
+ tb_show("", this.src, false)
+ })
+ })
+ })
+};
\ No newline at end of file
diff --git a/docs/css/api-ref/public_sys-resources/imageclose.gif b/docs/css/api-ref/public_sys-resources/imageclose.gif
new file mode 100644
index 000000000..56818c26b
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/imageclose.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/imageclosehover.gif b/docs/css/api-ref/public_sys-resources/imageclosehover.gif
new file mode 100644
index 000000000..3bcf231f1
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/imageclosehover.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/imagemax.gif b/docs/css/api-ref/public_sys-resources/imagemax.gif
new file mode 100644
index 000000000..49fe390b1
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/imagemax.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/imagemaxhover.gif b/docs/css/api-ref/public_sys-resources/imagemaxhover.gif
new file mode 100644
index 000000000..387b0a981
Binary files /dev/null and b/docs/css/api-ref/public_sys-resources/imagemaxhover.gif differ
diff --git a/docs/css/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js b/docs/css/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js
new file mode 100644
index 000000000..88f4844bf
--- /dev/null
+++ b/docs/css/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js
@@ -0,0 +1,2 @@
+/*! jQuery Migrate v1.2.1 | (c) 2005, 2013 jQuery Foundation, Inc. and other contributors | jquery.org/license */
+jQueryHW2.migrateMute===void 0&&(jQueryHW2.migrateMute=!0),function(e,t,n){function r(n){}function a(t,a,i,o){if(Object.defineProperty)try{return Object.defineProperty(t,a,{configurable:!0,enumerable:!0,get:function(){return r(o),i},set:function(e){r(o),i=e}}),n}catch(s){}e._definePropertyBroken=!0,t[a]=i}var i={};e.migrateWarnings=[],!e.migrateMute,e.migrateTrace===n&&(e.migrateTrace=!0),e.migrateReset=function(){i={},e.migrateWarnings.length=0},"BackCompat"===document.compatMode&&r("jQueryHW2 is not compatible with Quirks Mode");var o=e("",{size:1}).attr("size")&&e.attrFn,s=e.attr,u=e.attrHooks.value&&e.attrHooks.value.get||function(){return null},c=e.attrHooks.value&&e.attrHooks.value.set||function(){return n},l=/^(?:input|button)$/i,d=/^[238]$/,p=/^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,f=/^(?:checked|selected)$/i;a(e,"attrFn",o||{},"jQueryHW2.attrFn is deprecated"),e.attr=function(t,a,i,u){var c=a.toLowerCase(),g=t&&t.nodeType;return u&&(4>s.length&&r("jQueryHW2.fn.attr( props, pass ) is deprecated"),t&&!d.test(g)&&(o?a in o:e.isFunction(e.fn[a])))?e(t)[a](i):("type"===a&&i!==n&&l.test(t.nodeName)&&t.parentNode&&r("Can't change the 'type' of an input or button in IE 6/7/8"),!e.attrHooks[c]&&p.test(c)&&(e.attrHooks[c]={get:function(t,r){var a,i=e.prop(t,r);return i===!0||"boolean"!=typeof i&&(a=t.getAttributeNode(r))&&a.nodeValue!==!1?r.toLowerCase():n},set:function(t,n,r){var a;return n===!1?e.removeAttr(t,r):(a=e.propFix[r]||r,a in t&&(t[a]=!0),t.setAttribute(r,r.toLowerCase())),r}},f.test(c)&&r("jQueryHW2.fn.attr('"+c+"') may use property instead of attribute")),s.call(e,t,a,i))},e.attrHooks.value={get:function(e,t){var n=(e.nodeName||"").toLowerCase();return"button"===n?u.apply(this,arguments):("input"!==n&&"option"!==n&&r("jQueryHW2.fn.attr('value') no longer gets properties"),t in e?e.value:null)},set:function(e,t){var a=(e.nodeName||"").toLowerCase();return"button"===a?c.apply(this,arguments):("input"!==a&&"option"!==a&&r("jQueryHW2.fn.attr('value', val) no longer sets properties"),e.value=t,n)}};var g,h,v=e.fn.init,m=e.parseJSON,y=/^([^<]*)(<[\w\W]+>)([^>]*)$/;e.fn.init=function(t,n,a){var i;return t&&"string"==typeof t&&!e.isPlainObject(n)&&(i=y.exec(e.trim(t)))&&i[0]&&("<"!==t.charAt(0)&&r("$(html) HTML strings must start with '<' character"),i[3]&&r("$(html) HTML text after last tag is ignored"),"#"===i[0].charAt(0)&&(r("HTML string cannot start with a '#' character"),e.error("JQMIGRATE: Invalid selector string (XSS)")),n&&n.context&&(n=n.context),e.parseHTML)?v.call(this,e.parseHTML(i[2],n,!0),n,a):v.apply(this,arguments)},e.fn.init.prototype=e.fn,e.parseJSON=function(e){return e||null===e?m.apply(this,arguments):(r("jQueryHW2.parseJSON requires a valid JSON string"),null)},e.uaMatch=function(e){e=e.toLowerCase();var t=/(chrome)[ \/]([\w.]+)/.exec(e)||/(webkit)[ \/]([\w.]+)/.exec(e)||/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(e)||/(msie) ([\w.]+)/.exec(e)||0>e.indexOf("compatible")&&/(mozilla)(?:.*? rv:([\w.]+)|)/.exec(e)||[];return{browser:t[1]||"",version:t[2]||"0"}},e.browser||(g=e.uaMatch(navigator.userAgent),h={},g.browser&&(h[g.browser]=!0,h.version=g.version),h.chrome?h.webkit=!0:h.webkit&&(h.safari=!0),e.browser=h),a(e,"browser",e.browser,"jQueryHW2.browser is deprecated"),e.sub=function(){function t(e,n){return new t.fn.init(e,n)}e.extend(!0,t,this),t.superclass=this,t.fn=t.prototype=this(),t.fn.constructor=t,t.sub=this.sub,t.fn.init=function(r,a){return a&&a instanceof e&&!(a instanceof t)&&(a=t(a)),e.fn.init.call(this,r,a,n)},t.fn.init.prototype=t.fn;var n=t(document);return r("jQueryHW2.sub() is deprecated"),t},e.ajaxSetup({converters:{"text json":e.parseJSON}});var b=e.fn.data;e.fn.data=function(t){var a,i,o=this[0];return!o||"events"!==t||1!==arguments.length||(a=e.data(o,t),i=e._data(o,t),a!==n&&a!==i||i===n)?b.apply(this,arguments):(r("Use of jQueryHW2.fn.data('events') is deprecated"),i)};var j=/\/(java|ecma)script/i,w=e.fn.andSelf||e.fn.addBack;e.fn.andSelf=function(){return r("jQueryHW2.fn.andSelf() replaced by jQueryHW2.fn.addBack()"),w.apply(this,arguments)},e.clean||(e.clean=function(t,a,i,o){a=a||document,a=!a.nodeType&&a[0]||a,a=a.ownerDocument||a,r("jQueryHW2.clean() is deprecated");var s,u,c,l,d=[];if(e.merge(d,e.buildFragment(t,a).childNodes),i)for(c=function(e){return!e.type||j.test(e.type)?o?o.push(e.parentNode?e.parentNode.removeChild(e):e):i.appendChild(e):n},s=0;null!=(u=d[s]);s++)e.nodeName(u,"script")&&c(u)||(i.appendChild(u),u.getElementsByTagName!==n&&(l=e.grep(e.merge([],u.getElementsByTagName("script")),c),d.splice.apply(d,[s+1,0].concat(l)),s+=l.length));return d});var Q=e.event.add,x=e.event.remove,k=e.event.trigger,N=e.fn.toggle,T=e.fn.live,M=e.fn.die,S="ajaxStart|ajaxStop|ajaxSend|ajaxComplete|ajaxError|ajaxSuccess",C=RegExp("\\b(?:"+S+")\\b"),H=/(?:^|\s)hover(\.\S+|)\b/,A=function(t){return"string"!=typeof t||e.event.special.hover?t:(H.test(t)&&r("'hover' pseudo-event is deprecated, use 'mouseenter mouseleave'"),t&&t.replace(H,"mouseenter$1 mouseleave$1"))};e.event.props&&"attrChange"!==e.event.props[0]&&e.event.props.unshift("attrChange","attrName","relatedNode","srcElement"),e.event.dispatch&&a(e.event,"handle",e.event.dispatch,"jQueryHW2.event.handle is undocumented and deprecated"),e.event.add=function(e,t,n,a,i){e!==document&&C.test(t)&&r("AJAX events should be attached to document: "+t),Q.call(this,e,A(t||""),n,a,i)},e.event.remove=function(e,t,n,r,a){x.call(this,e,A(t)||"",n,r,a)},e.fn.error=function(){var e=Array.prototype.slice.call(arguments,0);return r("jQueryHW2.fn.error() is deprecated"),e.splice(0,0,"error"),arguments.length?this.bind.apply(this,e):(this.triggerHandler.apply(this,e),this)},e.fn.toggle=function(t,n){if(!e.isFunction(t)||!e.isFunction(n))return N.apply(this,arguments);r("jQueryHW2.fn.toggle(handler, handler...) is deprecated");var a=arguments,i=t.guid||e.guid++,o=0,s=function(n){var r=(e._data(this,"lastToggle"+t.guid)||0)%o;return e._data(this,"lastToggle"+t.guid,r+1),n.preventDefault(),a[r].apply(this,arguments)||!1};for(s.guid=i;a.length>o;)a[o++].guid=i;return this.click(s)},e.fn.live=function(t,n,a){return r("jQueryHW2.fn.live() is deprecated"),T?T.apply(this,arguments):(e(this.context).on(t,this.selector,n,a),this)},e.fn.die=function(t,n){return r("jQueryHW2.fn.die() is deprecated"),M?M.apply(this,arguments):(e(this.context).off(t,this.selector||"**",n),this)},e.event.trigger=function(e,t,n,a){return n||C.test(e)||r("Global events are undocumented and deprecated"),k.call(this,e,t,n||document,a)},e.each(S.split("|"),function(t,n){e.event.special[n]={setup:function(){var t=this;return t!==document&&(e.event.add(document,n+"."+e.guid,function(){e.event.trigger(n,null,t,!0)}),e._data(this,n,e.guid++)),!1},teardown:function(){return this!==document&&e.event.remove(document,n+"."+e._data(this,n)),!1}}})}(jQueryHW2,window);
\ No newline at end of file
diff --git a/docs/css/api-ref/public_sys-resources/jquery-ui.min.js b/docs/css/api-ref/public_sys-resources/jquery-ui.min.js
new file mode 100644
index 000000000..5a2c95bdd
--- /dev/null
+++ b/docs/css/api-ref/public_sys-resources/jquery-ui.min.js
@@ -0,0 +1,6 @@
+/*! jQuery UI - v1.13.0 - 2021-10-07
+* http://jqueryui.com
+* Includes: widget.js, position.js, data.js, disable-selection.js, effect.js, effects/effect-blind.js, effects/effect-bounce.js, effects/effect-clip.js, effects/effect-drop.js, effects/effect-explode.js, effects/effect-fade.js, effects/effect-fold.js, effects/effect-highlight.js, effects/effect-puff.js, effects/effect-pulsate.js, effects/effect-scale.js, effects/effect-shake.js, effects/effect-size.js, effects/effect-slide.js, effects/effect-transfer.js, focusable.js, form-reset-mixin.js, jquery-patch.js, keycode.js, labels.js, scroll-parent.js, tabbable.js, unique-id.js, widgets/accordion.js, widgets/autocomplete.js, widgets/button.js, widgets/checkboxradio.js, widgets/controlgroup.js, widgets/datepicker.js, widgets/dialog.js, widgets/draggable.js, widgets/droppable.js, widgets/menu.js, widgets/mouse.js, widgets/progressbar.js, widgets/resizable.js, widgets/selectable.js, widgets/selectmenu.js, widgets/slider.js, widgets/sortable.js, widgets/spinner.js, widgets/tabs.js, widgets/tooltip.js
+* Copyright jQuery Foundation and other contributors; Licensed MIT */
+
+!function(t){"use strict";"function"==typeof define&&define.amd?define(["jquery"],t):t(jQuery)}(function(V){"use strict";V.ui=V.ui||{};V.ui.version="1.13.0";var n,i=0,a=Array.prototype.hasOwnProperty,r=Array.prototype.slice;V.cleanData=(n=V.cleanData,function(t){for(var e,i,s=0;null!=(i=t[s]);s++)(e=V._data(i,"events"))&&e.remove&&V(i).triggerHandler("remove");n(t)}),V.widget=function(t,i,e){var s,n,o,a={},r=t.split(".")[0],l=r+"-"+(t=t.split(".")[1]);return e||(e=i,i=V.Widget),Array.isArray(e)&&(e=V.extend.apply(null,[{}].concat(e))),V.expr.pseudos[l.toLowerCase()]=function(t){return!!V.data(t,l)},V[r]=V[r]||{},s=V[r][t],n=V[r][t]=function(t,e){if(!this._createWidget)return new n(t,e);arguments.length&&this._createWidget(t,e)},V.extend(n,s,{version:e.version,_proto:V.extend({},e),_childConstructors:[]}),(o=new i).options=V.widget.extend({},o.options),V.each(e,function(e,s){function n(){return i.prototype[e].apply(this,arguments)}function o(t){return i.prototype[e].apply(this,t)}a[e]="function"==typeof s?function(){var t,e=this._super,i=this._superApply;return this._super=n,this._superApply=o,t=s.apply(this,arguments),this._super=e,this._superApply=i,t}:s}),n.prototype=V.widget.extend(o,{widgetEventPrefix:s&&o.widgetEventPrefix||t},a,{constructor:n,namespace:r,widgetName:t,widgetFullName:l}),s?(V.each(s._childConstructors,function(t,e){var i=e.prototype;V.widget(i.namespace+"."+i.widgetName,n,e._proto)}),delete s._childConstructors):i._childConstructors.push(n),V.widget.bridge(t,n),n},V.widget.extend=function(t){for(var e,i,s=r.call(arguments,1),n=0,o=s.length;n",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=V(e||this.defaultElement||this)[0],this.element=V(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=V(),this.hoverable=V(),this.focusable=V(),this.classesElementLookup={},e!==this&&(V.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=V(e.style?e.ownerDocument:e.document||e),this.window=V(this.document[0].defaultView||this.document[0].parentWindow)),this.options=V.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:V.noop,_create:V.noop,_init:V.noop,destroy:function(){var i=this;this._destroy(),V.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:V.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return V.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=V.widget.extend({},this.options[t]),n=0;n
