检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG最佳实践汇总 本文汇总了基于API网关服务（APIG，APIGateway）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎（Cloud
"request_body_size", "backend_timeout", "app_token", "app_basic", "app_secret", "multi_auth", "route", "sign_basic", "app_route", "backend_client_certificate"
专享版-流控策略管理 专享版-API管理 专享版-签名密钥管理 专享版-签名密钥绑定关系管理 专享版-API绑定流控策略 专享版-设置特殊流控 专享版-APP授权管理 专享版-概要查询 专享版-域名管理 专享版-ACL策略管理 专享版-API绑定ACL策略 专享版-自定义认证管理 专享版-OpenAPI接口
删除特殊应用或租户 操作场景 在特殊应用/租户没有作用之后，删除为流控策略添加的特殊应用/租户。本节以删除特殊应用为例。 前提条件 已创建流控策略。 已添加特殊应用/租户。 删除特殊应用 进入共享版控制台。 选择“开放API > 流量控制”，进入到流量控制信息页面。 单击待删除特
示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token"
String 分组版本 V1：全局分组 V2：应用级分组 V2暂不支持，默认为V1 roma_app_id String 分组归属的集成应用编号。 分组版本V2时必填。 暂不支持 roma_app_name String 分组归属的集成应用名称 暂不支持 表5 UrlDomain 参数
示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description:
debug，且API配置了用户流量限制时，返回此参数 X-Apig-RateLimit-app 应用流量限制信息 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了应用流量限制时，返回此参数 X-Apig-RateLimit-ip
您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证），以便更好地兼容已有业务能力。 API
证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使用，表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API，按主账号累计的调用次数进行限制。 凭据流量限制 单个凭据调用API次数上限，仅在API的安全认证方式为APP认证时适用。
req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例： { "name": "test", "type": 1, "version":
选择AES的签名算法，包含以下两种： aes-128-cfb aes-256-cfb Key 根据选择的密钥类型，填写不同的密钥信息。 HMAC：填写APP认证所使用密钥对的Key。 Basic Auth：填写basic认证所使用的用户名。 AES：填写AES认证所使用的密钥key。 Public
service_name String 微服务名称 register_address String 注册中心地址 cse_app_id String 微服务所属的应用 version String 微服务的版本，已废弃，通过后端服务器组中的版本承载。 最大长度：64 表8 MicroServiceInfoCCE
部署在VPC下的应用是否可以调用API？ 默认部署在VPC下的应用可以调用API。如果域名解析失败，则参考配置内网DNS，在当前终端节点上配置DNS服务器。配置完成后，部署在VPC下的应用可以调用API。 配置内网DNS 配置DNS需要配置“/etc”目录下的resolv.conf文件，指定DNS服务器的IP地址。
String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 暂不支持 roma_app_name String 自定义认证所属应用名称 暂不支持 表4 Identity 参数 参数类型 描述 name String
BACKEND_UNAVAILABLE：后端不可用 BACKEND_TIMEOUT：后端超时 THROTTLED：调用次数超出阈值 UNAUTHORIZED：应用未授权 ACCESS_DENIED：拒绝访问 NOT_FOUND：未找到匹配的API REQUEST_PARAMETERS_FAILURE：请求参数错误
API概览 如何调用API 权限策略和授权项 OBS 2.0支持 SDK API网关开放的API，安全认证方式可选IAM认证、APP认证或无认证。本操作主要提供APP认证的SDK下载以及文档。 支持区域： 华北-北京四 华北-乌兰察布一 华东-上海一 华南-广州 西南-贵阳一 中国-香港
划线组成，且只能以英文开头。 说明： 需要服从URI规范。 auth_type String API的认证方式。 NONE：无认证 APP：APP认证 IAM：IAM认证 AUTHORIZER：自定义认证 match_mode String API的匹配方式。 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配）
String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 暂不支持 roma_app_name String 自定义认证所属应用名称 暂不支持 表6 Identity 参数 参数类型 描述 name String
second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了用户流量限制时，返回此参数 X-Apig-RateLimit-app 凭据流量限制信息。 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode:
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
