检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见HTTP状态码。 对于创建API分组(专享版API)接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头
数组长度:0 - 20 sys_tags 否 Array of TmsKeyValues objects 企业项目.仅op_service权限可以使用此字段做资源实例过滤条件. 无sys_tags时按照tag接口处理,无tag过滤条件时返回全量数据。 数组长度:0 - 1 matches
subscription:订阅应用 integration:集成应用 暂不支持 tags Array of strings API绑定的标签,标签配额默认10条,可以联系技术调整。 最小长度:1 最大长度:128 数组长度:0 - 10 env_name String api授权绑定的环境名称 app_id
subscription:订阅应用 integration:集成应用 暂不支持 tags Array of strings API绑定的标签,标签配额默认10条,可以联系技术调整。 最小长度:1 最大长度:128 数组长度:0 - 10 env_name String api授权绑定的环境名称 app_id
API编号 req_method String API请求方法 tags Array of strings API绑定的标签,标签配额默认10条,可以联系技术调整。 最小长度:1 最大长度:128 数组长度:0 - 10 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code
创建告警规则 操作场景 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
方案概述 应用场景 当用户后端服务器所在的VPC与创建实例所选择的VPC处于不同的场景时,该如何完成服务配置,以实现跨VPC对接?本文以Elastic Load Balance(弹性负载均衡ELB)为例,讲述如何在API网关上开放内网ELB中的服务。 方案架构 图1 API网关跨VPC开放后端服务
导出API 操作场景 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出API
服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例,描述API的正常返回信息 result_failure_sample
服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例,描述API的正常返回信息 result_failure_sample
IAM认证信息错误 IAM认证信息错误有: Incorrect IAM authentication information: verify aksk signature fail Incorrect IAM authentication information: AK access
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。
数。 如果某个网关组件在时间窗内的触发次数超过阈值,则发送到该网关组件上的请求会触发断路器,其他未超过阈值的网关组件依然正常转发请求。 您可以在API网关实例控制台的“实例信息”页面,在“出私网IP”下查看网关组件的IP个数,一个IP表示为一个网关组件。 最小调用次数 仅当“条件模式”选择“百分比”时需配置。
服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例,描述API的正常返回信息 result_failure_sample
服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例,描述API的正常返回信息 result_failure_sample
Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark 否 String API请求体描述,可以是请求体示例、媒体类型、参数等信息 字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 result_normal_sample
Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark 否 String API请求体描述,可以是请求体示例、媒体类型、参数等信息 字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 result_normal_sample
Bool 是否支持跨域 TRUE:支持 FALSE:不支持 默认:FALSE body_remark 否 String API请求体描述,可以是请求体示例、媒体类型、参数等信息 字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 result_normal_sample
Android 操作场景 使用Android语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 已安装Android Studio 4.1.2或以上版本,如果未安装,请至Android
String API分组绑定的子域名 paths 是 Object 参考表 paths参数说明 responses 是 Object 公用响应定义,可以被引用在{method}的操作中,参考表9 securityDefinitions 是 Object 定义鉴权方式,参考表13 x-api