结构体说明
page_info ApiInfoVO 名称 类型 是否必填 示例 描述 api_cache_model ApiCacheVO 否-API 缓存模型 api_group_id STRING 否 api_group_id1 API 分组标识 api_group_name STRING 否 api_group_name1 所属 API 分组名称 api_id STRING 否 8...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
自定义事件源API网关
步骤四：创建应用及对API授权 在 API网关控制台 的左侧导航栏，选择 调用API>应用管理。在 应用列表 页面，单击右上角的 创建APP，然后在 创建应用 对话框设置应用的名称和描述，单击 确定。回到 API列表 页面，找到 步骤三：创建API 中...
配置API触发
流水线触发方式包括手动触发、代码源触发和API触发，您可以根据实际业务配置不同的触发方式。设置API触发 打开流水线编辑界面，具体操作参见 打开流水线编辑界面。在流水线编辑界面，单击 触发条件 阶段>API触发 选项的，打开 API触发配置 ...
使用SDK调用API
1.下载SDK 控制台提供两种SDK的下载方式，如下：1.1 在 调用API 的 已授权API的SDK 中下载应用APP的SDK，此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java。其他语言调用示例在页面下方。1.2 在 开放API 的...
功能概览
发布和路由 提供API发布管理，线上版本一键切换；支持多环境管理，满足日常研发、预发测试、生产环境并行使用需求；支持灰度发布功能；支持参数路由，可根据HTTP请求内容创建不同的路由转发规则，提高系统灵活性；API可用性 支持API应答...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。...在两个分组上创建两个业务API 在每个分组下分别生成一个业务API，两个API均设置为APP鉴权模式，假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：...
如何指定调用环境？
调用API时，默认是调用线上环境的API。如果要调用测试环境，请在header中增加参数：X-Ca-Stage:TEST。如果要调用预发环境，请在header中增加参数：X-Ca-Stage:PRE。
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
离线文本结果
离线文本结果，展示您通过API上传的质检数据的质检结果，需要您自行进行API对接。离线文本结果：展示通过 上传文本质检UploadData 接口上传的数据。与 数据集质检 主要的区别是，呼叫中心质检的数据是经过API对接后自动推送过来的，而数据...
离线语音结果
离线质检结果，展示您通过API上传的质检数据的质检结果，需要您自行进行API对接。离线语音结果：展示通过 上传音频质检 接口上传的数据。与 数据集质检 主要的区别是，呼叫中心质检的数据是经过API对接后自动推送过来的，而数据集质检的...
DescribeApiLatencyData-查询API监控数据中对响应时间...
接口说明 查询指定 API 的监控信息：Latency(ms)此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI...
DescribeApiTrafficData-查询API监控数据中流量统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
DescribeApiQpsData-查询API监控数据中对QPS的统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
查看及管理API
说明 若API已被应用绑定或被组合API引用时，新版本发布到线上会影响API的调用，会根据API所属项目配置的发布管控机制，判断是否允许新版本发布到线上。版本管理：若下游应用调用API的API_ID无法修改，在API的数据源或查询条件发生变更后，...
API安全
API安全模块支持自动梳理已接入 Web应用防火墙（Web Application Firewall，简称WAF）防护的业务中开放的API资产，检测API风险（例如敏感数据泄露、内部接口暴露等），并通过报表还原API异常事件，提供详细的风险处理建议和API生命周期管理...
OpenAPI列表
API API说明 BindGroupToApp 绑定群组到应用。CreateGroupPageQuery 创建群组分页查询。说明 该API只有超级管理员（SuperAdmin）和系统管理员能够调用。GetOnlineClusterById 根据群组ID获取群组详情。GetOnlineFeatureById 根据标签ID获取...
飞线层
飞线层配置了API数据源为 https://api.test，传到 请求飞线 动作的数据为 { id:'1'}，则最终请求接口为 https://api.test?id=1导入飞线 按组件绘制格式处理数据后，导入组件，重新绘制。不需要重新请求服务端数据。具体数据示例请参见...
飞线层
例如飞线层配置了API数据源为 https://api.test，传到 请求飞线 动作的数据为 { id:'1'}，则最终请求接口为 https://api.test?id=1导入飞线 按组件绘制格式处理数据后，导入组件，重新绘制。不需要重新请求服务端数据。具体数据示例请...
热力线层
例如热力线层配置了API数据源为 https://api.test，传到 请求热力线层 动作的数据为 { id:'1'}，则最终请求接口为 https://api.test?id=1导入热力线层 按组件绘制格式处理数据后，导入组件，重新绘制。不需要重新请求服务端数据。具体...
od飞线层
例如od飞线层配置了API数据源为 http://api.test，传到 请求数据接口 动作的数据为 { id:'1'}，则最终请求接口为 http://api.test?id=1导入动态轨迹 按组件绘制格式处理数据后，导入组件，重新绘制。不需要重新请求服务端数据。具体数据...
购买指引-全托管
api.s2.large（最大10000 QPS）敏捷研发版（离线）暂不支持 标签工厂 版本 管控项 智能研发版（离线&实时）、基础研发版（离线&实时）试用版：离线标签5个、离线视图、行为关系、标签市场、标签离线服务、应用管理 基础版：离线标签50个、...
飞线层
例如飞线层配置了API数据源为 https://api.test，传到 请求飞线 动作的数据为 { id:'1'}，则最终请求接口为 https://api.test?id=1导入飞线 按组件绘制格式处理数据后，导入组件，重新绘制。不需要重新请求服务端数据。具体数据示例请...
I404NF错误码排查
这个报错是请求的Path或Method和API定义的不同，需要根据...如果API发布的环境并非线上，调用时需要指定调用环境。如果要调用测试环境，请在header中增加参数：X-Ca-Stage:TEST。如果要调用预发环境，请在header中增加参数：X-Ca-Stage:PRE。
环境管理
在API网关上进行环境管理的时候，您需要做两部分工作：API的后端服务环境：通过设置后端服务，为后端服务的测试、预发、线上环境分别定义不同值，从而当调用API时，API网关可以调用到不同的后端地址。API的前端调用：需要client端显式的...
ApiInfo
StageName String 环境名称，枚举为：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 Visibility String 可见性，枚举为：PUBLIC:公开 PRIVATE:私有 BoundTime String 绑定时间
DescribeApisByBackend-根据后端查询 API 列表
1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...
ApiHisItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...
DeployedApiItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 Visibility String 可见性，可选值：PUBLIC:公开 PRIVATE:私有 DeployedTime String 发布时间...
支持在线协议吗？如果是线下协议如何操作？
支持在线协议，在开通 API 网关服务时，需要签订使用协议。线下协议需告知 API 网关产品经理和相关法务。
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
自定义 JSAPI
代码注册 jsapi PSDJsApi*jsApi4DemoTest2=[PSDJsApi jsApi:@"demoTest2"handler:^(NSDictionary*data,PSDContext*context,PSDJsApiResponseCallbackBlock responseCallbackBlock){ responseCallbackBlock(@{@"result":@"jsapi-demoTest2...
步骤一：资源准备
创建Mock接口 实验中会对两个接口进行编排，为了方便使用，您可以使用 API网关 进行接口Mock。关于API网关的快速使用入门可参考 创建后端服务为HTTP的API，本实验仅需使用API网关的少量功能，操作步骤如下：开通API网关。在进行Mock配置...
管理离线包
加载离线包 根据是否在客户端预置离线包，分为以下两种方式：预置离线包 加载远程离线包 预置离线包 不管网络情况如何，首页或登录页等页面都需快速加载。因此，可以将这部分资源打包为离线包、提前预置在工程中，以保证在离线情况下资源也...
线热力层（v1.x版本）
线热力层是基础平面地图的子组件，支持独立的样式、数据和交互配置，能够以热力线的形式表现地理位置上的线路信息，适用于地图上线路图的大屏展示，例如展示地铁线路图。本文介绍线热力层各配置项的含义。重要 当前为v1.x版本的线热力层子...
开发小助手的功能
离线包中心 在离线包中心，您可以查看离线包应用信息、已安装离线包列表、JsApis 列表和 Plugins 列表，还可以关闭离线包验签、一键更新离线包。说明：为了保证功能的完整性和独立性，离线包中心功能需要单独接入 离线包开发助手，更多详情...
线热力层（v2.x版本）
线热力层是基础平面地图的子组件，支持独立的样式、数据和交互配置，能够以热力线的形式表现地理位置上的线路信息，适用于地图上线路图的大屏展示，例如展示地铁线路图。本文介绍线热力层各配置项的含义。重要 当前为v2.x版本的线热力层子...
- 产品推荐
- 这些文档可能帮助您