检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API 功能介绍 添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。
域名管理 对象模型 绑定域名 解绑域名 绑定域名证书 删除域名证书 查看域名证书 父主题: 共享版API(仅存量用户使用)
域名管理(待下线) 对象模型 绑定域名 解绑域名 绑定域名证书 删除域名证书 查看域名证书 父主题: 专享版API(V1)(待下线)
getUTCSeconds()) + "Z" } getTime() 将x-sdk-date添加到Headers中,并填写其余参数,单击“debug”获取签名字符串。 非get\delete\head请求,需要携带body体,需要在上图Body框中添加body(格式与发送请求的body一致)。 复制4图中的cu
专享版-域名管理 绑定域名 绑定域名证书 修改域名 解绑域名 设置调试域名是否可以访问 删除域名证书 查看域名证书 父主题: 专享版API(V2)
服务的接口调用时,需在请求消息头中携带X-Domain-ID。 对于创建API分组接口,使用AK/SK方式认证时,添加消息头后的请求如下所示。 POST https://apig.cn-north-1.myhuaweicloud.com/v2/{project_id}/apigw
如您的组织已经设定API网关服务的相关标签策略,则需按照标签策略规则为实例添加标签。标签如果不符合标签策略的规则,则可能会导致添加标签失败,请联系组织管理员了解标签策略详情。 单击“确定”。 相关操作 进入标签管理服务控制台,通过已添加标签过滤实例,查看、分析及管理实例资源。 将鼠标移至左侧图标
参数:用于做规则匹配的参数名。 系统默认包含reqPath(请求路径)和method(请求方法)参数。单击“添加参数”,可添加其他匹配参数。 定义规则 自定义断路器的匹配规则。单击“添加规则”,可添加规则,系统根据从上到下的顺序匹配规则,可通过上下移动调整规则优先级。 匹配条件:单击“”编辑匹
检查后端服务所在ECS的安全组,确保出/入方向端口规则和协议都设置正确。 请求协议配置错误,如后端服务为HTTP,在API网关配置为HTTPS。 创建的API与后端服务配置相同的协议。 API网关客户侧后端服务链接链路不通。 排查链接链路。 父主题: 调用API
应码。 仅在协议不为“TCP”时,需要设置。 单击“下一步”,进入“添加云服务器”页面。 单击“添加云服务器”,弹出“添加云服务器”对话框。 勾选需要添加的云服务器,单击“添加”。 使用共享版API网关时,待添加的云服务器的安全组必须允许100.125.0.0/16网段访问,否则将导致健康检查失败及业务不通。
= '{"a":1}' 给请求添加x-stage头,内容为环境名。如有需要,添加需要签名的其他头域。 r.headers = { "x-stage":"RELEASE" } 进行签名,执行此函数会生成请求参数,用于创建http(s)请求,请求参数中添加了用于签名的X-Sdk-Date头和Authorization头。
当API响应中不存在指定的响应头时,添加当前响应头。 Append:添加 当API响应中存在指定的响应头时,将当前响应头的值添加到已有响应头值之后,用逗号分隔。 当API响应中存在多个与指定响应头相同名称的响应头时,会将多个响应头的值用“,”拼接后,再添加当前响应头的值。 当API响应
策略中添加特殊凭据实现。把凭据添加到流控策略中后,该凭据的凭据流量限制受特殊凭据的阈值限制,API流量限制和用户流量限制受流控策略限制。 在流控策略详情页面,单击“特殊凭据”页签,进入特殊凭据页面。 单击“添加特殊凭据”,弹出“添加特殊凭据”对话框。 通过以下两种方式,添加特殊凭据。
使用APIG专享版实现http到https自动重定向操作流程 开启重定向 开启重定向功能的API的前端请求协议必须为“HTTPS”或“HTTP&HTTPS”。 验证重定向 验证重定向功能是否生效。 父主题: 使用APIG专享版实现http到https自动重定向
在“环境”中选择待添加变量的环境名称,单击“添加变量”,弹出“新增变量”对话框。 填写如表2所示信息。 图3 新增变量 表2 新增变量 信息项 描述 变量名称 变量的名称,必须与创建API时定义的变量标识完全相同。 变量值 变量路径。 单击“确定”,完成变量的添加。 如果不再需要此变量时,在变量所在行单击“删除”。
new Uri("https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?query=value")); r.body = "{\"a\":1}"; 给请求添加x-stage头,内容
右侧为API发送的请求信息和API请求调用后的返回结果回显。 表1 调试API 参数名称 说明 协议 仅在“请求协议”为“HTTP&HTTPS”时,支持修改。 方法 仅在“Method”为“ANY”时,支持修改。 路径 仅在“匹配模式”为“前缀模式”时,支持自定义路径。 路径参数
安全 责任共担 身份认证与访问控制 数据保护技术 审计与日志 监控安全风险 认证证书
函数创建完成后,进入函数详情。在“设置”页签的左侧导航栏中选择“环境变量”,根据下表参数说明,单击“编辑环境变量 > 添加环境变量”。 表2 设置环境变量 参数 配置说明 键 环境变量的名称,此处添加“token”和“test”两个环境变量。token用于Header身份验证,test参数用于Query参数查询。
在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类型、条件值等,其中参数名称和条件值要与前端自定义认证函数返回值中context字段下的键值对一致。 调试API 调试API,观察是否成功调用到已添加的策略后端。 父主题: