检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
nces/{instance_id}/api-groups”,project_id为项目ID,instance_id为实例ID(在APIG控制台的“实例信息”中查看)。 query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 throttle_id 是 String 流控策略的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型
意调用。 设置访问控制策略 从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。 API网关默认API流量控制为每秒200次,如果您的后端服务不能支撑单个API 200次/秒的调用请求,可设置流量控制策略,将限额调低。 父主题:
说明 acl_name String ACL策略名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 acl_type String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 约束与限制 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
不允许请求头中同时存在参数"Content-Length"和"Transfer-Encoding"。 不允许请求行中存在空格或控制符。 不允许header name中存在空格或控制符。 不允许请求头"Host"中存在空格或控制符。 不允许请求头中存在多个"Host"。 前提条件 在调用API前,确保您的业务系统所在网络与API的访问域名或地址互通。
前提条件 已获取API的调用信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载JavaScript SDK的最新版本,并解压。在浏览器中打开demo
API绑定签名密钥后,发给后端的请求中才会添加签名信息。 前提条件 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 已获取签名密钥的Key和Secret,请参见签名前准备获取。 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。或直接下载SDK的最新版本。
个API,如超出此数量,请分批导入,或提交配额修改工单,调整API单次导入上限。 可能原因2:参数错误,需要检查和修正。建议先在API网关控制台界面创建一个API,将其导出作为API文件的模板。 可能原因3:YAML文件格式问题,需要检查和修正。 可能原因4:本地proxy网络限制,更换网络环境。
调试API 操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。
String 环境的编号,即:API需要发布到哪个环境 remark 否 String 对本次发布动作的简述 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID"
说明 acl_name String ACL策略名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 acl_type String 类型 PERMIT (白名单类型) DENY (黑名单类型) acl_value
获取应用的AppKey和AppSecret: 在API网关共享版控制台选择“调用API > 应用管理”,在应用列表中单击API所授权应用的名称,进入应用详情页面,获取应用的AppKey和AppSecret。 获取认证签名所使用SDK: 在API网关共享版控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 请求参数 表2
请求Body参数 参数 是否必选 参数类型 描述 name 是 String 证书名称。支持中文,英文字母,数字,下划线,且只能以英文或汉字开头,4~50个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content 是 String 证书内容 private_key
请求Body参数 参数 是否必选 参数类型 描述 name 是 String 证书名称。支持中文,英文字母,数字,下划线,且只能以英文或汉字开头,4~50个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content 是 String 证书内容 private_key
异常告警做出反应,保证业务顺畅运行。 APIG提供基于云监控服务CES的资源和操作监控能力,帮助用户日常监控API网关的运行状态,可以通过控制台直观的查看API网关各项监控指标。 关于APIG支持的监控指标,以及如何创建监控告警规则等内容,请参见API监控。 父主题: 安全
表2 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端 BACKEND:后端
后端策略增加的参数,具体如表9所示,其他参数说明参考表4、表5和表6。 表9 后端策略参数 参数 说明 后端策略名称 您自定义的名称,用于识别不同的后端策略。 支持英文、数字、下划线和中划线,只能以英文字母开头,长度为3~64个字符。 生效方式 选择策略后端的生效方式。 满足任一条件:只要满足策略条件中的任意一项,此后端策略就可以生效。
表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端 BACKEND:后端