检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 CSS提供的接口为符合RESTful API设计规范的自研接口。通过CSS的自研接口,您可以使用CSS的如表1所示的功能。 表1 接口说明 类型 说明 集群管理接口 可以通过接口创建集群、扩容集群、查看集群详情、获取实例规格列表等。 词库管理接口 提供自定义词库功能,
参数配置接口 修改参数配置 获取参数配置任务列表 获取参数配置列表 父主题: API
终端节点接口 开启终端节点服务 关闭终端节点服务 获取终端节点连接 更新终端节点连接 修改集群的终端节点服务白名单 父主题: API
云商店开放接口指南 接口使用方法 公共参数 接口列表 公共错误码 APIGW网关错误码 开放接口示例代码 父主题: 联营License客户端软件对接指南
快照管理接口 自动设置集群快照的基础配置(不推荐使用) 修改集群快照的基础配置 手动创建快照 恢复快照 删除快照 设置自动创建快照策略 查询自动创建快照的策略 查询快照列表 停用快照功能 开启自动创建快照功能 关闭自动创建快照功能 父主题: API
云商店开放接口说明 商家发布License授权码商品时,需要先在卖家中心申请测试授权码,然后通过公网调试云商店开放接口。 商家调用激活授权码和授权码心跳检测两个接口成功后,可以在卖家中心查看测试授权码的激活状态和心跳检测状态。 父主题: 云商店开放接口描述
云商店开放接口 接口使用方法 公共参数 接口列表 父主题: SaaS类商品接入指南 V2.0(新商品上架)
对外API规范 API规范示例 为了对外API在调用时有用户信息,API调用时需要在header中传递Modifier、Creator字段。 值格式为:用户名+空格+用户id,如图1所示。
云商店开放接口描述 云商店开放接口说明 接口使用方法 公共参数 接口兼容性说明 接口列表 测试授权码激活和心跳检测 错误码 父主题: 联营License类授权码商品接入指南(2.0版本)
API 集群管理接口 词库管理接口 Kibana公网访问接口 Logstash接口 日志管理接口 公网访问接口 快照管理接口 终端节点接口 参数配置接口 负载均衡 智能运维
如何调用API 构造请求 认证鉴权 返回结果
集群管理接口 创建集群 查询集群列表 查询集群详情 删除集群 按需集群转包周期 修改集群名称 修改密码 重启集群 扩容集群 扩容实例的数量和存储容量 变更规格 获取实例规格列表 查询所有标签 查询指定集群的标签 添加指定集群标签 删除集群标签 批量添加或删除集群标签 指定节点缩容
公网访问接口 开启公网访问 关闭公网访问 修改公网访问带宽 开启公网访问控制白名单 关闭公网访问控制白名单 父主题: API
词库管理接口 加载自定义词库 查询自定义词库状态 删除自定义词库 父主题: API
开启公网访问控制白名单 功能介绍 该接口用于开启公网访问控制白名单。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/update 表1 路径参数 参数 是否必选
Kibana公网访问接口 开启Kibana公网访问 关闭Kibana公网访问 修改Kibana公网带宽 修改Kibana公网访问控制 关闭Kibana公网访问控制 父主题: API
日志管理接口 开启日志功能 关闭日志功能 查询日志备份任务列表 查询日志基础配置 修改日志基础配置 开启日志自动备份策略 关闭日志自动备份策略 备份日志 查询日志 连通性测试 父主题: API
开启公网访问 功能介绍 该接口用于开启公网访问。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/clusters/{cluster_id}/public/open 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
Logstash接口 创建配置文件 更新配置文件 启动pipeline迁移数据 停止pipeline迁移数据 添加到自定义模板 连通性测试 查询模板列表 查询配置文件列表 查询pipeline列表 查询操作记录 查询配置文件内容 删除配置文件 删除自定义模板 热启动pipeline迁移数据
修改密码 功能介绍 该接口用于修改集群密码。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
ess-master: Master节点。 lgs:Lgs节点。 在变更磁盘类型前,建议备份所有关键数据,以免造成数据丢失。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/clusters/{cluster_id}/{types}/flavor 表1
创建集群 功能介绍 该接口用于创建集群。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/clusters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID和名称。
开启日志功能 功能介绍 该接口用于开启日志功能。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/clusters/{cluster_id}/logs/open 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询日志 功能介绍 该接口用于查询日志信息。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/clusters/{cluster_id}/logs/search 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
功能介绍 此接口用于删除集群。集群删除将释放此集群的所有资源,包括客户数据。如果需要保留客户集群数据,建议在删除集群前先创建快照。 此接口亦可用于包年/包月集群退订。公安冻结的集群不能删除。删除集群时,会清理集群业务数据,请谨慎操作。 调用方法 请参见如何调用API。 URI DELETE