doc-exports/docs/css/api-ref/CLASS.TXT.json

[
	{
		"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"
	}
]