检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API API概览 如何使用API接口创建集群 创建集群接口 自动创建集群快照接口 SDK SDK参考 常见问题 了解更多常见问题、案例和解决方案 热门案例 云搜索服务如何保证数据和业务运行安全 集群不可用排查指导 云搜索服务有哪些存储选项 申请的集群节点磁盘空间会有哪些开销 Elasticsearch
修改Kibana公网访问控制 功能介绍 该接口通过修改kibana白名单,修改kibana的访问权限。 调用方法 请参见如何调用API。
获取终端节点连接 功能介绍 该接口用于获取集群的终端节点连接。 调用方法 请参见如何调用API。
获取集群的负载均衡器信息 功能介绍 该接口用于获取集群的负载均衡器信息。 调用方法 请参见如何调用API。
获取参数配置任务列表 功能介绍 该接口可获取集群参数配置的任务操作列表。 调用方法 请参见如何调用API。
开启公网访问控制白名单 功能介绍 该接口用于开启公网访问控制白名单。 调用方法 请参见如何调用API。
父主题: 集群管理接口
为集群打开或关闭负载均衡器 功能介绍 该接口为集群打开或关闭负载均衡器 调用方法 请参见如何调用API。
自动设置集群快照接口将会自动创建快照OBS桶和委托。如果有多个集群,每个集群使用这个接口都会创建一个不一样的OBS桶,可能会导致OBS的配额不够,较多的OBS桶也难以维护。建议可以直接使用修改集群快照的基础配置。 调用方法 请参见如何调用API。
应用示例 创建一个按需收费的Elasticsearch集群
修改集群的终端节点服务白名单 功能介绍 该接口用于修改终端节点服务白名单。 调用方法 请参见如何调用API。
调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目ID。
本文档提供了云搜索服务API的描述、语法、参数说明及样例等内容。云搜索服务提供了集群管理接口、词库管理接口和快照管理接口,通过配合使用这些接口,您可以轻松地对云搜索服务进行相关操作,如创建、查询、删除、重启、扩容集群等。
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。
状态码 状态码如表1所示。 表1 状态码说明 状态码 编码 状态码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高版本的协议。 例如,切换到
获取集群ID 在调用接口的时候,部分URL中需要填入集群ID(cluster_id),所以需要获取到集群ID。获取方法如下所示: 调用API获取集群ID 集群ID可以通过调用查询集群列表API接口获取。
在页面右上角单击用户名,在下拉列表中单击“我的凭证”,进入“API凭证”页面。 在项目列表中查看“项目ID”和“项目”(“项目”即项目名称)。 图1 查看项目ID和名称 调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目信息API获取。
涉及API 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。
在线生成SDK代码 API Explorer能根据需要动态生成SDK代码功能,降低您使用SDK的难度,推荐使用。 您可以在API Explorer中具体API页面的“代码示例”页签查看对应编程语言类型的SDK代码,如图1所示。