forked from docs/doc-exports
Zheng, Xiu
3fa966049f
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
902 lines
34 KiB
JSON
902 lines
34 KiB
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, 7.9.3, and 7.10.2 are supported. OpenSearch 1.3.6 and 2.11.0 are supported. Kibana 7.6.2, 7.9.3, and 7.10.2 are supported.",
|
|
"product_code":"css",
|
|
"title":"Supported Cluster Versions",
|
|
"uri":"css_03_0056.html",
|
|
"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":"css_03_0137.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":"css_03_0138.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":"css_03_0139.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":"css_03_0140.html",
|
|
"doc_type":"api",
|
|
"p_code":"6",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"desc":"This section describes how to create a CSS cluster by using APIs. Figure 1 illustrates the API calling process.The token obtained on IAM is valid for only 24 hours. If yo",
|
|
"product_code":"css",
|
|
"title":"Getting Started",
|
|
"uri":"css_03_0062.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"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":"11"
|
|
},
|
|
{
|
|
"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":"11",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"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":"11",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"This API is used to query and display details about a cluster.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster_i",
|
|
"product_code":"css",
|
|
"title":"Querying Cluster Details",
|
|
"uri":"ShowClusterDetail.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the name of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameNoneNone",
|
|
"product_code":"css",
|
|
"title":"Changing a Cluster Name",
|
|
"uri":"css_03_0084.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"This API is used to restart a cluster. Restarting the cluster will interrupt ongoing services.NoneNoneNoneTable 2 describes the status code.",
|
|
"product_code":"css",
|
|
"title":"Restarting a Cluster",
|
|
"uri":"css_03_0021.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"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":"11",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the password of a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneChange the administrato",
|
|
"product_code":"css",
|
|
"title":"Changing a Password",
|
|
"uri":"ResetPassword.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the specifications of a cluster. Only the specifications of ESS nodes can be modified.You can debug this API in . Automatic authentication is s",
|
|
"product_code":"css",
|
|
"title":"Modifying Cluster Specifications",
|
|
"uri":"css_03_0086.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the specifications of a specified node type. The following node types are supported:ess: data nodeess-cold: cold data nodeess-client: client no",
|
|
"product_code":"css",
|
|
"title":"Changing the Specifications of a Specified Node Type",
|
|
"uri":"css_03_0087.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"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":"11",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"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":"11",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"This API is used to scale in a cluster by removing specified nodes. Yearly/Monthly clusters do not support the removal of specified nodes by calling this API.You can debu",
|
|
"product_code":"css",
|
|
"title":"Scaling in a Cluster By Removing Specified Nodes",
|
|
"uri":"css_03_0088.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"This API is used to remove instances of specific types and reduce instance storage capacity in a cluster.You can debug this API in . Automatic authentication is supported",
|
|
"product_code":"css",
|
|
"title":"Removing Nodes of a Specific Type",
|
|
"uri":"css_03_0089.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"24"
|
|
},
|
|
{
|
|
"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":"ListFlavors.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"This API is used to download the HTTPS certificate of the server.NoneExample requestExample responseAfter obtaining the preceding character string, run the following comm",
|
|
"product_code":"css",
|
|
"title":"Downloading the Certificate",
|
|
"uri":"css_03_0050.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"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":"11",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"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":"27",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"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":"27",
|
|
"code":"29"
|
|
},
|
|
{
|
|
"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":"27",
|
|
"code":"30"
|
|
},
|
|
{
|
|
"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":"27",
|
|
"code":"31"
|
|
},
|
|
{
|
|
"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":"27",
|
|
"code":"32"
|
|
},
|
|
{
|
|
"desc":"This API is used to replace a failed node.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instanc",
|
|
"product_code":"css",
|
|
"title":"Replacing a Node",
|
|
"uri":"css_03_0090.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"33"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the security mode of a cluster.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/",
|
|
"product_code":"css",
|
|
"title":"Changing the Security Mode",
|
|
"uri":"css_03_0091.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"34"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the security group after a cluster is created.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/cluster",
|
|
"product_code":"css",
|
|
"title":"Changing the Security Group",
|
|
"uri":"css_03_0092.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"35"
|
|
},
|
|
{
|
|
"desc":"This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{c",
|
|
"product_code":"css",
|
|
"title":"Upgrading a Cluster Kernel",
|
|
"uri":"UpgradeCore.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"36"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the ID of an image that can be upgraded in the current cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/targe",
|
|
"product_code":"css",
|
|
"title":"Obtaining a Target Image ID",
|
|
"uri":"ListImages.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"37"
|
|
},
|
|
{
|
|
"desc":"The upgrade takes a long time. You can call this API to check the upgrade progress on a node.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/up",
|
|
"product_code":"css",
|
|
"title":"Obtaining Upgrade Details",
|
|
"uri":"UpgradeDetail.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"38"
|
|
},
|
|
{
|
|
"desc":"The upgrade takes a long time and the upgrade may fail due to network problems. You can use this API to retry a task or terminate the impact of a task.For details, see Ca",
|
|
"product_code":"css",
|
|
"title":"Retrying a Failed Upgrade Task",
|
|
"uri":"RetryUpgradeTask.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"39"
|
|
},
|
|
{
|
|
"desc":"This API is used to add master and client nodes to a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independentStatus cod",
|
|
"product_code":"css",
|
|
"title":"Adding Master and Client Nodes",
|
|
"uri":"AddIndependentNode.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"40"
|
|
},
|
|
{
|
|
"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":"Kibana Public Network Access",
|
|
"uri":"css_03_0119.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"41"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable Kibana public network access.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/pu",
|
|
"product_code":"css",
|
|
"title":"Enabling Kibana Public Access",
|
|
"uri":"css_03_0120.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"42"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable Kibana public network access.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/pu",
|
|
"product_code":"css",
|
|
"title":"Disabling Kibana Public Access",
|
|
"uri":"css_03_0121.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"43"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the Kibana public network bandwidth.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster",
|
|
"product_code":"css",
|
|
"title":"Modifying the Kibana Public Network Bandwidth",
|
|
"uri":"css_03_0122.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"44"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the Kibana public network access whitelist.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{",
|
|
"product_code":"css",
|
|
"title":"Modifying Kibana Public Access Control",
|
|
"uri":"css_03_0123.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"45"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the Kibana public network access control.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cl",
|
|
"product_code":"css",
|
|
"title":"Disabling Kibana Public Network Access Control",
|
|
"uri":"css_03_0124.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"46"
|
|
},
|
|
{
|
|
"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":"Log Management",
|
|
"uri":"css_03_0093.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"47"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable the log function.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/openNoneN",
|
|
"product_code":"css",
|
|
"title":"Enabling the Log Function",
|
|
"uri":"css_03_0094.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"48"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the log function.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/closeNone",
|
|
"product_code":"css",
|
|
"title":"Disabling the Log Function",
|
|
"uri":"css_03_0095.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"49"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the job list in the logs of a cluster.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster",
|
|
"product_code":"css",
|
|
"title":"Viewing the Job List",
|
|
"uri":"css_03_0096.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"50"
|
|
},
|
|
{
|
|
"desc":"This API is used to query basic log configurations.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/set",
|
|
"product_code":"css",
|
|
"title":"Querying Basic Log Configurations",
|
|
"uri":"css_03_0097.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"51"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify basic log configurations.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/s",
|
|
"product_code":"css",
|
|
"title":"Modifying Basic Log Configurations",
|
|
"uri":"css_03_0098.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"52"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable the automatic log backup policy.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}",
|
|
"product_code":"css",
|
|
"title":"Enabling the Automatic Log Backup Policy",
|
|
"uri":"css_03_0099.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"53"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the automatic log backup policy.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}",
|
|
"product_code":"css",
|
|
"title":"Disabling the Automatic Log Backup Policy",
|
|
"uri":"css_03_0100.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"54"
|
|
},
|
|
{
|
|
"desc":"This API is used to back up logs.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collectNoneNoneNoneN",
|
|
"product_code":"css",
|
|
"title":"Backing Up Logs",
|
|
"uri":"css_03_0101.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"55"
|
|
},
|
|
{
|
|
"desc":"This API is used to query log information.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/searchStatu",
|
|
"product_code":"css",
|
|
"title":"Querying Logs",
|
|
"uri":"css_03_0102.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"56"
|
|
},
|
|
{
|
|
"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":"Public Network Access",
|
|
"uri":"css_03_0103.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"57"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable public network access.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/public/op",
|
|
"product_code":"css",
|
|
"title":"Enabling Public Network Access",
|
|
"uri":"css_03_0104.html",
|
|
"doc_type":"api",
|
|
"p_code":"57",
|
|
"code":"58"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable public network access.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/cl",
|
|
"product_code":"css",
|
|
"title":"Disabling Public Network Access",
|
|
"uri":"css_03_0105.html",
|
|
"doc_type":"api",
|
|
"p_code":"57",
|
|
"code":"59"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the public network access bandwidth.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster",
|
|
"product_code":"css",
|
|
"title":"Modifying Public Network Access Bandwidth",
|
|
"uri":"css_03_0106.html",
|
|
"doc_type":"api",
|
|
"p_code":"57",
|
|
"code":"60"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable the public network access whitelist.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster",
|
|
"product_code":"css",
|
|
"title":"Enabling the Public Network Access Whitelist",
|
|
"uri":"css_03_0107.html",
|
|
"doc_type":"api",
|
|
"p_code":"57",
|
|
"code":"61"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the public network access whitelist.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster",
|
|
"product_code":"css",
|
|
"title":"Disabling the Public Network Access Whitelist",
|
|
"uri":"css_03_0108.html",
|
|
"doc_type":"api",
|
|
"p_code":"57",
|
|
"code":"62"
|
|
},
|
|
{
|
|
"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":"63"
|
|
},
|
|
{
|
|
"desc":"The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapshots. If you have multiple clusters, an OBS bu",
|
|
"product_code":"css",
|
|
"title":"(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot",
|
|
"uri":"css_03_0037.html",
|
|
"doc_type":"api",
|
|
"p_code":"63",
|
|
"code":"64"
|
|
},
|
|
{
|
|
"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":"63",
|
|
"code":"65"
|
|
},
|
|
{
|
|
"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":"63",
|
|
"code":"66"
|
|
},
|
|
{
|
|
"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":"63",
|
|
"code":"67"
|
|
},
|
|
{
|
|
"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":"63",
|
|
"code":"68"
|
|
},
|
|
{
|
|
"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":"63",
|
|
"code":"69"
|
|
},
|
|
{
|
|
"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":"63",
|
|
"code":"70"
|
|
},
|
|
{
|
|
"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":"63",
|
|
"code":"71"
|
|
},
|
|
{
|
|
"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":"63",
|
|
"code":"72"
|
|
},
|
|
{
|
|
"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":"VPC Endpoint",
|
|
"uri":"css_03_0109.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"73"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable the VPC endpoint service.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/vpceps",
|
|
"product_code":"css",
|
|
"title":"Enabling the VPC Endpoint Service",
|
|
"uri":"css_03_0110.html",
|
|
"doc_type":"api",
|
|
"p_code":"73",
|
|
"code":"74"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the VPC endpoint service.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpceps",
|
|
"product_code":"css",
|
|
"title":"Disabling the VPC Endpoint Service",
|
|
"uri":"css_03_0111.html",
|
|
"doc_type":"api",
|
|
"p_code":"73",
|
|
"code":"75"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain a VPC endpoint connection.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster_id}/vpceps",
|
|
"product_code":"css",
|
|
"title":"Obtaining a VPC Endpoint Connection",
|
|
"uri":"css_03_0112.html",
|
|
"doc_type":"api",
|
|
"p_code":"73",
|
|
"code":"76"
|
|
},
|
|
{
|
|
"desc":"This API is used to update a VPC endpoint connection.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcep",
|
|
"product_code":"css",
|
|
"title":"Updating a VPC Endpoint Connection",
|
|
"uri":"css_03_0113.html",
|
|
"doc_type":"api",
|
|
"p_code":"73",
|
|
"code":"77"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the endpoint service whitelist.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/",
|
|
"product_code":"css",
|
|
"title":"Modifying the Endpoint Service Whitelist",
|
|
"uri":"css_03_0114.html",
|
|
"doc_type":"api",
|
|
"p_code":"73",
|
|
"code":"78"
|
|
},
|
|
{
|
|
"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":"Parameter Configuration",
|
|
"uri":"css_03_0115.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"79"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify parameter configurations.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/u",
|
|
"product_code":"css",
|
|
"title":"Modifying Parameter Configurations",
|
|
"uri":"css_03_0116.html",
|
|
"doc_type":"api",
|
|
"p_code":"79",
|
|
"code":"80"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the task list of parameter configurations.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cl",
|
|
"product_code":"css",
|
|
"title":"Obtaining the Task List of Parameter Configurations",
|
|
"uri":"css_03_0117.html",
|
|
"doc_type":"api",
|
|
"p_code":"79",
|
|
"code":"81"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the parameter configuration list of the current cluster.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id",
|
|
"product_code":"css",
|
|
"title":"Obtaining the Parameter Configuration List",
|
|
"uri":"css_03_0118.html",
|
|
"doc_type":"api",
|
|
"p_code":"79",
|
|
"code":"82"
|
|
},
|
|
{
|
|
"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":"Load Balancing",
|
|
"uri":"css_03_0125.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"83"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the ELB V3 load balancers supported by a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200NoneStatus code: ",
|
|
"product_code":"css",
|
|
"title":"Querying ELB V3 Load Balancer Supported by a Cluster",
|
|
"uri":"css_03_0126.html",
|
|
"doc_type":"api",
|
|
"p_code":"83",
|
|
"code":"84"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable or disable the ES load balancer.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStatus code: 200Enable the load balancer.N",
|
|
"product_code":"css",
|
|
"title":"Enabling or Disabling the ES Load Balancer",
|
|
"uri":"css_03_0127.html",
|
|
"doc_type":"api",
|
|
"p_code":"83",
|
|
"code":"85"
|
|
},
|
|
{
|
|
"desc":"This API is used to configure the ES listener.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: 200Status code: 200The request is processed.See Error",
|
|
"product_code":"css",
|
|
"title":"Configuring the ES Listener",
|
|
"uri":"css_03_0128.html",
|
|
"doc_type":"api",
|
|
"p_code":"83",
|
|
"code":"86"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the ES ELB information and health check status.GET /v1.0/{project_id}/clusters/{cluster_id}/es-listenersNoneStatus code: 200NoneStatus code: 20",
|
|
"product_code":"css",
|
|
"title":"Obtaining the ELB Information and Health Check Status",
|
|
"uri":"css_03_0129.html",
|
|
"doc_type":"api",
|
|
"p_code":"83",
|
|
"code":"87"
|
|
},
|
|
{
|
|
"desc":"This API is used to update an ES listener.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Status code: 200NoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Updating an ES Listener",
|
|
"uri":"css_03_0130.html",
|
|
"doc_type":"api",
|
|
"p_code":"83",
|
|
"code":"88"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the certificate list.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200NoneStatus code: 200The request is process",
|
|
"product_code":"css",
|
|
"title":"Querying the Certificate List",
|
|
"uri":"css_03_0131.html",
|
|
"doc_type":"api",
|
|
"p_code":"83",
|
|
"code":"89"
|
|
},
|
|
{
|
|
"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":"Intelligent O&M",
|
|
"uri":"css_03_0132.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"90"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a cluster detection task.POST /v1.0/{project_id}/clusters/{cluster_id}/ai-opsNoneCreate a cluster detection task.NoneFor details, see Error Cod",
|
|
"product_code":"css",
|
|
"title":"Creating a Cluster Detection Task",
|
|
"uri":"css_03_0133.html",
|
|
"doc_type":"api",
|
|
"p_code":"90",
|
|
"code":"91"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the intelligent O&M task list and details.GET /v1.0/{project_id}/clusters/{cluster_id}/ai-opsNoneStatus code: 200Obtain the intelligent O&M tas",
|
|
"product_code":"css",
|
|
"title":"Obtaining the Intelligent O&M Task List and Details",
|
|
"uri":"css_03_0134.html",
|
|
"doc_type":"api",
|
|
"p_code":"90",
|
|
"code":"92"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a detection task record.DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}NoneNoneDelete a detection task record.NoneFor details",
|
|
"product_code":"css",
|
|
"title":"Deleting a Detection Task Record",
|
|
"uri":"css_03_0135.html",
|
|
"doc_type":"api",
|
|
"p_code":"90",
|
|
"code":"93"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain SMN topics available for intelligent O&M alarms.GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topicsNoneStatus code: 200Obtain the inte",
|
|
"product_code":"css",
|
|
"title":"Obtaining SMN Topics Available for Intelligent O&M Alarms",
|
|
"uri":"css_03_0136.html",
|
|
"doc_type":"api",
|
|
"p_code":"90",
|
|
"code":"94"
|
|
},
|
|
{
|
|
"desc":"This section describes fine-grained permissions management for your CSS. If your cloud account does not need individual IAM users, then you may skip over this chapter.By ",
|
|
"product_code":"css",
|
|
"title":"Permissions Policies and Supported Actions",
|
|
"uri":"css_03_0065.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"95"
|
|
},
|
|
{
|
|
"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":"96"
|
|
},
|
|
{
|
|
"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":"96",
|
|
"code":"97"
|
|
},
|
|
{
|
|
"desc":"Table 1 describes the status code.",
|
|
"product_code":"css",
|
|
"title":"Status Code",
|
|
"uri":"css_03_0075.html",
|
|
"doc_type":"api",
|
|
"p_code":"96",
|
|
"code":"98"
|
|
},
|
|
{
|
|
"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":"96",
|
|
"code":"99"
|
|
},
|
|
{
|
|
"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":"100"
|
|
}
|
|
] |