检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
类型 说明 url_domain 后端服务不使用VPC通道时,必选 String 后端的Endpoint。 由域名(或IP地址)和端口号组成,总长度不超过255。格式为域名:端口(如:apig.example.com:7443)。如果不写端口,则HTTPS默认端口号为443, HTTP默认端口号为80。
前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
result_failure_sample String 失败返回示例,描述API的异常返回信息 sl_domain String 分组的二级域名 req_params 字典数据类型 API的请求参数列表 表5 req_params参数说明 参数 类型 说明 id String 参数编号
过滤查询结果 查询资源列表时(例如,查询API列表),系统支持按照查询对象的属性过滤查询结果。 示例: GET /v1.0/apigw/apis?id=xxxx 父主题: 附录
对象模型 管理系统的默认配置,管理租户可以根据系统的实际运行情况对这些配置的值进行修改。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 系统配置对象模型
说明 swagger 是 String 固定值2.0 info 是 Object 参考表4 host 是 String API分组绑定的子域名 paths 是 Object 参考表 paths参数说明 responses 是 Object 公用响应定义,可以被引用在{method}的操作中,参考表9
说明 swagger 是 String 固定值2.0 info 是 Object 参考表5 host 是 String API分组绑定的子域名 paths 是 Object 参考表 paths参数说明 responses 是 Object 公用响应定义,可以被引用在{method}的操作中,参考表10
说明 swagger 是 String 固定值2.0 info 是 Object 参考表4 host 是 String API分组绑定的子域名 paths 是 Object 参考表 paths参数说明 responses 是 Object 公用响应定义,可以被引用在{method}的操作中,参考表9
说明 swagger 是 String 固定值2.0 info 是 Object 参考表5 host 是 String API分组绑定的子域名 paths 是 Object 参考表 paths参数说明 responses 是 Object 公用响应定义,可以被引用在{method}的操作中,参考表10
当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Appkey和AppSecret做签名和校验,也可以选择使用AppCode进行简易认证。 为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。 每个应用最多可创建5个AppCode。 前提条件 已创建应用。 生成AppCode
URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint:指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从终端节点中获取。例如APIG服务在“华北-北京四”区域的Endpoint为“apig
如果需要修改API参数,请在右上角单击“编辑”,进入API编辑页面。 后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API创建流控策略、创建访问控制策略和创建并使用签名密钥。 父主题: API管理
某个时间段的使用量和计费信息。 账单上报周期 包年/包月计费模式的资源完成支付后,会实时上报一条账单到计费系统进行结算。 按需计费模式的资源按照固定周期上报使用量到计费系统进行结算。按需计费模式产品根据使用量类型的不同,分为按小时、按天、按月三种周期进行结算,具体扣费规则可以参考
调用API提示AK/SK过期怎么处理? 客户端签名时将本地时间作为时间戳进行签名,如果本地时间与北京时间相差超过15min,网关会认为签名过期。 处理方法:修改系统时间为标准北京时间。 父主题: API认证
在CTS事件列表查看云审计事件 操作场景 用户进入云审计服务创建管理类追踪器后,系统开始记录云服务资源的操作。在创建数据类追踪器后,系统开始记录用户对OBS桶中数据的操作。云审计服务管理控制台会保存最近7天的操作记录。 云审计控制台对用户的操作事件日志保留7天,过期自动删除,不支持人工删除。
在CTS事件列表查看云审计事件 操作场景 用户进入云审计服务创建管理类追踪器后,系统开始记录云服务资源的操作。在创建数据类追踪器后,系统开始记录用户对OBS桶中数据的操作。云审计服务管理控制台会保存最近7天的操作记录。 云审计控制台对用户的操作事件日志保留7天,过期自动删除,不支持人工删除。
单个用户调用API次数上限,仅在API的安全认证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 凭据流量限制 单个凭据调用API次数上限,仅在API的安全认证方式为APP认证时适用。
分页显示查询结果 查询资源列表时(例如,查询API列表),系统支持分页显示查询结果。 在url后面拼接如下参数: page_size:每页查询多少条数据,如果不指定,默认20,最大值500。 page_no:需要查询的页码。 示例: GET /v1.0/apigw/apis?pa
参数位置:用于规则匹配的参数位置。 path:API请求的URI,系统默认配置。 method:API请求方法,系统默认配置。 Header:请求头的key值。 说明: 建议不要设置敏感信息,以防泄露。 Query:QueryString的key值。 System:系统参数。 参数:用于判断与规则匹配中的参数值是否匹配。