检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
PI的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中“auth.scope”的取值需要选择“project”,如下所示。
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 获取方法请参见获取项目ID和名称。 默认取值: 不涉及 cluster_id 是 String 参数解释: 指定待查询的集群ID。 约束限制: 不涉及 取值范围: 获取方法请参见获取集群ID。 默认取值:
如何调用API 构造请求 认证鉴权 返回结果
指定待查询的集群ID,获取方法请参见获取集群ID。 约束限制: 不涉及 取值范围: 获取方法请参见获取集群ID。 默认取值: 不涉及 cluster_id 是 String 参数解释: 指定待查询的集群ID,获取方法请参见获取集群ID。 约束限制: 不涉及 取值范围: 获取方法请参见获取集群ID。
获取集群ID 在调用接口的时候,部分URL中需要填入集群ID(cluster_id),所以需要获取到集群ID。获取方法如下所示: 调用API获取集群ID 集群ID可以通过调用查询集群列表API接口获取。 获取集群ID的接口为“GET https://{Endpoint}/v1.0
用户Token。是调用“获取用户Token”接口的响应值,该接口是唯一不需要认证的接口。请求响应成功后在响应消息头(Header)中包含的“X-Subject-Token”的值即为Token值。 X-Project-Id 否 子项目ID,在多项目场景中使用。如果云服务资源创建在子项目中
参数配置接口 可以通过参数配置接口修改集群的参数配置。 负载均衡接口 可以通过负载均衡接口打开、关闭、获取负载均衡器信息。 智能运维接口 可以通过智能运维接口创建、删除、获取检测任务。 表2 集群管理接口 API 说明 创建集群 该接口用于创建集群。 查询集群列表 该接口用于查询并显示集群列表以及集群的状态。
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 获取方法请参见获取项目ID和名称。 默认取值: 不涉及 cluster_id 是 String 参数解释: 指定查询集群ID。 约束限制: 不涉及 取值范围: 获取方法请参见获取集群ID。 默认取值:
获取集群路由 功能介绍 该接口用于获取集群路由。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/clusters/{cluster_id}/route 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
API 集群管理接口 词库管理接口 Kibana公网访问接口 Logstash接口 日志管理接口 公网访问接口 快照管理接口 终端节点接口 参数配置接口 负载均衡 智能运维
查看项目ID和名称 调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{iam-endpoint}/v3/projects”,其中{iam-endpoint}为IAM的终端节点,可以参考终端节点获取,接口的认证鉴权请参见认证鉴权。
参数配置接口 修改参数配置 获取参数配置任务列表 获取参数配置列表 父主题: API
本节通过调用云搜索服务的API创建CSS服务集群,CSS的接口调用流程如图1所示。 图1 接口调用流程 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时,需要获取用户To
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 获取方法请参见获取项目ID和名称。 默认取值: 不涉及 cluster_id 是 String 参数解释: 待升级的集群的ID。 约束限制: 不涉及 取值范围: 获取方法请参见获取集群ID。 默认取值:
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 获取方法请参见获取项目ID和名称。 默认取值: 不涉及 cluster_id 是 String 参数解释: 待升级的集群的ID。 约束限制: 不涉及 取值范围: 获取方法请参见获取集群ID。 默认取值:
获取智能运维任务列表及详情 功能介绍 该接口用于获取智能运维任务列表及详情。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/clusters/{cluster_id}/ai-ops 表1 路径参数 参数 是否必选 参数类型 描述 project_id
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 获取方法请参见获取项目ID和名称。 默认取值: 不涉及 请求参数 无 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 versions Array of EsflavorsVersionsResp
修改Kibana公网访问控制 功能介绍 该接口通过修改kibana白名单,修改kibana的访问权限。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/update
获取智能运维告警可用的SMN主题 功能介绍 该接口用于获取智能运维告警可用的SMN主题。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topics 表1 路径参数 参数 是否必选
获取该esELB的信息,以及页面需要展示健康检查状态 功能介绍 该接口用于获取该ES集群的ELB信息,以及页面需要展示健康检查状态。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/clusters/{cluster_id}/es-listeners