RemoveIpControlApis-解除API与IP访问控制的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后该 API 的对应环境将不会有 IP 访问控制 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
同步 API
同步 API 可将当前环境中的 API 同步至其他环境中。为保证系统稳定性，只同步目标环境不存在的 API 配置。同步后，会自动加载配置使其生效。操作步骤 登录 mPaaS 控制台，在左侧导航栏，点击 移动网关 菜单。在 API 管理 标签页中，点击 更...
管理 API 渠道
对应内容同步推送接口中的 apiChannelId 字段。API 名称：API 的名称。内容形式：指定客户端展示的内容为图文还是视频。完成 API 配置后，单击 确定。新增的 API 将出现在 API 列表中。查询 API 渠道 支持输入 API 标识或 API 名称查询 API...
API网关中的API设置为私有
应用场景 在满足业务生产的前提下，将API网关中的API设置私有，可有效降低业务安全风险。风险等级 默认风险等级：高风险。当您使用该规则时，可以按照实际需求变更风险等级。检测逻辑 API网关中的API设置为私有，视为“合规”。API网关中的...
RemoveSignatureApis-解除API与后端签名密钥的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
注册 API
移动网关支持多种不同类型的 API 服务。本文介绍如何通过控制台添加 API 来完成 API 注册。针对不同类型的 API 服务，需要进行的操作有所不同，下面分别予以介绍。添加 MPC API 前，确保已创建好相应的 MPC API 分组。HTTP API MPC API ...
DescribeImportOASTask-查询OAS导入API的任务
名称 类型 描述 示例值 object RequestId string 请求的 id CE5722A6-AE78-4741-A9B0-6C817D360510 ApiResults object[]API 的导入结果 ApiId string API 的 ID c5a0c2900ff746b789c007545be22fb8 Path string API 的请求路径/creator/...
名词解释
API定义 API服务方创建API时，设置的API的后端服务、请求格式、接收格式、返回格式等规则内容。参数映射 用户实际请求的参数与API服务后端参数不一致时，支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则，由网关根据规则...
后端路由
当前请求的域名 CaRequestHandleTime：请求处理的UTC时间 CaAppId：请求参数的AppId CaAppKey：请求参数的AppKey CaClientIp：客户端IP CaApiName：创建时候的API名字 CaHttpScheme：请求的协议 HTTP ,HTTPS CaClientUa: 客户端上传的...
共享实例
共享实例的所有云资源包括ECS/SLB/Redis等...总的公网最大入访带宽是5120M 最大公网出访带宽(bps)最大公网出访带宽就是实例页出口地址 IP的总和，一个IP是200M SLA 99.9%（2023年10月30号之前新建的API）99.0%（2023年10月30号之后新建的API）
管理外部授权 API
绑定的 API：列出了该外部授权 API 绑定的所有 API 及其基本信息，包括 API 名称、API 分组、发布状态、前端协议类型、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。配置信息：...
CORS 配置
请求参数 名称 类型 是否必填 示例 描述 api_id_list ARRAY[STRING]否-绑定的 API ID 列表 cors_id STRING 否 cors_id1 CORS 标识 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 ...
操作步骤
关于此任务 API 包括以下类型的参数配置：基础信息配置：API 名称、接口描述、接入系统等，不同类型的 API 服务还具备不同的属性。高级配置：签名校验、ETag 缓存、超时时间。header 设置：网关支持为所有请求添加或者删除 header。限流...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
如何指定调用环境？
调用API时，默认是调用线上环境的API。如果要调用测试环境，请在header中增加参数：X-Ca-Stage:TEST。如果要调用预发环境，请在header中增加参数：X-Ca-Stage:PRE。
账单域API使用手册
SubscribeBillToOSS 详单订阅服务 UnsubscribeBillToOSS 取消详单订阅服务 QueryRelationList 查询企业财务关系列表 API选择方案 选择账单域API时，您可以结合需要查询的数据，对比每个API的入参、出参，做出最优的API接口决策。...
导出及导入 API
为便于将当前 API 配置应用于其他环境或其他应用，移动网关服务支持将当前应用的 API 以.txt 文件形式导出。同时，您也可以将 API 配置导入并应用到当前环境。下面是对 API 导出和导入操作的具体介绍。导出 API 按需选择要导出的 API，导出...
共享实例
1.API调用量费用 共享实例的API调用量费用，根据您发布的API实际发生的调用量阶梯计费，阶梯价格如下：按阶梯计费 单位：元/万次 每月（自然月）前一百万次 免费 0~1000万（包含）0.06 1000万~1亿（包含）0.04 1亿以上 0.03 说明：计费方式...
系统集群
workspaceId":"antdemo"}],"result_code":"OK"} 通过系统集群 ID 查询 API 分页列表 sofa.apigateway.sys.api.list 用于查询指定系统集群下的 API 分页列表。请求参数 名称 类型 是否必填 示例 描述 param ApiInfoQueryVO 否-param sys...
根据应用查询API列表，返回环境聚合的结果
根据应用查询API列表，返回环境聚合的结果。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
DescribeDeployedApis-查询已发布 API 列表
查询已经发布到某指定环境中的API列表，即查询指定环境中正在运行的API列表。接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK...
Path是什么？
Path 是您的 API 调用时展示给客户的固定路径，也是 API 的标识，在同一分组下 HTTP Method+Path 不可以重复。在 Restful API 中，一般表示为资源，格式为资源/子资源，如：instance/disk。Path 中支持动态参数，用[param]表示，如：...
后端签名插件
当您想替换某个API的密钥时，请直接修改要修改插件中的key和secret,已绑定的API将会即时生效。3.插件配置 可以选择JSON或者YAML格式的来配置您的插件，两种格式的schema相同，可以搜索yaml to json转换工具来进行配置格式的转换，YAML格式...
DescribeApiMarketAttributes-获取API的属性
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。API网关自调用允许跨Region调用，如果同Region，可以走内网调用。API网关自调同时支持跨账号调用，使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件，API网关...
RemoveApiProductsAuthorities-批量移除API产品对指定...
批量移除API产品对指定APP的授权 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
常见问题
本文为您介绍云控制API的常见问题。问题概览 产品code和资源code哪里获取？CreateResource和...根据对应的API文档中的requestPath说明和产品code、资源code进行拼接。若自行拼接麻烦，可前往 在线调试API门户 查看对应的requestPath。
SetApiProductsAuthorities-批量授权API产品给指定APP
批量授权API产品给指定APP 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素...
应用管理
apiId":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq","apiStatus":"CLOSED","workspaceId":"antdemo"}]},"result_code":"OK"} 通过 APP ID 查询 API 分页列表 sofa.apigateway.app.api.list 用于查询指定 APPID 的应用所订阅的 API 分页列表。...
DescribeTrafficControls-查询流控策略列表及详情
接口说明 此功能面向开放 API 的用户 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略，包括详细信息 此接口还可以支持条件查询，如查询指定接口所绑定的流控策略，如查询指定环境下的流控策略 调试 您可以在OpenAPI Explorer...
DescribeTrafficControlsByApi-查询API绑定的流控策略
请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要查询的 API 所属分组 0009db9c828549768a200320714b8930 ApiId string 是 指定要查询的 Api 编号 3b81fd160f5645e097cc8855d75a1cf6 StageName string 是 指定要查询的环境。...
RemoveTrafficControlApis-解除API与流控策略的绑定
接口说明 此功能面向开放 API 的用户 用于解除 API 与流控策略的绑定关系，支持 API 批量，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
DryRunSwagger-预检查swagger
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeSignaturesByApi-查询API绑定的后端签名密钥
请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要查询的 API 所属分组 0009db9c828549768a200320714b8930 ApiId string 是 指定要查询的 API 编号 3b81fd160f5645e097cc8855d75a1cf6 StageName string 是 指定要查询的环境。...
HTTPS 证书报错
只在与 API 提供商无法提供兼容性更好的主流 SSL 证书，且安全风险可控的前提下，可以考虑使用此方法。2.API提供者的 SSL 证书过期 提供者的 SSL 证书过期。解决方案 联系 API 提供者，要求其更换 SSL 证书。程序中忽略检查 SSL 证书有效性...
应用场景
前后端分离场景 统一接入标准 通过 API 网关向客户端提供统一协议的 API，允许 IT 团队选择最适合内部架构的技术栈。后端异构集成 屏蔽客户端与服务端差异，能够在不对外部绑定客户端产生负面影响的情况下重构服务。降低业务代码复杂性 ...
简介
TSDB 提供管控类 API 给用户，用于协助用户使用第三方系统、工具...OpenAPI 基本原理 OpenAPI 底层通过 HTTP 接口提供服务，用户调用 OpenAPI 的 SDK，发出 HTTP 请求到阿里云应用网关，再由阿里云应用网关将请求转发给 TSDB 的控制台去执行。
DescribeDeployApiTask-查询发布API任务进度
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
ModifyApiGroupNetworkPolicy-修改api分组的网络策略
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
SetVpcAccess-添加 VPC 授权
接口说明 此功能面向开放 API 的用户。授权 API 网关允许访问您的 VPC 实例。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
- 产品推荐
- 这些文档可能帮助您