检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
CONSUMER:API消费者授权 auth_tunnel String 授权通道类型 NORMAL:普通通道 GREEN:绿色通道 暂不支持,默认NORMAL auth_whitelist Array of strings 绿色通道的白名单配置 auth_blacklist Array
信息。 在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。 API网关管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。 表2 新增变量 参数 说明 变量名称 变量的名称,必须与创建API时定义的变量标识完全相同。在API定义中等于#Nam
最小值:0 最大值:100 dict_code String VPC通道后端服务器组的字典编码 支持英文,数字,特殊字符(-_.) 暂不支持 最小长度:3 最大长度:64 microservice_version String VPC通道后端服务器组的版本,仅VPC通道类型为微服务时支持。
reset_time 否 String 首次配额重置时间点,不配置默认为首次调用时间计算 remark 否 String 参数说明和描述。 不支持<,>字符 最大长度:255 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 app_quota_id String
reset_time 否 String 首次配额重置时间点,不配置默认为首次调用时间计算 remark 否 String 参数说明和描述。 不支持<,>字符 最大长度:255 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 app_quota_id String
流控时间内能够被调用多少次。 enable_adaptive_control String 是否开启动态流控: TRUE FALSE 暂不支持 user_call_limits Integer 用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量
例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。 API网关管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。 创建环境变量 选择“开放API > API分组”,进入到API分组信息页面。 通过以下任意一种方式,进入“变量管理”页签。
Array of Failure objects 导入失败信息 swagger Swagger object swagger文档导入结果 暂不支持 group_id String API分组编号 ignore Array of Ignore objects 被忽略导入的API信息 表5
其它4XX类错误 默认5XX - 其它5XX类错误 未找到匹配的API 404 未匹配到API 请求参数错误 400 请求参数校验失败、不支持的HTTP方法 调用次数超出阈值 429 API调用次数超出所配置的流量策略阈值 应用未授权 401 使用的应用未被授权访问该API API网关运行时可获取变量
流控时间内能够被调用多少次。 enable_adaptive_control String 是否开启动态流控: TRUE FALSE 暂不支持 user_call_limits Integer 用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量
查看版本详情 功能介绍 查询某个指定的版本详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/ap
拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: 未匹配到API错误 REQUEST_PARAMETERS_FAILURE: 请求参数校验失败、不支持的HTTP方法 DEFAULT_4XX: 其它4XX类错误 DEFAULT_5XX: 其它5XX类错误 THIRD_AUTH_FAILURE:
bind_num Integer 流控策略绑定的API数量 enable_adaptive_control String 是否开启动态流控,暂不支持 响应消息样例: { "total": 1, "size": 1, "throttles": [{ "id": "0325b67
添加后端实例(云服务器) 功能介绍 为指定的VPC通道添加云服务器。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/vpc-channels/{id}/members URI中的参数说明如下表所示。
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
is_backup Boolean 是否备用节点。 开启后对应后端服务为备用节点,仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能,如果不支持请联系技术支持。 缺省值:false member_group_name String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。
APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/instan
其它4XX类错误 默认5XX - 其它5XX类错误 未找到匹配的API 404 未匹配到API 请求参数错误 400 请求参数校验失败、不支持的HTTP方法 调用次数超出阈值 429 API调用次数超出所配置的流量策略阈值 凭据未授权 401 使用的凭据未被授权访问该API API网关运行时可获取变量
ret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。