检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
支持yaml和json两种文件格式的API导入,界面可预览待导入API内容。 图2 导入参数 (可选)修改待导入API的全局配置。 您可以修改全局配置,如前后端的请求配置,也可以修改具体的接口配置。 图3 修改全局配置 图4 修改接口配置 单击“快速上线”,完成API导入。 导入的API不会自动发布到环境,需要您手动发布。
API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。 共享版中的API,分组子域名可公网访问。 对外开放API时,您需要为API分组绑定您自己的独立域名。 后续操作 API分组创建成功后,您可以为此分组绑定域名,API调用者通过访问独立域名来调用您开放的API。
删除访问控制策略 操作场景 当已创建的访问控制策略不再需要时,可以将此访问控制策略删除。 前提条件 已创建访问控制策略。 操作步骤 进入共享版控制台。 选择“开放API > 访问控制”,进入访问控制策略列表页面。 通过以下任意一种方式,弹出“删除访问控制策略”对话框。 在待删除的访问控制策略所在行,单击“删除”。
请求协议:选择API请求协议,默认“HTTPS”。 子域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。 路径:接口请求路径。此处填写“/1234”。 网关响应 API网关未能成功处理API请求,从而产生的错误响应。 默认的网关响应为“default”。
选择API需要发布到的环境,并填写发布说明。 图1 发布API 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择的环境时没有自己需要的环境,可以创建一个自己需要的环境。 单击“发布”,完成API发布。 查看发布历史 单击“开放API > API管理”,进入到API管理信息页面。 单
RPC框架就可以完成。它的典型特征是使用protobuf(protocol buffers)作为其接口定义语言(Interface Definition Language,缩写IDL),同时底层的消息交换格式也是使用protobuf。 当用户使用gRPC服务时,可以通过API网关
API可以绑定内网域名吗? 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps
/v1/{project_id}/apigw/instances/{instance_id}/apis/publish/{api_id}[?env_id,env_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:env_id,env_name。 URI中的参数说明如下表所示。
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/a
拉美-圣保罗一 华东-青岛 拉美-圣地亚哥 入门 错误码 OBS 2.0支持 导入导出API API开放者可以将OpenAPI格式的API导入API网关。 API开放者和API调用者可以将API网关中的API导出。 支持区域: 华北-北京四 华北-乌兰察布一 华东-上海一 华南-广州 西南-贵阳一
绑定域名 在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。 在绑定独立域名前,您可以使用系统为API分配的默认子域名进行API调试,每天最多可以访问默认子域名1000次。 创建API 把已有后端服务封装为标准RESTFul API,并对外开放。 API
部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境变量定义在API分组上,该分组下的所有API都可以使用这些变量。 环境变量的变量名称
创建APP Code 功能介绍 App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes
校验APP 功能介绍 校验app是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/inst
/{instance_id}/apps[?page_size, page_no, id, name, app_key, creator] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、app_key、creator、page_size、page_no。
查看APP Code详情 功能介绍 App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/app
解绑域名 功能介绍 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group
求这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收到请求时,可以校验这个签名,如果签名校验不通过,则该请求不是API网关发出的请求,租户可以拒绝这个请求,从而保证API的安全性,避免API被未知来源的请求攻击。 调用方法 请参见如何调用API。
gw/instances/{instance_id}/api-groups[?page_size, page_no, id, name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、page_size、page_no。