检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
quota_left Integer 剩余访问次数 quota_used Integer 已使用访问次数 app_key String 生成的APP的key app_secret String 生成的APP的secret 响应参数样例: { "total": 3, "size": 3, "purchases":
参数 是否必选 类型 说明 appcode-auth-type 否 String AppCode简易认证类型,默认为disable。 disable:不开启简易认证 header:开启简易认证且AppCode位置在HEADER。 父主题: APIG的API设计文件扩展定义
状态 1: 有效 app_type String APP的类型: apig:存量apig应用,不推荐使用 roma:roma集成应用 默认apig,暂不支持其他类型 roma_app_type String ROMA_APP的类型: subscription:订阅应用 integration:集成应用
删除APP 功能介绍 删除指定的APP。 APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}
String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time Timestamp 与已绑定的流控策略的绑定时间 auth_type String API的认证方式 req_uri
String 发布的环境名 run_env_id String 发布的环境编号 publish_id String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time
该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 app_call_limits 否 Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 ip_call_limits
APIG支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 SYS.APIC 监控指标 表1 监控指标说明 指标ID
Integer 满足条件的流控策略总数 size Integer 本次查询返回的列表长度 throttles 字典数据类型 本次查询返回的流控策略列表 表4 throttles参数说明 参数 类型 说明 id String 流控策略的ID name String 流控策略的名称 api_call_limits
校验APP 功能介绍 校验app是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/inst
置。如需自定义跨域的请求头、跨域的请求方法和指定授权访问的域,请使用配置API的跨域资源共享。 简单请求的跨域访问 如果是创建新的API,在“安全配置”时,勾选“开启支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 非简单请求的跨域访问 非简单请求的跨域访问可通过两种配置方式实现,选择其中一种配置即可。
Integer 满足条件的流控策略总数 size Integer 本次查询返回的列表长度 throttles 字典数据类型 本次查询返回的流控策略列表 表4 throttles参数说明 参数 类型 说明 id String 流控策略的ID name String 流控策略的名称 api_call_limits
app-codes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_id 是 String 应用编号
规则名称 填写编排规则的名称,根据规划自定义。支持英文、数字、下划线,且只能以英文开头,长度为3~64个字符。 编排策略 选择编排策略。 list:列表中的值映射成另外的值。 range:范围中的值映射成另外的值。 hash:请求头的值经过哈希计算后直接映射为新的请求头。 hash_
选择API需要发布到的环境,并填写发布说明。 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择的环境时没有自己需要的环境,可以创建一个自己需要的环境。 单击“确定”,API发布成功后,“发布最新版本”按钮左上角的红色感叹号消失。 已发布的API因为其他原因
支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、中划线、下划线组成,且只能以英文开头。 说明: 需要服从URI规范。 auth_type String API的认证方式 NONE:无认证 APP:APP认证 IAM:IAM认证 AUTHORIZER:自定义认证
ken的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apps Array of AppQuotaAppInfo objects 凭据列表 表5 AppQuotaAppInfo
api_name API名称。 36 app_name 当使用APP认证访问时,请求方使用的APP名称。 37 provider_app_id API所属的APP ID。 38 provider_app_name API所属的APP名称。 39 custom_data_log1 用户自定义日志字段值1。
2:关闭 APP_API_KEY_SWITCH:是否启用APP_API_KEY认证方式 APP_BASIC_SWITCH:是否启用APP_BASIC认证方式 APP_JWT_SWITCH:是否启用APP_JWT认证方式 APP_ROUTE_SWITCH:是否启用APP路由 PUB
API的后端服务地址支持填写私有地址(子网IP)吗? 专享版:支持。实例所在同一个vpc子网内IP,或者通过专线打通的本地数据中心私有地址。 不支持专享版的网段: 0.0.0.0/8 10.0.0.0/8 100.125.0.0/16 127.0.0.0/8 169.254.0.0/16