检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 stage 否 String 调试请求指定的运行环境,仅在mode为C
配置API调用授权(可选) API调用授权概述 配置APIG的API认证凭据 配置APIG的API简易认证AppCode
单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer 单个源IP流控时间内能够访问API的次数限制
概要查询 查询API分组概况 查询API概况 查询APP概况 父主题: 共享版API(仅存量用户使用)
专享版-概要查询 查询API概况 查询API分组概况 查询APP概况 父主题: 专享版API(V2)
概要查询(待下线) 查询API分组概况 查询API概况 查询APP概况 父主题: 专享版API(V1)(待下线)
String API所属分组的名称 publish_id String API的发布记录编号 throttle_apply_id String 与流控策略的绑定关系编号 apply_time String 已绑定的流控策略的绑定时间 remark String API描述 run_env_id
示例: paths: '/users/{userId}': get: produces: - "application/json" responses: default: description:
Object(2.0) 示例: paths: /: get: x-apigateway-content-type: application/json 父主题: APIG的API设计文件扩展定义
您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。 API
选择AES的签名算法,包含以下两种: aes-128-cfb aes-256-cfb Key 根据选择的密钥类型,填写不同的密钥信息。 HMAC:填写APP认证所使用密钥对的Key。 Basic Auth:填写basic认证所使用的用户名。 AES:填写AES认证所使用的密钥key。 Public
API概览 如何调用API 权限策略和授权项 OBS 2.0支持 SDK API网关开放的API,安全认证方式可选IAM认证、APP认证或无认证。本操作主要提供APP认证的SDK下载以及文档。 支持区域: 华北-北京四 华北-乌兰察布一 华东-上海一 华南-广州 西南-贵阳一 中国-香港
String 分组版本 V1:全局分组 V2:应用级分组 V2暂不支持,默认为V1 roma_app_id String 分组归属的集成应用编号。 分组版本V2时必填。 暂不支持 roma_app_name String 分组归属的集成应用名称 暂不支持 表5 UrlDomain 参数
debug,且API配置了用户流量限制时,返回此参数 X-Apig-RateLimit-app 应用流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了应用流量限制时,返回此参数 X-Apig-RateLimit-ip
req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例: { "name": "test", "type": 1, "version":
default: ACCESS_DENIED: status: 403 body: application/json: >- {"error_code":"$context.error.code","error_msg":"Access
req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例: { "name": "test", "type": 1, "version":
证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 凭据流量限制 单个凭据调用API次数上限,仅在API的安全认证方式为APP认证时适用。
"config_name": "APP_NUM_LIMIT", "config_value": "30", "config_time": "2017-12-29T03: 39: 03.165657Z", "remark": "租户可以创建的APP个数限制"
String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 暂不支持 roma_app_name String 自定义认证所属应用名称 暂不支持 表4 Identity 参数 参数类型 描述 name String