检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API 无法创建API是什么原因? API的响应码如何定义? API的后端服务是否支持绑定私网ELB地址? API的后端服务地址支持填写私有地址(子网IP)吗? APIG是否支持多后端节点方案? API可以绑定内网域名吗? 为什么跨域调用API失败? API网关如何开放部署在华为云上的服务?
req_method String API的请求方式,当API的请求协议为GRPC类型协议时请求方式固定为POST。 req_uri String 请求地址。可以包含请求参数,用{}标识,比如/getUserInfo/{userId},支持 * / %- _ . 等特殊字符,总长度不超过512,且满足URI规范。
如果使用自定义策略,请参考APIG自定义策略。 子网中可用私有地址数量 API网关专享实例的基础版、专业版、企业版,以及铂金版分别需要3、5、6、7个私有地址。在铂金版的基础上,铂金版X依次增加4个私有地址。请确保您选择的子网段有足够多的私有地址可用,私有地址可在虚拟私有云服务的控制台查询。 网络环境准备
API请求中允许携带的Body大小上限,默认值为12MB,可修改范围为1MB~9536MB。 支持通过POST方法上传文件,目前仅支持对请求体透传。 backend_timeout 后端响应超时时间上限,默认值为60000ms,可修改范围为1ms~600000ms。 app_token ap
ANY req_uri 是 String 请求地址 说明: 需要服从URI规范。 timeout 是 Integer API网关请求后端服务的超时时间,最大60000,最小为1 单位:毫秒 默认值:45000,请求参数值不在合法范围内时将使用默认值 remark 否 String
是 String API的请求方式,当API的请求协议为GRPC类型协议时请求方式固定为POST。 req_uri 是 String 请求地址。可以包含请求参数,用{}标识,比如/getUserInfo/{userId},支持 * / %- _ . 等特殊字符,总长度不超过512,且满足URI规范。
ANY req_uri 是 String 请求地址 说明: 需要服从URI规范。 timeout 是 Integer API网关请求后端服务的超时时间,最大60000,最小为1 单位:毫秒 默认值:45000,请求参数值不在合法范围内时将使用默认值 remark 否 String
通过浏览器采用https协议调用API。 在浏览器的地址栏中输入“https://API请求路径”后回车。 在键盘上按F12。 在“网络”页签中状态码显示“200”表示调用成功。 通过浏览器采用http协议调用API。 在浏览器的地址栏中输入“http://API请求路径”后回车。 在键盘上按F12。
您需保证当前实例与微服务实例地址网络可达,否则导入后调用API会出现失败场景。 未选择服务契约时,导入后会生成一个请求方法为ANY、请求路径为/且匹配模式为前缀匹配的API。 导入后会生成相应的API以及微服务类型的负载通道,负载通道会监测微服务下所有在线实例的地址变化,并更新到负载通道中。
instance_id String 云服务器的ID。 host String 云服务器的主机地址 weight Integer 权重值。 权重值越大,转发到该云服务器的请求数量越多。 取值范围1 ~ 100。 create_time Timestamp 云服务器增加到VPC通道的时间。
如果不使用VPC通道,需要设置后端服务地址。 填写后端服务的访问地址,格式:“主机:端口”。主机为后端服务的访问IP地址/域名,未指定端口时,HTTP协议默认使用80端口,HTTPS协议默认使用443端口。 如果后端服务地址中需要携带环境变量,则使用“#变量名#”的形式将环境变量添加到后端服务地址中,如#i
是 String 函数URN地址 version 是 String 函数版本 invocation-type 是 String 函数调用类型,支持async、sync timeout 否 Integer 函数超时时间,单位毫秒,缺省值为5000,取值范围为1 ~ 60000 description
是 String 函数URN地址 version 是 String 函数版本 invocation-type 是 String 函数调用类型,支持async、sync timeout 否 Integer 函数超时时间,单位毫秒,缺省值为5000,取值范围为1 ~ 60000 description
使用接口测试工具调用API。 本实践通过IP调用DEFAULT分组下的API,输入“wss://IP地址/hello”发送请求即可。其中,IP地址为APIG控制台“实例信息”中的弹性IP地址。 父主题: 开放API
API调用是否存在带宽限制 API的流量控制策略不生效怎么处理? 怎样给指定的用户开放API? API访问控制策略配置的IP地址是否为客户端的IP地址?
instance_id String 云服务器的ID。 host String 云服务器的主机地址 weight Integer 权重值。 权重值越大,转发到该云服务器的请求数量越多。 取值范围1 ~ 100。 create_time Timestamp 云服务器增加到VPC通道的时间。
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.
在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。 对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。