检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
正常响应示例,描述API的正常返回信息 表10 security参数说明 名称 是否必选 参数类型 说明 apig-auth-type 否 Object API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam
正常响应示例,描述API的正常返回信息 表10 security参数说明 名称 是否必选 参数类型 说明 apig-auth-type 否 Object API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam
使用APIG专享版实现gRPC服务的路由转发 使用APIG专享版实现gRPC服务的路由转发方案概述 使用APIG专享版实现gRPC服务的路由转发操作流程 使用APIG专享版实现gRPC服务的路由转发实施步骤 父主题: 开放API
查看证书详情 功能介绍 查看证书详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
HMAC:填写hmac认证所使用密钥对的Secret。 Basic:填写basic认证所使用的密码。 确认Secret 填写与Secret一致的值。 单击“确定”,完成密钥的创建。 绑定API 单击“开放API > 签名密钥”,进入签名密钥管理信息页面。 通过以下任意一种方法,查看签名密钥已绑定API列表页面。
户端)的相关服务有网络安全策略的设置,需要修改相应的网络安全策略,放通对应IP的访问。 内网出入口的变化 每个专享版实例都会拥有一个VPC内的入口私有IP,以及VPC内的多个出口私有IP(专享实例的基础版、专业版、企业版,以及铂金版分别有3、5、6、7个私有地址。在铂金版的基础上
单击分组名称,进入API所属分组的详情页面。 在“分组信息”页签的“域名管理”区域,找到已绑定的独立域名,在“支持http to https自动重定向”列开启重定向功能。 验证重定向是否生效 通过浏览器采用https协议调用API。 在浏览器的地址栏中输入“https://API请求路径”后回车。
error_code String 解除绑定失败的错误码 error_msg String 解除绑定失败的错误信息 api_id String 解除绑定失败的API的ID api_name String 解除绑定失败的API的名称 状态码: 400 表7 响应Body参数 参数
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境
查看或编辑APIG的API信息 API列表支持查看或编辑当前实例下所有的API,查看或编辑API的运行环境、请求方法、请求路径等信息。 查看或编辑API信息 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”,您可以
参数 参数类型 描述 restrict_cidrs Array of strings 受限的IP网段的CIDR列表。 resource_subnet_cidr String 资源租户的IP网段的CIDR。 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境
该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 app_call_limits 否 Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 ip_call_limits
绑定流控策略 功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。 当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时
CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 stage 否 String 调试请求指定的运行环境,仅在mode为CONSUMER时有效,未提供时有如下默认值:
该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 app_call_limits 否 Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 ip_call_limits
使用APIG专享版实现不同后端服务的调用 使用APIG专享版实现不同后端服务的调用方案概述 使用APIG专享版实现不同后端服务的调用操作流程 使用APIG专享版实现不同后端服务的调用实施步骤 父主题: 开放API
单击分组名称,进入“分组信息”页面。 在“API运行”页面的“监控视图”区域,单击“查看更多监控”,返回“云服务监控”界面,参考创建告警规则为API网关创建告警规则。 父主题: 查看监控指标与配置告警
删除SSL证书 功能介绍 删除ssl证书接口,删除时只有没有关联域名的证书才能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/certificates/{certificate_id} 表1 路径参数 参数 是否必选