检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建新策略:请参考表1所示配置策略。 表1 配置凭据配额策略 参数 说明 策略名称 填写客户端配额策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。例如,时长为1小时,首次生效时间点为2020/08/08
绑定,则API网关在请求这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收到请求时,可以校验这个签名,如果签名校验不通过,则该请求不是API网关发出的请求,租户可以拒绝这个请求,从而保证API的安全性,避免API被未知来源的请求攻击。 URI
name 是 String 参数名称 location 是 String 参数位置 validation 否 String 参数校验表达式,默认为null,不做校验 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 name String 自定义认证的名称。 长度为3
ORCHESTRATION_PARAMETER_NOT_FOUND: 没有入参进行参数编排规则匹配,参数编排失败 ORCHESTRATION_FAILURE: 有入参进行参数编排规则匹配,但是匹配不上编排规则,参数编排失败 每项错误类型均为一个JSON体 id String 响应ID default
绑定,则API网关在请求这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收到请求时,可以校验这个签名,如果签名校验不通过,则该请求不是API网关发出的请求,租户可以拒绝这个请求,从而保证API的安全性,避免API被未知来源的请求攻击。 URI
简易认证指APP认证方式下调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 注意仅支持HTTPS方式调用,不支持HTTP方式。具体使用请参考为简易认证添加AppCode。 说明:
是否支持对请求并发次数做自定义控制? API调用是否存在带宽限制 怎样给指定的用户开放API 配置了身份认证的API,如何在特殊场景下(如指定IP地址)允许不校验身份? API导入导出 API导入失败是什么原因? swagger导入API的扩展字段有没有模板?
使用时请注意。 客户端必须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时间差大于15分钟,API网关将拒绝请求。 您也可以通过这个视频教程了解AK/SK认证的使用:https://bbs
createApiGroup 修改API分组 ApiGroup updateApiGroup 删除API分组 ApiGroup deleteApiGroup 校验API分组名称是否存在 Swagger CheckApiGroups 创建环境 Environment createEnvironment
自定义认证方返回认证失败 自定义认证身份来源错误 401 前端自定义认证的身份来源信息缺失或不合法错误 认证失败 401 认证失败,IAM或APP认证校验失败 认证身份来源缺失 401 认证身份来源信息缺失 后端超时 504 后端超时,与后端的网络交互超过预配置的时间错误 后端不可用 502
pi_limits”的参数运行值。 如果一个API绑定传统流量控制策略后,继续绑定流量控制2.0策略,传统流量控制策略会失效。 参数流控的规则最多可定义100个。 策略内容最大长度65535。 如果您的实例不支持流量控制2.0,请联系技术支持。 父主题: 使用APIG专享版的流量控制2
如果您需要把自己的认证系统用于API调用的认证鉴权,可以通过配置API的自定义认证来实现;需要对API进行参数编排,可以通过配置API的参数编排规则来实现;需要自定义API的错误响应信息,可以通过自定义API的错误响应信息来实现。更多API相关操作,请参考管理API。 配置API调用授权(可选)
客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关(即API管理)除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时间差大于15分钟,API网关将拒绝请求。 父主题: 使用IAM认证调用API
API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。例如“API01”。 所属分组 默认“DEFAULT”。 URL 请求方法:接口调用方式,此处选择“GET”。
401 第三方认证方返回认证失败 第三方认证身份来源错误 401 第三方认证的身份来源信息缺失 认证失败 401 认证失败,IAM或APP认证校验失败 认证身份来源缺失 401 认证身份来源信息缺失 后端超时 504 后端超时,与后端的网络交互超过预配置的时间错误 后端不可用 502
描述 name String 参数名称 location String 参数位置 validation String 参数校验表达式,默认为null,不做校验 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
API”。更多详细指导,请参见创建GRPC API。 配置前端信息后,单击“下一步”。 表1 前端配置 参数 配置说明 API名称 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。 所属分组 默认“DEFAULT”。 URL 请求方法:接口调用方式,默认“POST”。 请求协议:选择API请求协议,默认“GRPCS”。
描述 name String 参数名称 location String 参数位置 validation String 参数校验表达式,默认为null,不做校验 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
白名单记录列表 表6 EndpointPermission 参数 参数类型 描述 id String 记录编号 permission String 权限规则 created_at String 创建时间 状态码: 401 表7 响应Header参数 参数 参数类型 描述 x-request-id
strings 实例ID集合 verified_client_certificate_enabled 否 Boolean 是否开启客户端证书校验。当绑定证书存在trusted_root_ca时,默认开启;当绑定证书不存在trusted_root_ca时,默认关闭。 响应参数 状态码: