根据应用查询API列表，返回环境聚合的结果
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
DDoS防护接入配置
针对DDoS攻击，API网关提供了5G的DDoS基础防护，但是针对大流量DDoS攻击，建议使用阿里云DDoS高防服务。关于DDoS高防的详细介绍，请参见 什么是DDoS高防（新BGP&国际）。什么是DDoS 分布式拒绝服务（Distributed Denial of Service，简称...
环境管理
1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的测试环境资源，从而可以保证在同一套API...
API网关-微服务集成服务关联角色
本文为您介绍API网关-集成微服务（ApiGateway-IntegrateWithMicroservices）的服务关联角色，ApiGateway-IntegrateWithMicroservices使用此角色来访问您在其他云产品中的资源。背景信息 API网关-微服务集成服务关联角色（ApiGateway-...
DescribeUpdateBackendTask-查询后端服务更新任务
修改后端服务在某个环境上的定义时，关联的已发布API会批量更新，该接口用来查询更新的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息...
API网关-连接用户VPC服务关联角色
本文为您介绍API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApiGatewayConnectUserVpc）的应用场景以及如何删除API网关-连接用户VPC服务关联角色。背景信息 API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApi...
ResetAppCode-重置应用
重置应用的AppCode。此接口每个用户每分钟只能调一次。接口说明 重置 AppCode 会存在大约 2 秒的延迟。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试...
DeleteBackendModel-删除后端模型
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
SdkGenerateByApp-按应用生成SDK
按APP应用生成SDK。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，...
RemoveAccessControlListEntry-删除IP条目
本功能为API网关专享实例提供实例级别的访问控制能力；在实例的访问控制策略中删除IP条目。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 ...
路由规则
本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。创建路由规则 sofa.apigateway.router.create 用于快速创建一个路由规则。请求参数 名称 类型 是否必填 示例 描述 param RouterInfoVO 是-param tenant_id STRING 是 ...
SetDomainWebSocketStatus-设置域名WebSocket状态
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ModifyDatasetItem-修改数据集条目
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
函数计算
API 网关与函数计算对接，可以让您以 API 形式安全地对外开放您的函数，并且解决认证、流量控制、数据转换等问题。1 功能简介 API网关目前支持两种形式的函数，HTTP函数 和 事件函数。2 HTTP函数对接API网关 2.1 创建HTTP函数 在配置API...
系统集群
本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。创建系统集群 sofa.apigateway.sys.create 用于创建一个后端系统集群。请求参数 名称 类型 是否必填 示例 描述 param SystemClusterVO 是-param tenant_id STRING 是 ...
DescribeApiHistory-查询历史版本详情
查询指定API的某一次历史发布版本的定义详情，即某一次历史发布时发布的API定义。接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次...
应用管理
本文列出了应用管理相关的所有 OpenAPI 及其请求参数、返回参数。创建应用 sofa.apigateway.app.create 用于创建一个应用。请求参数 名称 类型 是否必填 示例 描述 param AppInfoVO 是 param tenant_id STRING 是 TSCPDICNT 租户标识 ...
ModifyInstanceAttribute-修改指定实例的信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ValidateVpcConnectivity-VPC授权连通性测试
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeBackendList-查询后端服务列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
授权应用
本文列出了授权应用相关的 API 及其请求参数、返回参数。创建授权应用 sofa.apigateway.authapp.create 用于创建一个授权应用。请求参数 名称 类型 是否必填 示例 描述 param AuthAppInfoVO 是-param tenant_id STRING 是 TSCPDICNT 租户...
实例级别访问控制
API网关提供实例级别的访问控制，您可以分别配置针对IPv4和IPv6的访问控制策略组应用于实例，仅专享实例支持配置实例级别访问控制策略，并且仅对公网生效。1.创建访问控制策略组 1.1 在API网关控制台中实例页面，单击 访问控制，即进入访问...
接入 Android
定位 SDK 是一套简单的 LBS（Location-based services）定位接口，您可以使用这套定位 API 获取定位结果。定位支持 原生 AAR 接入 和 组件化接入 两种接入方式。前置条件 若采用原生 AAR 方式接入，需先完成 将 mPaaS 添加到您的项目中 的...
DescribeInstancePackets-获取实例的数据包数
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
如何配置出访连接池告警
什么是出访连接池？基于HTTP协议的特性，同一个长连接上数据是串行传输的，请求方发送完第一个请求后必须等到应答后才能发第二个请求。出访连接池是指API网关到后端服务的连接池。若购买的专享实例规格为api.s1.small，最大出访连接池大小...
后端签名插件
API绑定后端签名插件后，API 网关向您后端服务请求时会使用这一对Key和Secret对请求内容进行加签处理，您后端服务可以对网关发送过来的请求做对称加签计算，对比网关的签名和服务器端计算的签名是否一致就可以对网关做身份验证。1.什么是后...
DescribeBackendInfo-查询后端服务的信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
发送 HTTP 请求（C#）
前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体获取方法，参见...
流控信息
API名称 API版本 配额 配额维度 ListDbfs 2020-04-18 20000/60(s)地域：*API限速维度：regionId,API,ParentUid ListTagKeys 2020-04-18 600/60(s)地域：*API限速维度：regionId,API,ParentUid TagDbfs 2020-04-18 600/60(s)地域：*API限速...
请求应答改写插件（仅专享实例）
重要 在将请求传递给后端服务之前，API网关会先执行插件中配置的Request改写策略，该过程会在参数映射操作（如果有配置的话）完成之后进行；在向客户端返回后端服务的响应之前，API网关会执行插件中配置的Response改写策略，该过程会在错误...
QueryInstanceBill-实例账单查询服务
接口说明 API 描述 在调用本接口时，请注意：实例账单 API 已升级，请使用新版 API：DescribeInstanceBill。此 API 不再提供 50000 行以后数据的查询。实例账单是根据账单数据拆分生成，一般会有一天延迟。实例信息在账期内会变化，月汇总...
Android 常见问题
本文介绍接入 Android 过程中常见的问题及相应的解决方案。自定义 JSAPI 时，handleEvent 和 interceptEvent 有什么区别？解答：如果监听容器自己处理的事件，需要将自定义 JSAPI 添加到 handleEvent 里，并返回 true。返回 true，表示事件...
QueryAccountBill-账号账单查询服务
操作 访问级别 资源类型 条件关键字 关联操作 bssapi:QueryAccountBill Read 全部资源*bssapi:ProductCode bssapi:ProductType 无 请求参数 名称 类型 必填 描述 示例值 BillingCycle string 是 账单日期，YYYY-MM。2018-07 PageNum ...
安卓8.0通知通道设置
问题背景 App安装在安卓8.0以上时需要主动创建NotificaitonChannel。如果没有创建，那么通知会被系统静默，不会弹出显示。推送时 OpenAPI高级接口 中的 AndroidNotificationChannel 参数值应该和app端代码创建的 channelId 参数值保持一致...
QueryEvaluateList-待开票对象查询服务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
接入 Android 常见问题
Android Portal&Bundle 接入问题 在华为 EMUI 10 系统中 input file 标签无法打开相机 如何在 Library 中使用/依赖 mPaaS 如何解决运行时出现的 608 错或 libsgmain 的 native 错误 在华为 EMUI 10 系统中 input file 标签无法打开相机 ...
ListTicketNotes-获取工单沟通记录
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 TicketId string 是 工单...
SDK下载指引
推流SDK互动版本API的详细说明，请参见：安卓：互动版推流SDK V6.9.0 API说明。iOS：互动版推流SDK V6.9.0 API说明。Web平台 Web端连麦互动SDK的集成方法，请参见：Web连麦互动SDK集成。Web推流SDK的相关接口说明，请参见：接口说明。重要 ...
DescribeInstanceBill-查询实例账单服务
操作 访问级别 资源类型 条件关键字 关联操作 bssapi:DescribeInstanceBill Read 全部资源*bssapi:ProductCode bssapi:ProductType 无 请求参数 名称 类型 必填 描述 示例值 BillingCycle string 是 账期 YYYY－MM。仅支持最近 18 个月账期...
版本说明
变更时间：2024-04-18 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetDataCorrectOrderDetail OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2024-04-18 变更集...
- 产品推荐
- 这些文档可能帮助您