检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,支持单向认证和双向认证两种认证方式。 如果不配置SSL证书,将无法保障请求的链路安全,请谨慎配置。 单向认证:客
配置API的参数编排规则 API网关支持对API进行参数编排,根据请求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理”页签。
API概览 API网关专享版接口的分类与说明如表1所示,API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
AK/SK认证 使用AK(Access Key ID)、SK(Secret Access Key)对请求进行签名。 AK:访问密钥ID。与私有访问密钥关联的唯一标识符,访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK:与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。
获取凭据配额列表 功能介绍 获取凭据配额列表。支持根据名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas 表1 路径参数 参数 是否必选 参数类型 描述
查询凭据关联的凭据配额 功能介绍 查看指定凭据关联的凭据配额。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/bound-quota 表1 路径参数 参数
获取凭据配额详情 功能介绍 获取凭据配额详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id} 表1 路径参数 参数 是否必选 参数类型
配置API的调用域名 API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。因此,在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。最多可以添加5个独立域名,不限访问次数。 独立域名可分为内网域名和公网域名两种:
调用API报“No backend available” 检查后端服务是否可以访问,如果不能访问,请修改后端服务。 检查后端服务对应的ECS安全组配置,查看是否已开放您需要的端口。 检查后端服务地址是否使用公网IP地址,如果使用,需要在APIG控制台的“实例管理 > 查看控制台 >
使用APIG专享版跨VPC开放后端服务操作流程 创建VPC 创建两个VPC,VPC1为API网关所在VPC,VPC2为后端应用所在VPC。 创建实例 在VPC1上创建API专享版实例。 创建弹性负载均衡 在VPC2上创建弹性负载均衡。 创建对等连接 创建VPC Peering对等连接,打通VPC1和VPC2。
修改插件 功能介绍 修改插件信息。 插件不允许重名 插件不支持修改类型和可见范围 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数
创建插件 功能介绍 创建插件信息。 插件不允许重名 插件创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/plugins
通过CCE工作负载导入API API网关支持导入云容器引擎(Cloud Container Engine,简称CCE)的工作负载,将工作负载作为后端服务,在API网关中开放API,提供给API调用者使用。 如果当前实例不支持“导入CCE工作负载”,请联系客服。 注意事项 仅支持华为云CCE
查询插件详情 功能介绍 查询插件详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
开放API流程 企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之,跳过此步骤。
认证前准备 APP认证方式调用API,需要提前获取如下信息: 获取API的请求信息 在APIG实例控制台选择“API管理 > API列表”,单击API名称进入API详情,在“API运行”页签的API名称下方查看API的域名、请求路径和请求方法。 API已发布到环境 在APIG实例控制台选择“API管理
查询插件列表 功能介绍 查询一组符合条件的API网关插件详情。 支持分页 支持根据插件类型查询 支持根据插件可见范围查询 支持根据插件编码查询 支持根据名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances
停止计费 包年/包月模式 对于包年/包月计费模式的实例资源,您在购买时会一次性付费,服务将在到期后自动停止使用。 如果在计费周期内不再使用包年/包月资源,您可以执行退订操作,系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订。
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。
查询可绑定当前API的插件 功能介绍 查询可绑定当前API的插件信息。 支持分页返回 支持插件名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}/attachable-plugins