检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
类型 说明 acl-type 是 String 访问控制行为,支持PERMIT、DENY。 entity-type 是 String 访问控制对象,仅支持IP。 value 是 String 访问控制策略值,多个值以“,”间隔。 父主题: APIG的API设计文件扩展定义
acl_value String ACL策略值,支持一个或多个值,使用英文半角逗号分隔 entity_type String ACL策略约束对象。取值范围: IP DOMAIN (租户名称) 请求消息样例: { "acl_name": "string", "acl_type": "PERMIT"
特殊流控策略类型,支持APP、USER。 limit 是 Number API的访问次数。 instance 是 String 特殊APP或USER的对象标识。 父主题: APIG的API设计文件扩展定义
否 String 名称 acl_type 否 String 类型:PERMIT或DENY entity_type 否 String 作用的对象类型:IP或DOMAIN page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1
call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 apply_time String 设置时间 app_name String 作用的APP名称 app_id String 作用的APP编号 object_id String 特殊对象的身份标识 object_type
原始请求的请求参数(header参数和query参数)调用第三方鉴权接口进行鉴权。 宽松模式 开关开启后,当鉴权服务不可用(与鉴权服务建立连接失败或者鉴权服务返回5xx)时,API网关仍然接受客户端请求。 允许携带原始请求体 开关开启后,将携带API原始请求体调用鉴权接口鉴权。 请求体大小(字节)
否 Boolean 是否共享流控策略。 special 否 x-apigateway-ratelimits.policy.special 对象数组 特殊流控策略。 父主题: APIG的API设计文件扩展定义
策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type
策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type
PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 entity_type String 对象类型: IP DOMAIN update_time Timestamp 更新时间 响应消息样例: { "id": "d402b35e-1
全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 单击“导出”,右侧显示导出结果。
PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 entity_type String 对象类型: IP DOMAIN update_time Timestamp 更新时间 响应消息样例: { "id": "d402b35e-1
acl_type 否 String 类型 PERMIT (白名单类型) DENY (黑名单类型) entity_type 否 String 作用的对象类型: IP DOMAIN precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求参数 表3
Swagger或OpenAPI文件。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON、YAML或YML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 OpenAPI版本
entity_type为DOMAIN_ID时,策略值需填写账号ID,获取方式请参见API参考的“附录 > 获取账号ID”章节。 entity_type 是 String 对象类型: IP:IP地址 DOMAIN:账号名 DOMAIN_ID:账号ID 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型
API的ID $context.apiName API名称 $context.appId API调用者的凭据对象ID $context.appName API调用者的凭据对象名称 $context.requestId 当次API调用生成请求ID $context.stage API调用的部署环境
命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期(原始指标) avg_latency 平均延迟毫秒数 该指标用于统计测量api接口平均响应延时时间 ≥0 单位:毫秒 单个API
如果需要查看实例、实例节点的监控信息,请单击“查看更多监控”,查看更多的监控数据。 监控数据保留周期为两天,如果需要长时间保留,需要配置OBS桶,将监控数据保存至OBS桶中,具体步骤请参见配置OBS数据存储。 查看API分组的监控指标 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
(白名单类型) DENY (黑名单类型) acl_value String ACL策略值 entity_type String ACL策略作用的对象类型: IP DOMAIN ADMIN env_id String 生效的环境编号 env_name String 生效的环境名称 bind_id
策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表25 auth_opt参数说明 参数 类型 说明 app_code_auth_type