检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
字符长度不能大于255。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "DEVELOP", "remark": "开发环境" } 响应消息 表4 参数说明 参数 类型 说明 id String 环境ID name String
page_no, id, name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name。 请求消息 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String
一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。 同一个API发布到不同的环境可以绑定不同的流控策略;一个AP
实例ID,可从API网关控制台的专享版实例信息中获取。 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 authed_nums Integer 已进行API访问授权的APP个数 unauthed_nums Integer 未进行API访问授权的APP个数 响应消息样例: { "authed_nums":
查询条件可为以下字段以及对应的值:id、name。 请求消息 表2 参数说明 名称 是否必选 类型 说明 id 否 String 签名密钥编号 name 否 String 签名密钥名称 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称
一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。 同一个API发布到不同的环境可以绑定不同的流控策略;一个AP
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
断路器策略是API网关在后端服务出现性能问题时保护系统的机制,支持通过熔断降级的方式保护后端服务。 身份认证策略支持通过AKSK、Token等多种方式进行服务认证,支持用户通过函数自定义API访问认证逻辑,支持对后端服务进行证书校验,支持签名密钥用于后端服务验证API网关的身份。 VPC通道(负载通道)
页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持variable_name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的环境总数 size Integer 本次返回的列表长度 envs
以便更好地兼容已有业务能力。 API网关支持的自定义认证需要借助函数工作流服务实现,用户在函数工作流中创建自定义认证函数,API网关调用该函数,实现自定义认证。下面以Basic认证为例,介绍如何使用函数服务实现自定义认证。 编写自定义认证函数 在函数工作流的控制台编写函数,自定义
导入HTTP类型后端服务API示例 导入HTTP VPC类型后端服务API示例 导入FUNCTION类型后端服务API示例 导入MOCK类型后端服务API示例 导入HTTP类型后端服务API示例 包含IAM认证和请求参数编排的GET方法API定义,后端服务类型为HTTP。 Swagger示例:
是否必选 类型 说明 id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 name String 名称 remark String 描述 响应消息样例: { "id": "14b399ac-967f-4115-bb62-c0346b4537e9"
进行签名,执行此函数会在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。 X-Sdk-Date是一个必须参与签名的请求消息头参数。 1 sig.Sign(r) 访问API,查看访问结果。 1 2 3 resp = requests.request(r.method
Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的环境总数 size Integer 本次返回的列表长度 envs
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已创建API分组和分组内的API。 已搭建完成后端服务。 操作步骤
配置项的编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 查询到的配置项总数 size Integer 本次查询返回的列表长度
实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 name String 名称 remark String 描述 响应消息样例: { "id": "14b399ac-967f-4115-bb62-c0346b4537e9"