检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
{b+}。 端口 填写CCE工作负载的监测端口号。 安全认证 支持APP认证、华为IAM认证和无认证。 APP认证:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。 华为IAM认证:表示借助IAM服务进行安全认证。 无认证:表示不需要认证。 支持跨域CORS
参数位置:用于规则匹配的参数位置。 path:API请求的URI,系统默认配置。 method:API请求方法,系统默认配置。 header:请求头的key值。 query:QueryString的key值。 system:系统参数。 参数:用于判断与规则中的参数值是否匹配。 定义规则 定义用于规则的判断条件。
7 request_time 请求延迟 8 request_method HTTP请求方法 9 scheme 请求协议 10 host 请求域名 11 router_uri 请求URI 12 server_protocol 请求协议 13 status 响应状态码 14 bytes_sent
应用场景 企业内部系统解耦 随着企业的高速发展、业务的快速变化,需要企业内部系统跟随业务需求一同变化,但是企业内部系统存在相互依赖关系,为保持系统的通用性与稳定性,很难应对业务的变化。而API网关使用RESTful API, 帮您简化服务架构,通过规范化、标准化的API接口,快速
策略的配置内容,支持表单配置和脚本配置两种方式。 镜像协议 镜像请求协议。指定的镜像服务协议须与用户的镜像业务协议保持一致。 镜像地址 镜像服务的地址。由IP/域名和端口号组成,总长度不超过255。格式为主机:端口(如:xxx.xxx.xxx:7443)。如果不写端口号,那么HTTPS默认端口号为443,HTTP默认端口号为80。
os.getenv('HUAWEICLOUD_SDK_AK1'): os.getenv('HUAWEICLOUD_SDK_SK1'), os.getenv('HUAWEICLOUD_SDK_AK2'): os.getenv('HUAWEICLOUD_SDK_SK2')
类型 说明 url_domain 后端服务不使用VPC通道时,必选 String 后端的Endpoint。 由域名(或IP地址)和端口号组成,总长度不超过255。格式为域名:端口(如:apig.example.com:7443)。如果不写端口,则HTTPS默认端口号为443, HTTP默认端口号为80。
是否必选 类型 说明 url_domain 后端服务不使用VPC通道时,必选 String 后端服务的地址。 由域名(或IP地址)和端口号组成,总长度不超过255。格式为域名:端口(如:apig.example.com:7443)。如果不写端口,则HTTPS默认端口号为443, HTTP默认端口号为80。
是否必选 类型 说明 url_domain 后端服务不使用VPC通道时,必选 String 后端服务的地址。 由域名(或IP地址)和端口号组成,总长度不超过255。格式为域名:端口(如:apig.example.com:7443)。如果不写端口,则HTTPS默认端口号为443, HTTP默认端口号为80。
类型 说明 url_domain 后端服务不使用VPC通道时,必选 String 后端的Endpoint。 由域名(或IP地址)和端口号组成,总长度不超过255。格式为域名:端口(如:apig.example.com:7443)。如果不写端口,则HTTPS默认端口号为443, HTTP默认端口号为80。
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
result_failure_sample String 失败返回示例,描述API的异常返回信息 sl_domain String 分组的二级域名 req_params 字典数据类型 API的请求参数列表 表5 req_params参数说明 参数 类型 说明 id String 参数编号
前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简
说明 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
过滤查询结果 查询资源列表时(例如,查询API列表),系统支持按照查询对象的属性过滤查询结果。 示例: GET /v1.0/apigw/apis?id=xxxx 父主题: 附录
对象模型 管理系统的默认配置,管理租户可以根据系统的实际运行情况对这些配置的值进行修改。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 系统配置对象模型