检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
String APP的key app_secret String 密钥 creator String APP的创建者,取值如下: USER:用户自行创建 MARKET:云商店分配 register_time Timestamp 创建时间 remark String 描述 update_time
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。
对象模型 管理系统的默认配置,管理租户可以根据系统的实际运行情况对这些配置的值进行修改。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 系统配置对象模型
对象模型 本节介绍环境变量的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选
功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
对象模型 本节介绍流控策略与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 流控策略限定关系对象模型 参数
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
创建App Code 功能介绍 App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apig
查看App Code详情 功能介绍 查看App Code详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{app_id}/app-codes/{id}
修改API后端服务的超时时间上限“backend_timeout”后未生效 问题描述 修改APIG实例参数“backend_timeout”后未生效。 可能原因 在“定义后端服务”中,“后端超时(ms)”未修改。 解决方法 登录控制台,进入目标API详情,单击“编辑”,在“定义后端服务”中配置“后端超时(ms)”。
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
删除变量 功能介绍 删除指定的环境变量。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/env-variables/{id} URI中的参数说明如下表所示。 表2 参数说明
解除绑定 功能介绍 解除API与流控策略的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttle-bindings/{id} URI中的参数说明如下表所示。
Integer 状态 app_key 否 String APP的KEY creator 否 String APP的创建者,取值如下: USER:用户自行创建 MARKET:云商店分配 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer
删除流控策略 功能介绍 删除指定的流控策略,以及该流控策略与API的所有绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttles/{id} URI中的参数说明如下表所示。
删除特殊设置 功能介绍 删除某个流控策略的某个特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttle-specials/{id} URI中的参数说明如下表所示。
查询租户配置详情 功能介绍 查询某个租户的配置项及其配置值。 URI 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/config/project[?page_size, page_no, config_id, config_name]
发布API 功能介绍 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
下线API 功能介绍 将API从某个已发布的环境上下线,下线后,API将无法再被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apis/publish/{api_id}[
对象模型 本节介绍APP与API之间的授权关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 APP授权关系对象模型 参数