检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
什么是API网关 API网关(API Gateway)是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务,能快速将企业服务能力包装成标准API接口,帮助您轻松构建、管理和部署任意规模的API,并上架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概览 表1 CodeArts IDE 接口说明 分类 接口 激活管理 购买激活码 查询激活码列表 激活码绑定用户 激活码解绑用户
如何调用API 构造请求 认证鉴权 返回结果
应用网关API 查询插件列表 创建插件 查询单个插件 修改插件 删除插件 查询http转rpc资源列表 创建http转rpc方法 修改http转rpc方法 删除http转rpc方法
FastAPI应用 使用此启动配置来运行FastAPI应用程序。该配置将执行“uvicorn”命令,启动一个运行您应用程序的uvicorn服务器。 启动配置属性 启动配置示例 父主题: 启动配置
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。
API网关 APIG SCP不直接进行授权,只划定权限边界。将SCP绑定到组织单元或者成员账号时,并没有直接对组织单元或成员账号授予操作权限,而是规定了成员账号或组织单元包含的成员账号的授权范围。
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。
连接华为云,快速完成基于API的应用开发 内置华为云API开发套件,提供华为云200服务和8000+服务API的搜索和引用,一键引入样例代码,帮助开发者快捷使用华为云和高效开发华为云应用。 父主题: 产品特性
API网关 APIG APIG专享版实例配置安全认证类型 APIG专享版实例配置访问日志 APIG专享版实例域名均关联SSL证书 父主题: 系统内置预设策略
错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 IDE.00000097 输入参数校验失败。 输入参数校验失败。 检查输入参数格式。
此外,API Explorer会自动生成相应API调用示例,帮助您使用API。 父主题: 使用前必读
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。
激活管理 购买激活码 查询激活码列表 激活码绑定用户 激活码解绑用户 父主题: API
Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。
查询激活码列表 功能介绍 查询激活码列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
购买激活码 功能介绍 购买激活码 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
激活码绑定用户 功能介绍 激活码绑定用户 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。
激活码解绑用户 功能介绍 激活码解绑用户 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 201
附录 状态码 错误码 获取项目ID 获取账号ID
您可以使用本文档提供的API对CodeArts IDE进行相关操作,如:激活管理。支持的全部操作请参见API概览。 在调用CodeArts IDE的API之前,请确保已经充分了解CodeArts IDE的相关概念,详细信息请参见产品介绍。 父主题: 使用前必读