云速搭API模板实现应用架构批量部署
通过云速搭API结合模板可以快速完成应用架构批量部署，提高运维效率。场景介绍 本实践适合需要将相同的应用架构进行多次批量创建的场景，这里演示模拟部署10套独立的网站后台环境，每一套的基本架构为EIP+ECS，部署架构如下图所示。业务...
产品架构
Mosng 网关根据内存中的 API 信息校验应用的请求信息（验签、解密、RPC 信息校验）。如果信息校验失败，则直接返回错误信息给应用。如果信息校验通过，则根据配置的协议（HTTP/SOFARPC/SOFAREST）将应用的请求转发到后端业务服务器。
如何使用钉钉连接模块集成钉钉侧能力
模块介绍 钉钉连接模块集成了钉钉开放平台中用户管理、角色管理、角色组管理、部门管理的API接口，便于快速连接钉钉组织架构。钉钉连接模块接口API。钉钉连接模块接口API的结构体。操作步骤 通过以下步骤，可实现在自建的魔笔应用内，基于...
Ark Biz 生命周期
SOFAArk 目前提供了三种方式操作 Biz：编程 API Zookeeper 动态配置 Telnet 指令 本质上，Zookeeper 和 Telnet 指令都是通过编程 API 操作 Biz，所以此处详细描述通过编程 API 控制 Biz 的生命周期。SOFAArk 提供客户端 ArkClient 操作 Biz...
API 概览
微服务提供以下相关 API 接口。动态配置 API 描述 AddMsConfigAttributes 新增属性元信息 DeleteMsConfigAttributes 删除属性元信息 GetMsConfigAttributes 根据属性 ID 获取对应的属性信息 QueryMsConfigAttributes 获取属性详细信息，...
产品优势
统一易用的编程接口 每一个 SOFA 中间件都是独立可插拔的组件，对集成的 SOFA 中间件提供统一易用的编程接口，节约开发时间，和后期维护的成本。遵循 OpenTracing 埋点 提供平台无关、厂商无关的 API，使得开发人员能够方便的添加（或更换...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
结构体说明
本文介绍 API 网关产品涉及的所有 API 结构体字段及其示例、说明等。AppInfoVO 名称 类型 是否必填 示例 描述 api_count NUMBER 否 1 API 数量 app_id STRING 否 app_id APPID app_name STRING 否 app_name 应用名称 app_secret STRING 否 ...
后端路由
backend:后端描述，与API网关的Swagger标准保持一致，后端在原有API的后端上覆盖backend配置后处理，如果覆盖后的backend不完整，会提示客户端 X-Ca-Error-Code:I504RB，当看到这个错误时，请检查自己的backend配置是否完整，关于Backend...
断路器插件（仅专享实例）
1.断路器概述 断路器是API网关在后端出现性能问题时保护系统的内置机制，默认配置下，当某个API的后端在30秒钟内出现1000次超时，系统会触发断路器保护，断路器进入打开状态，断路时间为90秒，90秒内所有的请求均快速返回Status=503,X-Ca-...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
SetVpcAccess-添加 VPC 授权
接口说明 此功能面向开放 API 的用户。授权 API 网关允许访问您的 VPC 实例。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
DescribeDeployedApis-查询已发布 API 列表
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
DescribeApisByApp-根据应用查询API列表
根据APP查询关联的API列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素...
DescribePluginApis-查询插件绑定的API列表
查询插件绑定的API列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中...
版本说明
错误码 400 变更 变更时间：2022-09-08 变更集发布说明：更新一些API的错误码以及参数校验说明。新增批量添加飞书用户的API。OpenAPI 名称 变更内容概要 操作 BatchAddFeishuUsers 新增 OpenAPI。查看API变更历史 查看API文档
DescribeAuthorizedApps-查询可访问APP列表
接口说明 此功能面向 API 提供者 查询结果返回的所有应用（app）均可访问指定的 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API...
DescribeAppAttributes-查询APP列表信息
接口说明 此功能面向调用 API 的用户 AppId 可选择性传入 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在...
产品简介
API网关作为成熟的云产品，放在Kubernetes集群前面作为应用集群的接入服务使用，将大大提高Kubernetes集群的服务能力，可以作为标准的大型互联网应用的标准架构。前后台分离架构。在大规模的前后台分离架构中，需要由API网关承载起API认证...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
环境管理
步骤1：由于本例中的API后端服务类型是VPC，因此需要分别创建两个VPC授权 backend-vpc-release 和 backend-vpc-test，分别对应线上环境和测试环境，如何使用VPC作为API的后端服务的配置过程可详见 创建后端服务为VPC内资源的API。...
架构域管理
研发效能平台除了默认架构域外，还支持用户自行创建架构域来满足实际开发中的应用需求。新建架构域 登录研发效能控制台。在左侧导航栏单击 持续交付>研发迭代>我的架构域。在 我的架构域 页面，单击 新建，配置架构域信息。参数说明如下：...
管理外部授权 API
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
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
创建 CORS 规则后，您可在规则下绑定/解绑指定的 API。绑定 API 在 CORS 规则列表页，单击规则右侧 操作 列中的 绑定 API。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
导入导出 API
说明 为减少操作耗时，建议一次性导入/导出 API 的数量不超过 100 个。导入 API 的 JSON 格式请参见模板 API Json 文件格式。批量导出 API 在 API 发布>API 管理 页面，在 API 列表左侧勾选需要导出的 API。单击 API 列表右下角的 批量导出...
DomainItem
描述"class="reference-link">描述 API的调用域名信息 节点名"class="reference-link">节点名 DomainItem 子节点"class="reference-link">子节点 名称 类型 描述 DomainName String API的调用域名
混合云API集中管理
说明 本文的架构设计仅为更清晰的说明如何跨VPC之间的API调用，您在类似场景下使用时，只需要为API网关提供一个VPC（本例中为vpc-1）用于与其他环境（如其他Region的VPC、或本地数据中心）进行互通，此VPC除了为API网关提供接入外，并不...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
DescribeApisByBackend-根据后端查询 API 列表
1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...
概述
完成API的创建和发布之后，本章节重点会从客户端（如其他业务系统的代码、手机APP或HTML页面中等）角度来介绍如何调用您发布在API网关上的API，因此重点会涉及到如下部分的内容：了解API的认证方式、适用场景并如何实现客户端代码-了解客户...
API监控的维度
可以对 API 的调用量、错误分布、响应时间、流量大小等维度进行监控。
版本管理
2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 编辑 按钮。编辑API定义的流程和创建API定义一致，详细信息参见 创建 API，如果您想...
API类型是什么
API 的类型包含公开、私有两种，公测期间，两种类型无特殊区别。
为RAM用户授权
本文为您介绍云控制API的RAM权限管理。您可以为RAM用户授予不同的权限，提供给您企业的员工用来使用云控制API，从而让您避免与其他用户共享云账号密钥，降低您企业的信息安全风险。前提条件 您已创建RAM用户（子用户）。具体操作，请参见 ...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
- 产品推荐
- 这些文档可能帮助您