检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
"replace" } 为策略绑定API 单击策略名称,进入策略详情。 在API列表区域选择环境后,单击“绑定API”。 筛选API分组以及发布环境,勾选所需的API。 支持通过API名称或标签筛选API,标签为创建API时定义的标签。 单击“确定”,绑定完成。 如果单个API不需要绑定此策略,单击API所在行的“解绑”。
创建API分组 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 目前支持以下创建分组方式: 直接创建 创建一个简单的分组,不包含API,用户可自行创建API。具体步骤请参见创建API分组。 导入API设计文件
只需在管理控制台配置,即可快速创建API。提供页面调试工具,简化API开发。可同时发布一个API到多个环境,快速迭代、测试API。 便捷的API生命周期管理 API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维、上架、下架等, 实现完整的API解决方案。帮助您轻松构建、管理和部署任意规模的API。
怎样保护API的调用安全? 使用身份认证 创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。 设置访问控制策略 从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。
发布或下线API 功能介绍 对API进行发布或下线。 发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。 调用方法 请参见如何调用API。
security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies
security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies
APIG是否支持双向认证? 专享版:支持。 前端双向认证。在绑定独立域名时,选择带有CA证书的SSL证书,开启客户端认证即双向认证。 后端双向认证。在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API章节中的“TLS双向认证”参数说明。 共享版
到您的API所在分组。请检查API所在的分组域名,例如您有多个API分组,每个分组有自己的独立域名,API调用时,使用了其他分组的独立域名。 检查API是否使用OPTIONS跨域请求,如果使用OPTIONS跨域请求,请在API中开启CORS,并创建OPTIONS方式的API。具体操作请参考开启跨域共享。
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。 URI HT
删除API分组 功能介绍 删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 调用方法 请参见如何调用API。
使用AppCode进行API请求的简易认证 在创建API时,选择“APP认证”并且开启“支持简易认证”。 如果您修改已有API为简易认证,需要在修改完成后,将API重新发布,使简易认证模式生效。 将支持简易认证的API绑定到已创建的凭据。 发送请求时,增加请求头部参数“X-Apig-AppCode”,省略请求签名相关信息。
删除API分组 功能介绍 删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书、上架信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI H
Object API的认证类型对象数组定义,参考表 security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明
删除API分组 功能介绍 删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/api-groups/{id}
可在创建API分组后,为分组绑定独立域名,独立域名需要解析到实例的弹性IP地址。 例如您有一个API,请求协议为HTTPS,Path为/apidemo,开启了公网访问,并为分组绑定了独立域名后,可使用https://{domain}/apidemo这个URL访问您的API。其中,
查看或编辑APIG实例信息 实例创建完成后,可在控制台查看和编辑实例的配置信息。 查看或编辑实例信息 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上,单击“查看控制台”或实例名称。 在“实例信息”页签,根据下表参数说明,查看或编辑实例的配置信息。
策略创建后,您还需要为策略绑定API,才能使策略对API生效。 为策略绑定API 单击策略名称,进入策略详情。 在API列表区域选择环境后,单击“绑定API”。 筛选API分组以及发布环境,勾选所需的API。 支持通过API名称或标签筛选API,标签为创建API时定义的标签。 单击“确定”,绑定完成。