检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
什么是API网关 API网关(API Gateway)是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务,能快速将企业服务能力包装成标准API接口,帮助您轻松构建、管理和部署任意规模的API,并上架API云商店进行售卖。
API概览 表1 部署服务-API概览 分类 接口 主机集群管理 包括新建主机集群、查询主机集群列表、查询主机集群等接口。 主机管理 包括新建主机、查询主机列表、查询主机详情等接口。 应用管理 包括新建应用、获取应用列表、部署应用等接口。
最新动态(html) 本文介绍了Huawei Cloud EulerOS产品新特性和对应的文档动态,新特性将在各个区域(Region)陆续发布,欢迎体验。
None 操作指导 API网关 APIG 介绍开放API的操作流程 04:34 开放API API网关 APIG 介绍如何创建流控策略 02:11 设置流量控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) API网关 APIG 介绍如何调用
API 主机集群管理 主机管理 应用管理 应用分组管理 应用权限管理 部署记录度量 环境管理 主机集群权限管理 环境权限管理
如何调用API 构造请求 认证鉴权 返回结果
应用网关API 查询插件列表 创建插件 查询单个插件 修改插件 删除插件 查询http转rpc资源列表 创建http转rpc方法 修改http转rpc方法 删除http转rpc方法
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。
API网关 APIG SCP不直接进行授权,只划定权限边界。将SCP绑定到组织单元或者成员账号时,并没有直接对组织单元或成员账号授予操作权限,而是规定了成员账号或组织单元包含的成员账号的授权范围。
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。
当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。
API网关 APIG APIG专享版实例配置安全认证类型 APIG专享版实例配置访问日志 APIG专享版实例域名均关联SSL证书 父主题: 系统内置预设策略
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。
删除应用 根据开始时间和结束时间查询项目下指定应用的历史部署记录列表 获取应用列表 (推荐) 新建应用 (推荐) 更新应用 获取应用详情 (推荐) 删除应用 (推荐) 查询部署记录的执行参数 复制应用 批量删除项目下应用 查询项目下是否存在同名应用 禁用/取消禁用应用 父主题: API
应用权限管理 查询应用实例级/项目级权限矩阵 批量修改应用权限 批量配置应用下鉴权级别 查询当前用户是否有项目下创建应用权限 父主题: API
应用分组管理 查询分组列表 创建分组 修改分组 删除分组 移动分组 移动应用至指定分组 父主题: API
该接口于2024年09月30日后不再维护,推荐使用新版获取应用详(ShowAppDetailById)接口。 调用方法 请参见如何调用API。
该接口于2024年09月30日后不再维护,推荐使用新版删除应用(DeleteApplication)接口。 调用方法 请参见如何调用API。
环境管理 应用下创建环境 查询应用下环境列表 应用下编辑环境 删除应用下的环境 查询环境详情 环境下导入主机 环境下删除主机 查询环境内的主机列表 父主题: API
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表2 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 应用id project_id 是 String 项目id name 是 String 应用名称 description
主机管理 新建主机 查询主机列表 查询主机详情 修改主机 删除主机 新建主机 (推荐) 查询主机列表 (推荐) 查询主机详情 (推荐) 编辑主机集群下主机信息 删除主机集群下主机 批量复制主机至目标主机集群 批量删除主机集群下的主机 父主题: API
环境权限管理 查询环境权限 编辑环境权限 父主题: API
对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 参数解释: 请求成功失败状态。
部署记录度量 获取指定项目的应用部署成功率 获取指定应用的应用部署成功率 父主题: API
该接口于2024年09月30日后不再维护,推荐使用新版新建主机(CreateHost)接口。 调用方法 请参见如何调用API。
主机集群管理 新建主机集群 查询主机集群列表 删除主机集群 查询主机集群 修改主机集群 新建主机集群 (推荐) 查询主机集群列表 (推荐) 查询主机集群 (推荐) 编辑主机集群 删除主机集群(推荐) 查询主机集群关联环境信息 查询应用下环境基本信息列表 父主题: API
主机集群权限管理 查询主机集群权限矩阵 修改主机集群权限矩阵 判断当前用户在项目下是否有权限创建主机集群 父主题: API