forked from docs/doc-exports
zhengxiu
6093788563
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: zhengxiu <zhengxiu@huawei.com> Co-committed-by: zhengxiu <zhengxiu@huawei.com>
902 lines
34 KiB
JSON
902 lines
34 KiB
JSON
[
|
|
{
|
|
"desc":"Welcome to Cloud Search Service (CSS) API Reference. CSS is a fully managed, distributed search service that enables you to perform quick, real-time search on both struct",
|
|
"product_code":"css",
|
|
"title":"Before You Start",
|
|
"uri":"css_03_0001.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"1"
|
|
},
|
|
{
|
|
"desc":"CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 1 by calling the corresponding APIs.",
|
|
"product_code":"css",
|
|
"title":"API Overview",
|
|
"uri":"css_03_0057.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"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_0077.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"3"
|
|
},
|
|
{
|
|
"desc":"This section describes the structure of a RESTful API request, and uses the IAM API for obtain a user token as an example to describe how to call an API.A request URI is ",
|
|
"product_code":"css",
|
|
"title":"Making an API Request",
|
|
"uri":"css_03_0078.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"4"
|
|
},
|
|
{
|
|
"desc":"You can use either of the following authentication methods when calling APIs:AK/SK-based authentication: Requests are encrypted using AK/SK pairs.Token authentication: Re",
|
|
"product_code":"css",
|
|
"title":"Authentication",
|
|
"uri":"css_03_0079.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"5"
|
|
},
|
|
{
|
|
"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_0080.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"6"
|
|
},
|
|
{
|
|
"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":"APIs",
|
|
"uri":"css_03_0097.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"7"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"cluster_management.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"8"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a cluster.POST /v1.0/{project_id}/clustersStatus code: 200Example request for creating a pay-per-use cluster.Status code: 200Request succeeded.",
|
|
"product_code":"css",
|
|
"title":"Creating a cluster",
|
|
"uri":"CreateCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"desc":"This API is used to query and display the cluster list and cluster status.GET /v1.0/{project_id}/clustersNoneStatus code: 200Query the first two clusters.- Method 1: GET ",
|
|
"product_code":"css",
|
|
"title":"Querying the Cluster List",
|
|
"uri":"ListClustersDetails.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"desc":"This API is used to query and display the details of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}NoneStatus code: 200NoneStatus code: 200Request succeeded.See E",
|
|
"product_code":"css",
|
|
"title":"Querying Cluster Details",
|
|
"uri":"ShowClusterDetail.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"11"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluste",
|
|
"product_code":"css",
|
|
"title":"Deleting a Cluster",
|
|
"uri":"DeleteCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the name of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameNoneChange the display name of the current cluster.NoneSee Error ",
|
|
"product_code":"css",
|
|
"title":"Renaming a Cluster",
|
|
"uri":"UpdateClusterName.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the password of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneChange the administrator password of the current clus",
|
|
"product_code":"css",
|
|
"title":"Changing the Password of a Cluster",
|
|
"uri":"ResetPassword.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"This API is used to restart a cluster. Services will be interrupted during the restart.POST /v1.0/{project_id}/clusters/{cluster_id}/restartNoneNoneNoneNoneSee Error Code",
|
|
"product_code":"css",
|
|
"title":"Restarting a Cluster",
|
|
"uri":"RestartCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters wit",
|
|
"product_code":"css",
|
|
"title":"Scaling Out a Cluster",
|
|
"uri":"UpdateExtendCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"This API is used to add instances of different types and expand instance storage capacity in a cluster. This API is available for clusters with master, client, or cold da",
|
|
"product_code":"css",
|
|
"title":"Adding Instances and Expanding Instance Storage Capacity",
|
|
"uri":"UpdateExtendInstanceStorage.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the specifications of a cluster. Only the nodes of the ESS type can be modified.POST /v1.0/{project_id}/clusters/{cluster_id}/flavorNonePOST /v",
|
|
"product_code":"css",
|
|
"title":"Changing Specifications",
|
|
"uri":"UpdateFlavor.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"desc":"This API is used to query and display the IDs of supported instance specifications.GET /v1.0/{project_id}/es-flavorsNoneStatus code: 200NoneStatus code: 200Request succee",
|
|
"product_code":"css",
|
|
"title":"Obtaining the Instance Specifications List",
|
|
"uri":"ListFlavors.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"desc":"This API is used to query all tags in a specified region.GET /v1.0/{project_id}/{resource_type}/tagsNoneStatus code: 200NoneStatus code: 200Request succeeded.See Error Co",
|
|
"product_code":"css",
|
|
"title":"Querying All Tags",
|
|
"uri":"ListClustersTags.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the tags of a specified cluster.GET /v1.0/{project_id}/{resource_type}/{cluster_id}/tagsNoneStatus code: 200NoneStatus code: 200Request succeede",
|
|
"product_code":"css",
|
|
"title":"Querying Tags of a Specified Cluster",
|
|
"uri":"ShowClusterTag.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"desc":"This API is used to add tags to a cluster.POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tagsNoneCreate a cluster tag.NoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Adding Tags to a Cluster",
|
|
"uri":"CreateClustersTags.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a cluster tag.DELETE /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/{key}NoneNoneNoneNoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Deleting a Cluster Tag",
|
|
"uri":"DeleteClustersTags.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"This API is used to add tags to or delete tags from a cluster in batches.POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/actionNoneCreate or delete cluster tags",
|
|
"product_code":"css",
|
|
"title":"Adding or Deleting Cluster Tags in Batches",
|
|
"uri":"UpdateBatchClustersTags.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"24"
|
|
},
|
|
{
|
|
"desc":"This API is used to scale in a cluster by removing a specified node.POST /v1.0/{project_id}/clusters/{cluster_id}/node/offlineNoneScale in a cluster by scaling in specifi",
|
|
"product_code":"css",
|
|
"title":"Scaling In a Cluster by Removing a Specific Node",
|
|
"uri":"UpdateShrinkNodes.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify cluster specifications. The following node types can be changed:ess: data nodeess: data nodeess-cold: cold data nodeess-cold: cold data nodeess",
|
|
"product_code":"css",
|
|
"title":"Changing the Specifications of a Specified Node Type",
|
|
"uri":"UpdateFlavorByType.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"desc":"This API is used to remove instances of different types and reduce instance storage capacity in a cluster.POST /v1.0/extend/{project_id}/clusters/{cluster_id}/role/shrink",
|
|
"product_code":"css",
|
|
"title":"Scaling In Nodes of a Specific Type",
|
|
"uri":"UpdateShrinkCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"desc":"This API is used to download a security certificate.GET /v1.0/{project_id}/cer/downloadNoneStatus code: 200NoneStatus code: 200Request succeeded.See Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Downloading a Security Certificate",
|
|
"uri":"DownloadCert.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"desc":"This API is used to replace a failed node.PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replaceNoneNoneNoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Replacing a Node",
|
|
"uri":"UpdateInstance.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"29"
|
|
},
|
|
{
|
|
"desc":"This API is used to configure the security mode of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/mode/changeNoneChange the security mode of the current cluster.",
|
|
"product_code":"css",
|
|
"title":"Configuring the Security Mode.",
|
|
"uri":"ChangeMode.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"30"
|
|
},
|
|
{
|
|
"desc":"If you have not enabled the master or client node when creating a cluster, you can call this API to add one.POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/inde",
|
|
"product_code":"css",
|
|
"title":"Adding Independent Masters and Clients",
|
|
"uri":"AddIndependentNode.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"31"
|
|
},
|
|
{
|
|
"desc":"This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_typ",
|
|
"product_code":"css",
|
|
"title":"Upgrading a Cluster Kernel",
|
|
"uri":"UpgradeCore.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"32"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the ID of an image that can be upgraded in the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/imagesNoneSta",
|
|
"product_code":"css",
|
|
"title":"Obtaining a Target Image ID",
|
|
"uri":"ListImages.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"33"
|
|
},
|
|
{
|
|
"desc":"The upgrade takes a long time. You can call this API to check the upgrade progress on a node.GET /v1.0/{project_id}/clusters/{cluster_id}/upgrade/detailNoneStatus code: 2",
|
|
"product_code":"css",
|
|
"title":"Obtaining Upgrade Details",
|
|
"uri":"UpgradeDetail.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"34"
|
|
},
|
|
{
|
|
"desc":"The upgrade may fail due to network problems. In this case, you can call this API to retry.PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retryNoneNoneE",
|
|
"product_code":"css",
|
|
"title":"Retrying a Failed Upgrade Task",
|
|
"uri":"RetryUpgradeTask.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"35"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the security group after a cluster is created.POST /v1.0/{project_id}/clusters/{cluster_id}/sg/changeNoneChange the security group that the cur",
|
|
"product_code":"css",
|
|
"title":"Changing the Security Group",
|
|
"uri":"ChangeSecurityGroup.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"36"
|
|
},
|
|
{
|
|
"desc":"This API is used to change the AZ by specifying node types.POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/azmigrateNoneSwitch the AZ of the current c",
|
|
"product_code":"css",
|
|
"title":"Changing the AZ of a Cluster Instance",
|
|
"uri":"UpdateAzByInstanceType.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"37"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, ess-master).POST /v2.0/{project_id}/clustersStatus code: 200Example",
|
|
"product_code":"css",
|
|
"title":"Creating a Cluster (V2)",
|
|
"uri":"CreateClusterMultiRole.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"38"
|
|
},
|
|
{
|
|
"desc":"This API is used to restart nodes of all node types or the combination of some node types in the current cluster.POST /v2.0/{project_id}/clusters/{cluster_id}/restartNone",
|
|
"product_code":"css",
|
|
"title":"Restarting a Cluster (V2)",
|
|
"uri":"RestartClusterMultiRole.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"code":"39"
|
|
},
|
|
{
|
|
"desc":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.POST /v2.0/{project_id}/clusters/{cluster_id}/rolli",
|
|
"product_code":"css",
|
|
"title":"Rolling Restart",
|
|
"uri":"RollingRestart.html",
|
|
"doc_type":"api",
|
|
"p_code":"8",
|
|
"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":"kibana_public_network_access.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"41"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable public network access to Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/openNoneNoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Enabling Kibana Public Access",
|
|
"uri":"StartKibanaPublic.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"42"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable public network access to Kibana.Yearly/Monthly clusters cannot disable public access using APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/p",
|
|
"product_code":"css",
|
|
"title":"Disabling Kibana Public Access",
|
|
"uri":"UpdateCloseKibana.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"43"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the public network bandwidth of Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidthNoneModify the Kibana public network",
|
|
"product_code":"css",
|
|
"title":"Modifying the Kibana Public Network Bandwidth",
|
|
"uri":"UpdateAlterKibana.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"44"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the Kibana access permission by modifying the Kibana whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/updateNoneT",
|
|
"product_code":"css",
|
|
"title":"Modifying Kibana Public Access Control",
|
|
"uri":"UpdatePublicKibanaWhitelist.html",
|
|
"doc_type":"api",
|
|
"p_code":"41",
|
|
"code":"45"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable public network access control for Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/closeNoneNoneNoneNoneSee Error Co",
|
|
"product_code":"css",
|
|
"title":"Disabling Kibana Public Network Access Control",
|
|
"uri":"StopPublicKibanaWhitelist.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":"log_management.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"47"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable the log function.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/openNoneEnable the log function.POST /v1.0/6204a5bd270343b5885144cf9c8c158d",
|
|
"product_code":"css",
|
|
"title":"Enabling the Log Function",
|
|
"uri":"StartLogs.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"48"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the log function.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/closeNoneNoneNoneNoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Disabling the Log Function",
|
|
"uri":"StopLogs.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.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/recordsNoneStatus code: 200NoneStatus code: 200Request s",
|
|
"product_code":"css",
|
|
"title":"Querying the Job List",
|
|
"uri":"ListLogsJob.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"50"
|
|
},
|
|
{
|
|
"desc":"This API is used to query basic log configurations.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneStatus code: 200NoneStatus code: 200Request succeeded.Exa",
|
|
"product_code":"css",
|
|
"title":"Querying Basic Log Configurations",
|
|
"uri":"ShowGetLogSetting.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"51"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify basic log configurations.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneModify basic log configurations.POST /v1.0/6204a5bd2703",
|
|
"product_code":"css",
|
|
"title":"Modifying Basic Log Configurations",
|
|
"uri":"UpdateLogSetting.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"52"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable the automatic log backup policy.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/updateNoneEnable the automatic log backup policy.None",
|
|
"product_code":"css",
|
|
"title":"Enabling the Automatic Log Backup Policy",
|
|
"uri":"StartLogAutoBackupPolicy.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"53"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the automatic log backup policy.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/closeNoneNoneNoneNoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Disabling the Automatic Log Backup Policy",
|
|
"uri":"StopLogAutoBackupPolicy.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"54"
|
|
},
|
|
{
|
|
"desc":"This API is used to back up logs.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collectNoneNoneNoneNoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Backing Up Logs",
|
|
"uri":"CreateLogBackup.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"55"
|
|
},
|
|
{
|
|
"desc":"This API is used to query log information.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/searchStatus code: 200Query logs.Status code: 200Request succeeded.See Error ",
|
|
"product_code":"css",
|
|
"title":"Searching for Logs",
|
|
"uri":"ShowLogBackup.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"56"
|
|
},
|
|
{
|
|
"desc":"This API is used to test connectivity.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/connectivityNoneTest connectivity to the target cluster.Status code: 200Request s",
|
|
"product_code":"css",
|
|
"title":"Test connectivity.",
|
|
"uri":"StartTargetClusterConnectivityTest.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"57"
|
|
},
|
|
{
|
|
"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":"public_network_access.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"58"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable public network access.POST /v1.0/{project_id}/clusters/{cluster_id}/public/openStatus code: 200Status code: 200Request succeeded.See Error Code",
|
|
"product_code":"css",
|
|
"title":"Enabling Public Network Access",
|
|
"uri":"CreateBindPublic.html",
|
|
"doc_type":"api",
|
|
"p_code":"58",
|
|
"code":"59"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable public network access to Kibana.Yearly/Monthly clusters cannot disable Kibana public access using APIs.PUT /v1.0/{project_id}/clusters/{cluste",
|
|
"product_code":"css",
|
|
"title":"Disabling Public Network Access",
|
|
"uri":"UpdateUnbindPublic.html",
|
|
"doc_type":"api",
|
|
"p_code":"58",
|
|
"code":"60"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the public network access bandwidth.POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidthNoneModify public network access bandwidth.No",
|
|
"product_code":"css",
|
|
"title":"Modifying Public Network Access Bandwidth",
|
|
"uri":"UpdatePublicBandWidth.html",
|
|
"doc_type":"api",
|
|
"p_code":"58",
|
|
"code":"61"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable the public network access control whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/updateNoneEnable the public network ",
|
|
"product_code":"css",
|
|
"title":"Enabling the Public Network Access Control Whitelist",
|
|
"uri":"StartPublicWhitelist.html",
|
|
"doc_type":"api",
|
|
"p_code":"58",
|
|
"code":"62"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the public network access control whitelist.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/closeNoneNoneNoneNoneSee Error Codes",
|
|
"product_code":"css",
|
|
"title":"Disabling the Public Network Access Control Whitelist",
|
|
"uri":"StopPublicWhitelist.html",
|
|
"doc_type":"api",
|
|
"p_code":"58",
|
|
"code":"63"
|
|
},
|
|
{
|
|
"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",
|
|
"uri":"snapshot_management.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"64"
|
|
},
|
|
{
|
|
"desc":"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 ",
|
|
"product_code":"css",
|
|
"title":"(Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot",
|
|
"uri":"StartAutoSetting.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"65"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.You can also use this API to enable the snapshot function",
|
|
"product_code":"css",
|
|
"title":"Modifying Basic Configurations of a Cluster Snapshot",
|
|
"uri":"UpdateSnapshotSetting.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"66"
|
|
},
|
|
{
|
|
"desc":"This API is used to manually create a snapshot.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotStatus code: 201Create a snapshot.Status code: 201Resource crea",
|
|
"product_code":"css",
|
|
"title":"Manually Creating a Snapshot",
|
|
"uri":"CreateSnapshot.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"67"
|
|
},
|
|
{
|
|
"desc":"This API is used to manually restore a snapshot.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restoreNoneRestore a snapshot.NoneSee Error Cod",
|
|
"product_code":"css",
|
|
"title":"Restoring a Snapshot",
|
|
"uri":"RestoreSnapshot.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"68"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a snapshot.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}NoneNoneNoneNoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Deleting a Snapshot",
|
|
"uri":"DeleteSnapshot.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"69"
|
|
},
|
|
{
|
|
"desc":"This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy",
|
|
"product_code":"css",
|
|
"title":"Configuring the Automatic Snapshot Creation Policy",
|
|
"uri":"CreateAutoCreatePolicy.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"70"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the automatic snapshot creation policy.GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policyNoneStatus code: 200NoneStatus code: 20",
|
|
"product_code":"css",
|
|
"title":"Querying the Automatic Snapshot Creation Policy",
|
|
"uri":"ShowAutoCreatePolicy.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"71"
|
|
},
|
|
{
|
|
"desc":"This API is used to query all the snapshots of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneStatus code: 200NoneStatus code: 200Request succe",
|
|
"product_code":"css",
|
|
"title":"Querying a Snapshot List",
|
|
"uri":"ListSnapshots.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"72"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the snapshot function.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneNoneNoneNoneSee Error Codes.",
|
|
"product_code":"css",
|
|
"title":"Disabling the Snapshot Function",
|
|
"uri":"StopSnapshot.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"73"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable the automatic snapshot creation function.POST /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/openNoneEnable the automatic backup fun",
|
|
"product_code":"css",
|
|
"title":"Enabling Automatic Snapshot Creation",
|
|
"uri":"StartAutoCreateSnapshots.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"74"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the automatic snapshot creation function.PUT /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/closeNoneNoneDisable the automatic back",
|
|
"product_code":"css",
|
|
"title":"Disabling Automatic Snapshot Creation",
|
|
"uri":"StopAutoCreateSnapshots.html",
|
|
"doc_type":"api",
|
|
"p_code":"64",
|
|
"code":"75"
|
|
},
|
|
{
|
|
"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":"vpecp_management.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"76"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable the VPC endpoint service.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/openStatus code: 200Enable the VPC endpoint service.Status ",
|
|
"product_code":"css",
|
|
"title":"Enabling the VPC Endpoint Service",
|
|
"uri":"StartVpecp.html",
|
|
"doc_type":"api",
|
|
"p_code":"76",
|
|
"code":"77"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable the VPC endpoint service.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/closeNoneStatus code: 200NoneStatus code: 200Request succee",
|
|
"product_code":"css",
|
|
"title":"Disabling the VPC Endpoint Service",
|
|
"uri":"StopVpecp.html",
|
|
"doc_type":"api",
|
|
"p_code":"76",
|
|
"code":"78"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain a VPC endpoint connection.GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneStatus code: 200NoneStatus code: 200Request ",
|
|
"product_code":"css",
|
|
"title":"Obtaining an Endpoint Connection",
|
|
"uri":"ShowVpcepConnection.html",
|
|
"doc_type":"api",
|
|
"p_code":"76",
|
|
"code":"79"
|
|
},
|
|
{
|
|
"desc":"This API is used to update an endpoint connection.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneUpdate an endpoint connection.NoneSee Error Co",
|
|
"product_code":"css",
|
|
"title":"Updating an Endpoint Connection",
|
|
"uri":"UpdateVpcepConnection.html",
|
|
"doc_type":"api",
|
|
"p_code":"76",
|
|
"code":"80"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the endpoint service whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissionsNoneModify the endpoint service whitelist.",
|
|
"product_code":"css",
|
|
"title":"Modifying the Endpoint Service Whitelist",
|
|
"uri":"UpdateVpcepWhitelist.html",
|
|
"doc_type":"api",
|
|
"p_code":"76",
|
|
"code":"81"
|
|
},
|
|
{
|
|
"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":"ymls_management.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"82"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify the parameter settings of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/updateStatus code: 200Modify parameter settings.Status c",
|
|
"product_code":"css",
|
|
"title":"Modifying Cluster Parameters",
|
|
"uri":"UpdateYmls.html",
|
|
"doc_type":"api",
|
|
"p_code":"82",
|
|
"code":"83"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the parameter configuration task list of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblistsNoneStatus code: 200NoneStatus cod",
|
|
"product_code":"css",
|
|
"title":"Obtaining the Task List of Parameter Configurations",
|
|
"uri":"ListYmlsJob.html",
|
|
"doc_type":"api",
|
|
"p_code":"82",
|
|
"code":"84"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the parameter configuration list of the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/templateNoneStatus code: 200NoneStatu",
|
|
"product_code":"css",
|
|
"title":"Obtaining the Parameter Configuration List",
|
|
"uri":"ListYmls.html",
|
|
"doc_type":"api",
|
|
"p_code":"82",
|
|
"code":"85"
|
|
},
|
|
{
|
|
"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":"topic_300000010.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"86"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the ELBv3 load balancers supported by a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200NoneStatus code: 2",
|
|
"product_code":"css",
|
|
"title":"Querying ELBv3 Load Balancers Supported by a Cluster",
|
|
"uri":"ListElbs.html",
|
|
"doc_type":"api",
|
|
"p_code":"86",
|
|
"code":"87"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable or disable the Elasticsearch load balancer.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStatus code: 200Enable the load",
|
|
"product_code":"css",
|
|
"title":"Enabling or Disabling the Elasticsearch Load Balancer",
|
|
"uri":"EnableOrDisableElb.html",
|
|
"doc_type":"api",
|
|
"p_code":"86",
|
|
"code":"88"
|
|
},
|
|
{
|
|
"desc":"This API is used to configure the Elasticsearch listener.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: 200Status code: 200Request succeeded.See E",
|
|
"product_code":"css",
|
|
"title":"Configuring the Elasticsearch Listener",
|
|
"uri":"CreateElbListener.html",
|
|
"doc_type":"api",
|
|
"p_code":"86",
|
|
"code":"89"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the ELB information and health check status of an Elasticsearch cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/es-listenersNoneStatus cod",
|
|
"product_code":"css",
|
|
"title":"Obtaining the ES ELB Information and Displaying the Health Check Status",
|
|
"uri":"ShowElbDetail.html",
|
|
"doc_type":"api",
|
|
"p_code":"86",
|
|
"code":"90"
|
|
},
|
|
{
|
|
"desc":"This API is used to update an Elasticsearch listener.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Status code: 200Status code: 200Request succee",
|
|
"product_code":"css",
|
|
"title":"Updating an Elasticsearch Listener",
|
|
"uri":"UpdateESListener.html",
|
|
"doc_type":"api",
|
|
"p_code":"86",
|
|
"code":"91"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the certificate list.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200NoneStatus code: 200Request succeeded.See ",
|
|
"product_code":"css",
|
|
"title":"Querying the Certificate List",
|
|
"uri":"ListElbCerts.html",
|
|
"doc_type":"api",
|
|
"p_code":"86",
|
|
"code":"92"
|
|
},
|
|
{
|
|
"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":"Examples",
|
|
"uri":"en-us_topic_0000002083557490.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"93"
|
|
},
|
|
{
|
|
"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":"Creating a Pay-per-Use Elasticsearch Cluster",
|
|
"uri":"css_03_0062.html",
|
|
"doc_type":"api",
|
|
"p_code":"93",
|
|
"code":"94"
|
|
},
|
|
{
|
|
"desc":"This section describes fine-grained permissions management for your CSS. If your account does not need individual IAM users, then you may skip over this chapter.By defaul",
|
|
"product_code":"css",
|
|
"title":"Permissions 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":"Appendixes",
|
|
"uri":"css_03_0040.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"96"
|
|
},
|
|
{
|
|
"desc":"Table 1 describes the status codes.",
|
|
"product_code":"css",
|
|
"title":"Status Codes",
|
|
"uri":"css_03_0075.html",
|
|
"doc_type":"api",
|
|
"p_code":"96",
|
|
"code":"97"
|
|
},
|
|
{
|
|
"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":"Error Codes",
|
|
"uri":"css_03_0076.html",
|
|
"doc_type":"api",
|
|
"p_code":"96",
|
|
"code":"98"
|
|
},
|
|
{
|
|
"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":"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"
|
|
}
|
|
] |