SetTrafficControlApis-添加指定流控策略与API的绑定
接口说明 此功能面向开放 API 的用户 用于添加 API 与策略的绑定关系，支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
DescribeApiHistories-查询API历史发布的版本列表
接口说明 此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录 调用该接口能获取 API 历史版本号数据，用于其他接口的调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...
DescribeHistoryApis-查询API发布版本定义列表
RELEASE：线上 TEST：测试 RELEASE ApiId string 否 指定要查询的 Api 编号 a12068f555964ca8a0c9c33288f1e5a7 ApiName string 否 API 名称（模糊匹配）getPersonInfo PageSize string 否 分页参数：每页显示条数。10 PageNumber string 否...
WAF接入配置
本文主要介绍如何配置WAF，对API网关上发布的API进行增强安全防护。1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP ...
DeleteApi-删除 API 定义
删除指定的API定义。接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该...
常见问题
本文为您介绍云控制API的常见问题。问题概览 产品code和资源code哪里获取？CreateResource和...根据对应的API文档中的requestPath说明和产品code、资源code进行拼接。若自行拼接麻烦，可前往 在线调试API门户 查看对应的requestPath。
支持 HTTPS
API网关也支持使用HTTPS对您的API请求进行加密。可以控制到API级别，即您可以强制您的API只支持HTTP、HTTPS或者两者均支持。如果您的API需要支持HTTPS，操作流程如下：步骤1：准备 您需要准备如下材料：一个自有可控域名。为这个域名申请...
根据应用查询API列表，返回环境聚合的结果
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
BatchAbolishApis-批量下线API
批量下线已经发布到环境的API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
Path是什么？
Path 是您的 API 调用时展示给客户的固定路径，也是 API 的标识，在同一分组下 HTTP Method+Path 不可以重复。在 Restful API 中，一般表示为资源，格式为资源/子资源，如：instance/disk。Path 中支持动态参数，用[param]表示，如：...
DeleteApiGroup-删除 API 分组
接口说明 此功能面向 API 提供者 分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效 删除不存在的分组时，会返回删除成功 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...
AbolishApi-下线 API
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
管理 API 渠道
对应内容同步推送接口中的 apiChannelId 字段。API 名称：API 的名称。内容形式：指定客户端展示的内容为图文还是视频。完成 API 配置后，单击 确定。新增的 API 将出现在 API 列表中。查询 API 渠道 支持输入 API 标识或 API 名称查询 API...
产品架构
Mosng 网关根据内存中的 API 信息校验应用的请求信息（验签、解密、RPC 信息校验）。如果信息校验失败，则直接返回错误信息给应用。如果信息校验通过，则根据配置的协议（HTTP/SOFARPC/SOFAREST）将应用的请求转发到后端业务服务器。
DescribeApiLatencyData-查询API监控数据中对响应时间...
接口说明 查询指定 API 的监控信息：Latency(ms)此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
如何查看API的运行情况
API 网关，为您提供监控服务，您可以在控制台，以图表形式查看您 API 的调用量、流量大小及错误分布等监控信息。
使用 RAM 管理 API
格式：acs:apigateway:$regionid:$accountid:apigroup/$groupId 示例：acs:apigateway:*:*:apigroup/cbd157704e624ab58a204fd3e0b5ad79 请结合 API 网关的API 手册来查看下表：action-name 接口描述 资源（Resource）CreateApiGroup 创建...
SetSignatureApis-绑定签名密钥与API
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
自定义 API
在小程序中调用 API 在小程序中使用如下方法来调用自定义的 API：my.call(API,param,callback)其中：API：自定义 API 的名称。param：调用 API 的参数。callback：API 执行的回调方法。以调用 rpc 方法为例，调用示例代码如下：my.call('...
如何使用一个自有域名访问API？
您可以在分组上绑定一个或多个您自有的域名，作为调用您 API 的地址。
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
SetAppsAuthorities-给多个APP添加API访问权限
接口说明 此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
产品在控制台的管理都有什么？如何管理？
若您提供 API，您可以在控制台创建、管理、发布您的 API，还可以对您的 API 进行授权管理、流量控制等操作。
API 提供者 Demo
网关支持用户 下载服务端 Demo 进行测试使用，Demo 的代码分支为：server_demo。网关依赖如下：<dependency><groupId>...完成 Demo 的下载后，您可以进行以下多种类型的 API 服务开发与发布：HTTP API 服务 SOFARPC API 服务 DUBBO API 服务
API调用授权
BSS OpenAPI的权限为 bssapi:【API名称】，例如 bssapi:QueryOrder 或 bssapi:QueryInstanceBill。为了兼容控制台权限，以下表格中API对应的权限点同样可以使用。对于权限策略中，Allow或Deny一个API对应的任何一个权限点，权限策略都会...
共享实例
1.API调用量费用 共享实例的API调用量费用，根据您发布的API实际发生的调用量阶梯计费，阶梯价格如下：按阶梯计费 单位：元/万次 每月（自然月）前一百万次 免费 0~1000万（包含）0.06 1000万~1亿（包含）0.04 1亿以上 0.03 说明：计费方式...
DescribeApiMarketAttributes-获取API的属性
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ImportOAS-通过OAS导入API
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DeletePlugin-删除插件
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DeletePlugin Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 PluginId string 是 指定要删除的 API 网关插件的 ID 9a3f1a5279434f2ba74ccd91c295af9f Tag object[]否 ...
DescribeUpdateVpcInfoTask-查询VPC授权更新状态
更新VPC授权会异步更新关联的发布中的API，该API用来查询这些API的更新进度。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
CORS 配置
请求参数 名称 类型 是否必填 示例 描述 api_id_list ARRAY[STRING]否-绑定的 API ID 列表 cors_id STRING 否 cors_id1 CORS 标识 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 ...
DescribeAuthorizedApis-查询已授权的API列表
查询指定 APP 已授权的API列表，即指定 APP 的API列表。接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以...
DescribeApiQpsData-查询API监控数据中对QPS的统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
RemoveApisAuthorities-撤销应用APP对多个API访问权限
应用（app）编号，系统生成，全局唯一 2386789 StageName string 是 环境名称，取值为：RELEASE:线上 TEST:测试 TEST ApiIds string 是 指定要操作的 API 编号，支持输入多个，“,”分隔，最多支持 100 个 baacc592e63a4cb6a41920d9d3f91f...
如何使您的API支持HTTPS？
首先，您需要申请一张SSL证书，然后将SSL证书，将证书绑定到网关（查看分组明细-找到相应域名-上传证书）。其次，将您的API请求协议修改为：HTTPS或者HTTP和HTTPS。
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
BatchDeployApis-批量发布API
描述 test Api object[]否 指定要操作的 api 列表 GroupId string 是 API 分组编号 b4f5c342b8bc4ef88ccda0332402*ApiUid string 是 API 唯一标识 2b35dd68345b472f8051647306a1*返回参数 名称 类型 描述 示例值 object OperationId string...
DescribeApiSignatures-查询API签名密钥绑定情况
接口说明 此功能面向开放 API 的用户 非必填的参数，不传入则默认返回所有，分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是...
DescribeApisBySignature-查询签名密钥绑定的API列表
查询指定签名密钥所绑定的API列表信息。接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表...
- 产品推荐
- 这些文档可能帮助您