检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
包含一个服务名称标签和若干其它标签 服务名称标签非必填,必须以APIG-SN-开头 其它标签非必填,且不能以APIG-SN-开头 cors 否 Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark 否 String API请求体描述,可以是请求体示例、媒体类型、参数等信息
包含一个服务名称标签和若干其它标签 服务名称标签非必填,必须以APIG-SN-开头 其它标签非必填,且不能以APIG-SN-开头 cors 否 Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark 否 String API请求体描述,可以是请求体示例、媒体类型、参数等信息
API管理 创建API 开启跨域访问 调试API 授权API 发布API 下线API 删除API 导入API 导出API 父主题: 共享版操作指导(仅存量用户使用)
"sign_basic", "app_route", "backend_client_certificate", "ssl_ciphers", "cors", "app_quota", "app_acl", "real_ip_from_xff", "set_resp_headers", "vpc_backup"
API修改时间 R - remark String API描述 CRU 否 tag String API标签 CRU 否 cors String 是否支持跨域 TRUE 支持 FALSE 不支持 默认:FALSE CRU 否 表2 web后端对象模型 参数 类型 说明 操作类型 是否必选
API修改时间 R - remark String API描述 CRU 否 tag String API标签 CRU 否 cors String 是否支持跨域 TRUE 支持 FALSE 不支持 默认:FALSE CRU 否 response_id String 分组自定义响应ID
检查调用API所使用的域名、请求方法、路径是否正确。 检查API是否发布。 检查域名解析是否正确。 检查API是否使用OPTIONS跨域请求,如果使用OPTIONS跨域请求,请在API中开启CORS。 具体操作请参见常见问题。 APIG.0101 The API does not exist. 404 API请求方法不存在
调用API(浏览器)示例 由于浏览器限制从页面脚本内发起跨域请求,因此浏览器访问API前需要在API网关控制台上创建一个跨域共享策略,允许浏览器向跨域服务器发送XMLHttpRequest请求,并为跨域共享策略绑定API。 创建策略请参考跨域共享策略说明。 图8 创建跨域共享策略示例 在html中引入signer
响应头策略可以绑定多个API。 无法修改API网关增加的系统响应头(x-apig-*,x-request-id等),包括API网关提供的CORS功能增加的响应头。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。
API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理? API发布到非RELEASE环境无法访问时,添加x-stage请求消息头后即可访问。 例如: r.Header.Add("x-stage", "RELEASE") 您也可以参考快速开放并调用API章节中的示例。
欢迎使用API网关(API Gateway),API网关为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。 您可以使用本文档提供的API对API网关进行相关操作,如创建、删除、修改等。支持的全部操作请参见API概览。 在调用API网关的A
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加A类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
配置API的访问控制 访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址/账号名/账号ID访问API。实例级访问控制策略请参考表1。 访问控制策略和API本身是相互独立的,只
如何通过APIG访问公网后端服务? 通过开启公网入口访问,允许外部服务调用API。 如果您在调用API遇到网络问题,请参考调用API失败的可能原因。 父主题: 调用API
访问控制 创建访问控制策略 删除访问控制策略 父主题: 共享版操作指导(仅存量用户使用)
身份认证与访问控制 身份认证 服务认证:APIG提供AKSK、Token等多种方式进行服务认证,只允许授权的访问。 自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证。
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容,请参考约束与限制。 自定义客户端访问端口 进入API网关控制台页面。
描述 $context.apiId API的ID $context.apiName API名称 $context.appId API调用者的凭据对象ID $context.appName API调用者的凭据对象名称 $context.requestId 当次API调用生成请求ID $context
到API云商店,实现业务能力变现。 如果您作为API调用者,您可以获取并调用API提供者在API网关开放的API,减少开发时间与成本。 例如,企业A在API网关中开放了电话号码归属地查询API,并发布到API云商店。企业B通过API云商店调用此API,并支付调用此API所产生的费