检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
缺省响应,描述未定义的响应码 status_code 否 Object 响应状态码,值为响应对象,参考表12 x-apigateway-result-failure-sample 否 String 失败返回示例,描述API的异常返回信息 x-apigateway-result-normal-sample
缺省响应,描述未定义的响应码 status_code 否 Object 响应状态码,值为响应对象,参考表11 x-apigateway-result-failure-sample 否 String 失败返回示例,描述API的异常返回信息 x-apigateway-result-normal-sample
缺省响应,描述未定义的响应码 status_code 否 Object 响应状态码,值为响应对象,参考表12 x-apigateway-result-failure-sample 否 String 失败返回示例,描述API的异常返回信息 x-apigateway-result-normal-sample
API网关支持的自定义认证需要借助函数工作流服务实现,用户在函数工作流中创建自定义认证函数,API网关调用该函数,实现自定义认证。下面以Basic认证为例,介绍如何使用函数服务实现自定义认证。 操作流程 编写自定义认证函数 创建一个函数作为用户自己的认证服务。 创建自定义认证 在APIG中创建一个自定义认证,将函数服务接入APIG。
G的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎(Cloud Container Engine,即CCE)中的工作负载,以及微服务,可通过API网关将服务能力以API形式对外开放。 使用APIG专享版开放本地数据中心的服务能力
例如您有一个API,请求协议为HTTPS,Path为/apidemo,开启了公网访问,并为分组绑定了独立域名后,可使用https://{domain}/apidemo这个URL访问您的API。其中,{domain}表示已绑定到分组的独立域名,目标端口443可默认缺省。 公网出口 指允许API的后端服务部署在外部网络
ication/xml”、“text/plain”和“multipart/form-data”。选择内容格式类型前,请确保后端服务支持待选择的内容格式类型。 请求体内容描述 填写API请求中请求体的描述信息,用于帮助API调用者理解如何正确封装API请求。 请求体Base64编码
pe(取值仅限为application/x-www-form-urlencoded、multipart/form-data、text/plain时)默认允许在请求中携带,无需在该参数中设置。 说明: 创建跨域资源共享策略时,默认不配置Allowed Headers,不允许跨域请求携带任何自定义请求头。
仅当“请求方法”选择“POST”、“PUT”、“PATCH”或“ANY”时可配置。 填写API请求中请求体的描述信息,用于帮助API调用者理解如何正确封装API请求。 (可选)设置入参定义。 入参定义是指您调用API时,需要传入的参数的说明。 单击“添加入参定义”,弹出“添加入参定义”对话框。
"auth_request": { "method": "GET", "protocol": "HTTPS", "url_domain": "192.168.10.10", "timeout": 5000, "path": "/", "vpc_channel_enabled":
Content-Type:取值范围:application/x-www-form-urlencoded、multipart/form-data、text/plain 对于简单请求,浏览器自动在头信息之中,添加一个Origin字段,Origin字段用于说明本次请求来自哪个源(协议+域名+端口)。服务器
[\"user_name\"]}"} backend_token_allow_users 透传token到后端普通租户白名单,匹配普通租户domain name正则表达式。 - - sign_basic 签名密钥是否支持basic类型。 否 - - - - - multi_auth API是否支持双重认证方式。
Content-Type:取值范围:application/x-www-form-urlencoded、multipart/form-data、text/plain 对于简单请求,浏览器自动在头信息之中,添加一个Origin字段,Origin字段用于说明本次请求来自哪个源(协议+域名+端口)。服务器
响应请求体大于1KB时,您可以使用gzip压缩文件(即1KB以下的文件不做压缩)。 gzip压缩支持的文件类型有text/xml、text/plain、text/css、application/javascript、application/x-javascript、applicatio
英文逗号分隔。 描述 API的描述,长度为1~1000个字符。 请求体内容描述 填写API请求中请求体的描述信息,用于帮助API调用者理解如何正确封装API请求。 根据下表参数信息,配置安全配置。 表3 安全配置 参数 说明 类型 API类型: 公开:选择“公开”类型时,API支持上架。