检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
仅当“请求方法”选择“POST”、“PUT”、“PATCH”或“ANY”时可配置。 填写API请求中请求体的描述信息,用于帮助API调用者理解如何正确封装API请求。 (可选)设置入参定义。 入参定义是指您调用API时,需要传入的参数的说明。 单击“添加入参定义”,弹出“添加入参定义”对话框。 输入如表3所示信息。
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access
API的响应码如何定义? API响应码分两种。 一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考网关响应。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。
修改特殊设置 功能介绍 修改某个流控策略下的某个特殊设置。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_id}
查看特殊设置列表 功能介绍 查看给流控策略设置的特殊配置。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials
息。如果请求体中包含多个重复地址的后端实例定义,则使用第一个定义。 引用负载通道类型的负载通道不支持添加或更新后端实例。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-ch
设置调试域名是否可以访问 功能介绍 禁用或启用API分组绑定的调试域名 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/sl-domain-access-settings
最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型”为“NUMBER”时,设置参数值的最小值。 示例 参数值的填写示例。 描述
设置APP的访问控制 功能介绍 设置凭据的访问控制。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl 表1 路径参数 参数 是否必选 参数类型
应用场景 当用户在公网中调用APIG上公开的业务API时,会存在DDoS攻击风险,为防范DDoS攻击,华为云提供了DDoS防护服务。下文讲述如何对接DDoS高防服务来进行抵御DDoS攻击。DDoS攻击详情请参见常见DDoS攻击类型。 方案架构 方案优势 所有Region都可以配置。
删除特殊设置 功能介绍 删除某个流控策略的某个特殊配置。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_id}
"error_code": "APIG.1000" } 其中,error_code表示错误码,error_msg表示错误描述信息。 父主题: 如何调用API
构造请求 本节介绍如何构造REST API的请求,并以调用APIG服务的创建API分组(专享版API)说明如何调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。 父主题: 如何调用API
如何切换调用环境? 默认调用“发布”环境的API。 如果您要调用其他环境的API,请添加请求消息头X-Stage,参数值填写环境名称。 父主题: API调用
需根据获取API的调用信息中获取的请求参数进行设置。 {Header}:请求头参数,格式为“参数名: 参数取值”,例如Content-Type: application/json。需根据获取API的调用信息中获取的请求参数进行设置。 {Body}:请求消息体,JSON格式。需根
API调试的时候,如何指定环境? 不能指定。 API网关控制台提供的调试功能,用的是特定的debug环境,调试完成后需先发布到对应环境,之后可使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: API发布
API网关如何开放部署在华为云上的服务? 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网
创建特殊设置 功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通
配置了身份认证的API,如何在特殊场景下(如指定IP地址)允许不校验身份? 认证方式不能基于某个特殊场景进行选择性认证。 方案1:创建API时选择无认证方式,然后利用“访问控制策略”功能进行IP白名单过滤,使得所有调用都不需要校验身份。 方案2:考虑拆分成2个API,其中一个使用