检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
管理API 管理API概述 查看或编辑APIG的API信息 配置API的自定义认证 配置API的参数编排规则 自定义API的错误响应信息 克隆APIG的API 下线APIG的API 导入导出API APIG的API设计文件扩展定义
函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简化API开发的复杂度。您只需要在APIG中创建自定义的函数认证,APIG通过此函数对接后端认证系统,获取后端服务的访问授权。
APIG使用流程 API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关的开放API和调用API功能,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放。 开放API 企业或开发者通过API网关开放自身的服务与数据。
搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。 表4 TmsKeyValues 参数 是否必选 参数类型 描述 key 否 String 键。 支持可用
删除域名证书 功能介绍 如果域名证书不再需要或者已过期,则可以删除证书内容。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_i
解绑域名 功能介绍 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/api-groups/{
解绑域名 功能介绍 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group
使用场景 API网关主要涉及以下几个开发场景: API调用认证开发:API的认证方式为APP认证或IAM认证,则需要在业务系统侧进行调用认证的开发,为API请求添加认证信息。 使用APP认证(签名认证)调用API:API调用者通过API网关提供Key、Secret和SDK,对API请求进行签名认证。
1597390224911, "error_code" : null, "error_msg" : null, "progress" : 100, "start_time" : 1597389901161, "status" : "success" } 实例创建中 { "end_time"
解绑域名 功能介绍 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/i
查询项目下所有实例标签 功能介绍 查询项目下所有实例标签。 接口约束 使用策略授权用户时,需要包含apig:instanceTags:list的授权项才允许调用此接口 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instance-tags
String online:发布 offline:下线 请求消息 表3 参数说明 参数 是否必选 类型 说明 apis 是 String Array 需要发布或下线的API ID列表 env_id 是 String 环境ID remark 否 String 对本次发布的描述信息 字符长度不超过255
查看ACL策略未绑定的API列表 功能介绍 查看ACL策略未绑定的API列表,需要API已发布 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/unbinded-apis
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 环境上存在已发布的API时,该环境不能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{projec
32位的字符串,字符串由英文字母、数字、“_”、“-”组成,且只能以英文开头。 说明: 需要服从URI规范。 timeout 是 Integer API网关请求后端服务的超时时间。超时时间最大值可以通过实例特性backend_timeout配置修改。 单位:毫秒。 最小值:1 最大值:600000 remark
显示查询结果。 在url后面拼接如下参数: page_size:每页查询多少条数据,如果不指定,默认20,最大值500。 page_no:需要查询的页码。 示例: GET /v1.0/apigw/apis?page_size=10&page_no=5 父主题: 附录
查看签名密钥未绑定的API列表 功能介绍 查询所有未绑定到该签名密钥上的API列表。需要API已经发布,未发布的API不予展示。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/sig
搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。 表5 TmsKeyValues 参数 是否必选 参数类型 描述 key 否 String 键。 支持可用
异步导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/insta
BACKEND_TIMEOUT: 后端超时,与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: