检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。 API
req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例: { "name": "test", "type": 1, "version":
service_name String 微服务名称 register_address String 注册中心地址 cse_app_id String 微服务所属的应用 version String 微服务的版本,已废弃,通过后端服务器组中的版本承载。 最大长度:64 表8 MicroServiceInfoCCE
debug,且API配置了用户流量限制时,返回此参数 X-Apig-RateLimit-app 应用流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了应用流量限制时,返回此参数 X-Apig-RateLimit-ip
示例: paths: '/users/{userId}': get: produces: - "application/json" responses: default: description:
获取API的请求信息,包括访问域名、请求协议、请求方法、请求路径以及认证方式等信息。 创建凭据 使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,使用APP认证调用API。 获取SDK 可通过SDK对AK/SK生成签名,并调用API。
String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 暂不支持 roma_app_name String 自定义认证所属应用名称 暂不支持 表4 Identity 参数 参数类型 描述 name String
API概览 如何调用API 权限策略和授权项 OBS 2.0支持 SDK API网关开放的API,安全认证方式可选IAM认证、APP认证或无认证。本操作主要提供APP认证的SDK下载以及文档。 支持区域: 华北-北京四 华北-乌兰察布一 华东-上海一 华南-广州 西南-贵阳一 中国-香港
req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例: { "name": "test", "type": 1, "version":
应用场景 企业内部系统解耦 随着企业的高速发展、业务的快速变化,需要企业内部系统跟随业务需求一同变化,但是企业内部系统存在相互依赖关系,为保持系统的通用性与稳定性,很难应对业务的变化。而API网关使用RESTful API, 帮您简化服务架构,通过规范化、标准化的API接口,快速
划线组成,且只能以英文开头。 说明: 需要服从URI规范。 auth_type String API的认证方式。 NONE:无认证 APP:APP认证 IAM:IAM认证 AUTHORIZER:自定义认证 match_mode String API的匹配方式。 SWA:前缀匹配 NORMAL:正常匹配(绝对匹配)
证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 凭据流量限制 单个凭据调用API次数上限,仅在API的安全认证方式为APP认证时适用。
BACKEND_UNAVAILABLE:后端不可用 BACKEND_TIMEOUT:后端超时 THROTTLED:调用次数超出阈值 UNAUTHORIZED:应用未授权 ACCESS_DENIED:拒绝访问 NOT_FOUND:未找到匹配的API REQUEST_PARAMETERS_FAILURE:请求参数错误
second 仅在请求消息头包含X-Apig-Mode: debug,且API配置了用户流量限制时,返回此参数 X-Apig-RateLimit-app 凭据流量限制信息 示例:remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: d
curl -X POST https://{iam_endpoint}/v3/auth/tokens -H 'content-type: application/json' -d '{ "auth": { "identity": { "methods": [ "password"
String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 暂不支持 roma_app_name String 自定义认证所属应用名称 暂不支持 表6 Identity 参数 参数类型 描述 name String
请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 待校验的API分组名称 roma_app_id 否 String 集成应用ID 暂不支持 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String
String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 暂不支持 roma_app_name String 自定义认证所属应用名称 暂不支持 表6 Identity 参数 参数类型 描述 name String
状态码: 404 Not Found { "error_code" : "APIG.3093", "error_msg" : "App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist" } 状态码: 500 Internal
String 分组版本 V1:全局分组 V2:应用级分组 V2暂不支持,默认为V1 roma_app_id String 分组归属的集成应用编号。 分组版本V2时必填。 暂不支持 roma_app_name String 分组归属的集成应用名称 暂不支持 表4 UrlDomain 参数