检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如果API开启了“支持CORS”功能的同时，也绑定了跨域资源共享策略，则以绑定的策略为准。 如果某个请求路径下有OPTIONS方法的API，则该请求路径下的所有API均不允许绑定跨域资源共享策略。 为策略绑定API时，API的请求方法必须为allow_methods中允许的请求方法。 一个API只能绑定一个相同类型的策略。
广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。 约束与限制 WebSocket API不支持APIG控制台页面中的调试功能。 WebSocket API受API超时时间的限制，如果当前WebSocket连接空闲时间超过了配置的超时时间，并且没有ping/pong保活，则连接会被自动断开。
枚举 请求参数的枚举值，请求参数的值只能从枚举值中选择，多个枚举值间用英文逗号隔开。 最小长度 参数值的最小长度，仅允许输入数字。 最大长度 参数值的最大长度，仅允许输入数字。 示例 参数值的填写示例。 描述 对于此参数的描述。 单击“确定”，完成入参定义的设置。 单击“下一步”，进入“定义后端服务”页面。
更新SSL证书不影响API的调用。 如果待更新证书已绑定独立域名，那么所有访问这个域名的客户端都会看到更新后的证书。 如果更新的SSL证书已绑定独立域名且更新的内容新增CA证书，那么独立域名侧默认关闭“支持客户端认证”即关闭HTTPS双向认证；如果更新的SSL证书已绑定独立域名且更新的内容无CA
策略名称 填写策略的名称，根据业务规划自定义。建议您按照一定的命名规则填写策略名称，方便您快速识别和查找。 策略类型 固定为“第三方认证”。 描述 填写策略的描述信息。 策略内容 策略的配置内容，支持表单配置和脚本配置两种方式。 负载通道 是否使用负载通道作为第三方接口的鉴权服务。 选择“使用”时，配置鉴权服务的负载通道。
x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions:
配置API的断路器 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下，会触发断路器的降级机制，向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后，断路器关闭，请求恢复正常。 如果此策略
API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致；检查API是否发布，如果发布到非生产环境，检查请求X-Stage头是否为发布的环境名；检查调用API使用的域名是否已经绑定到API所在的分组。 APIG.0101 The API does
密钥名称 自定义名称，用于识别不同的密钥。 类型 专享版支持选择签名密钥的认证类型，可选择“HMAC”和“Basic”。 Key 与“Secret”配合使用，表示签名密钥对。 HMAC：填写hmac认证所使用密钥对的Key。 Basic：填写basic认证所使用的用户名。 Secret
POST：请求方法，需替换为获取API的调用信息中获取的请求方法。 {Address}：请求地址，需替换为获取API的调用信息中获取的域名地址。 API调用场景 API请求参数配置 使用域名调用API 使用服务分配的调试域名或服务绑定的域名调用API，无需另外配置。 使用IP调用DEFAULT分组的API A
API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致；检查API是否发布，如果发布到非生产环境，检查请求X-Stage头是否为发布的环境名；检查调用API使用的域名是否已经绑定到API所在的分组 APIG.0101 The API does
通道名称 自定义VPC通道名称，用于识别不同的VPC通道。 端口 VPC通道中主机的端口号，即用户的后端业务端口号。 取值为1 ~ 65535。 成员类型 选择负载通道中的服务器成员类型。成员类型在负载通道创建后将不能修改。 实例：通过选择弹性云服务器的方式添加负载通道成员。 IP地址
在API网关控制台选择“开放API > API管理”，单击API的名称进入“调用信息”页面，可获取API的“域名”、“请求方法”和“请求路径”，以及API的基本信息。 获取API的认证信息 根据API使用的安全认证方式不同，还要获取相关的请求认证信息： 认证方式 认证信息 APP认证（签名认证）
）。 单击“导入参数”下方的“文件”，选择待导入的API文件。 支持yaml和json两种文件格式的API导入，界面可预览待导入API内容。 图2 导入参数 （可选）修改待导入API的全局配置。 您可以修改全局配置，如前后端的请求配置，也可以修改具体的接口配置。 图3 修改全局配置
切换API版本 功能介绍 API每次发布时，会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上，只能有一个版本生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id
云监控服务为用户的云上资源提供了立体化监控平台。通过云监控您可以全面了解云上的资源使用情况、业务的运行状况，并及时收到异常告警做出反应，保证业务顺畅运行。 APIG提供基于云监控服务CES的资源和操作监控能力，帮助用户日常监控API网关的运行状态，可以通过控制台直观的查看API网关各项监控指标。
力，避免重复开发造成的资源浪费。 企业能力开放 当今企业面临巨大的挑战，企业的发展需要依赖外部合作伙伴的能力，典型的例子如使用第三方平台支付、合作方账户登录等。通过API网关将企业内部服务能力以标准API的形式开放给合作伙伴，与合作伙伴共享服务和数据，达成深度合作，构建企业共赢生态。
访问控制参数说明 参数 说明 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址：限制调用API的IP地址。 账号名：仅适用IAM认证类型的API，限制调用API的账号名。仅支持配置账号名，对账号名及账号名下的IAM用户名做限制，不支持配置IAM用户名。 可以配
mits”的参数运行值。 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立，只有为API绑定策略后，策略才对API生效。为API绑定策略时需指定发布环境，策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效，不需要重新发布API。 API的下线操作不
当后端服务没有在设置的后端超时时间内返回时，API网关提示后端服务调用失败。 在编辑API中增加后端超时时间。 如果“后端服务地址”在ECS（Elastic Cloud Server），ECS的安全组的出/入方向规则可能拦截了请求。 检查后端服务所在ECS的安全组，确保出/入方向端口规则和协议都设置正确。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
