检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String APP的名称 支持汉字,
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
后端:对后端服务的访问授权。 函数地址 选择在FunctionGraph中创建的函数。 版本或别名 选择函数的版本或别名,函数的版本或别名功能请参考《函数工作流 FunctionGraph用户指南》。 缓存时间(秒) 设置认证结果缓存的时间。 取值范围为0s~3600s,值为0时代表不缓存,最大支持3600s。
API网关控制台提供的调试功能,用的是特定的debug环境,调试完成后需先发布到对应环境,之后可使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: API发布
String 实例ID,在API网关控制台的“实例信息”中获取。 env_id 是 String 环境的ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口
是否使用VPC通道访问后端服务。 如果使用VPC通道,选择已创建的VPC通道名称。 VPC通道中,云服务器的安全组必须允许100.125.0.0/16网段访问,否则将导致健康检查失败及业务不通。 如果不使用VPC通道,需要设置后端服务地址。 填写后端服务的访问地址,格式:“主机:
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
选择API认证方式,此处选择“自定义认证”。 自定义认证 选择前提条件中已创建的自定义认证。 配置API后端 前端设置完成后,单击“下一步”,进入后端设置页面。 设置“默认后端”的后端服务类型为“Mock”类型,Mock返回结果填写“默认后端”。 单击根据下表添加策略后端。 表2
0支持 购买API网关 修改子网网络信息 本小节指导您顺利购买专享版实例,实例创建完成后,才能创建API并对外提供服务。如果您对服务的性能需求不大,可使用共享版API网关,直接创建与管理API,而无需单独购买专享版实例。 删除子网 当无需使用子网、需要释放网络资源时,可删除子网。 支持区域:
已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。 单击“开放API >
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String API分组的名称。 长度为3
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
关闭实例公网入口 功能介绍 关闭实例公网入口,仅当实例为ELB类型时支持 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/ingress-eip 表1 路径参数 参数 是否必选 参数类型
开启实例公网入口 功能介绍 开启实例开启公网入口,仅当实例为ELB类型时支持 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/ingress-eip 表1 路径参数 参数 是否必选 参数类型
统计测量api接口被调用的次数。 ≥0 测量对象:专享版API网关实例 测量维度:instance_id 1分钟 error_4xx 4xx异常次数 统计测量api接口返回4xx错误的次数。 ≥0 测量对象:专享版API网关实例 测量维度:instance_id 1分钟 error_5xx
位时间,以此类推。 时长 填写配额限制的时长,单位可选择“秒”、“分”、“时”和“天”。需与“API访问限制”配合使用,表示单位时间内客户端可调用API的总次数上限。 API访问限制 填写客户端可调用API的次数上限,与“时长”配合使用。 描述 填写客户端配额策略的描述信息。 策略配置完成后,单击“确定”。
Code 删除APP Code 查看APP Code详情 查询APP Code列表 查询凭据关联的凭据配额 设置APP的访问控制 查看APP的访问控制详情 删除APP的访问控制 父主题: 专享版API(V2)
名每天最多可以访问1000次。 路径:接口请求路径。此处填写“/hello”。 网关响应 API网关未能成功处理API请求,从而产生的错误响应。此处默认“default”。 安全认证 选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用)
查询某个实例的租户配置列表 功能介绍 查询某个实例的租户配置列表,用户可以通过此接口查看各类型资源配置及使用情况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs