ApiHisItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...
通过云控制API实现资源管理
为什么要用云控制API管理云资源 随着云计算服务业务越来越丰富，很多云厂商为客户提供的相关的API数量也多达上万个。而在云服务被集成过程中，客户/伙伴面对上万单点API往往无从下手。从“找到正确API”到“了解使用方式”再到“弄清楚上...
API 流量治理
编辑限流配置 sofa.apigateway.api.limitconfig.update 用于编辑指定 ID 的 API 的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 是 NQ3MMyVqDX6Jkbb7sj6Sm4UoYRSr*API 标识 limit_config LimitConfigVO 否-限流配置 ...
API网关监控
1.3 region监控仅对最近7天内的API调用情况进行统计监控。可根据API发布的不同环境（线上、预发、测试）查看监控图表。可监控指标包括：API请求次数统计 按实例统计API请求次数 流量统计（请求流量、应答流量）平均延时（API网关处理延时、...
支持 HTTPS
API网关也支持使用HTTPS对您的API请求进行加密。可以控制到API级别，即您可以强制您的API只支持HTTP、HTTPS或者两者均支持。如果您的API需要支持HTTPS，操作流程如下：步骤1：准备 您需要准备如下材料：一个自有可控域名。为这个域名申请...
VPC内网访问API网关
建议您使用专享实例的API网关，此时运行在专享实例上的API分组，其内网VPC二级域名所对应的IP为您所绑定的入访VPC的私网地址，这样便于您的本地路由设置。共享实例上的API分组的内网VPC二级域名统一为100.x.x.x的IP地址，无法分配私网地址...
使用HTTPS并用域名访问
用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。API网关为每个分组默认提供了公网二级域名，如果客户端直接调用API分组提供的公网二级域名，将会受到每天...
使用限制
每个账号下，每个Region默认最多创建5个未绑定域名的API分组，如果在此Region中有绑定域名的API分组，则未绑定域名的API分组总数上限为20个；支持通过 提交工单 申请增加API分组数量限制。公网二级域名限制 直接使用API分组的公网二级域名...
调用API商品
在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
产品简介
开发者可以使用统一的 API 动词、通用输入资源和参数来构建独特的 API 代码库。API名称 API描述 ListProducts 查看产品列表 ListResourceTypes 查看资源元数据 CreateResource 创建资源 UpdateResource 更新资源 GetResources 查询资源 ...
如何找到已购买的API
您可以在管理控制台寻找您都已经购买的API。打开 云市场，在右上角点击【买家中心】-【[进入管理控制台]】(https://market.console.aliyun.com/imageconsole/index.htm "进入管理控制台")在左侧菜单，点击【API】即可，如图：
DescribePluginApis-查询插件绑定的API列表
查询插件绑定的API列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中...
DescribeApiHistories-查询API历史发布的版本列表
接口说明 此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录 调用该接口能获取 API 历史版本号数据，用于其他接口的调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...
CORS 配置
请求参数 名称 类型 是否必填 示例 描述 api_id_list ARRAY[STRING]否-绑定的 API ID 列表 cors_id STRING 否 cors_id1 CORS 标识 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 ...
API 管理
id":"JADDGOCN","workspace_id":"antdemo"} 返回示例 {"data":true,"result_code":"OK"} 通过 ID 查询 API sofa.apigateway.api.get 用于通过 API ID 查询获取指定 API 信息。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 是 8...
请求中编码问题
API请求编码问题 客户端请求API网关时，需要对参数值进行utf-8的urlEncode，这样能避免特殊参数或者中文出现乱码。注意：query、header、body位置编码需要在签名计算后，签名时用原始值。以下代码可参考：...
如何使您的API支持HTTPS？
首先，您需要申请一张SSL证书，然后将SSL证书，将证书绑定到网关（查看分组明细-找到相应域名-上传证书）。其次，将您的API请求协议修改为：HTTPS或者HTTP和HTTPS。
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。API网关自调用允许跨Region调用，如果同Region，可以走内网调用。API网关自调同时支持跨账号调用，使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件，API网关...
BatchAbolishApis-批量下线API
批量下线已经发布到环境的API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
版本管理
2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 编辑 按钮。编辑API定义的流程和创建API定义一致，详细信息参见 创建 API，如果您想...
通过日志服务查看API调用日志
appId 调用者应用ID appName 调用者应用名称 clientIp 调用者客户端IP exception 后端返回的具体错信息 exchangeTimestamp 整个请求链路的IO时间点 FrontRequestStart：API网关开始接收到客户端请求的时间点 FrontRequestEnd：API网关完成...
ImportSwagger-通过 Swagger 创建 API
接口说明 阿里云目前支持基于 Swagger 2.0 的扩展 只支持 json/yaml 格式的 Swagger 配置文件 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
绑定/解绑授权对象
只有获得授权的订阅方应用可以调用 API。在 API 详情页的 授权对象 标签页下，您可以绑定授权对象、解除绑定以及限制应用访问 API 的次数。绑定授权对象 进入 API 发布>API 管理 页面，找到待授权的 API，单击进入其详情页。在 授权对象 ...
使用摘要签名认证方式调用API
发布的API如果使用摘要签名认证方式（APP Key和APP Secret），客户端在调用API时，需要使用签名密钥对请求内容进行签名计算，并将签名同步传输给服务器端进行签名验证。API网关提供的SDK内置了签名实现，您只需要将签名密钥配置在SDK中，...
IP访问控制插件
IP访问控制插件 是 API网关 提供的 API 安全防护组件之一，负责控制 API 的调用来源 IP（支持IP段）。您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的API请求。1.概述 支持白名单或黑名单方式：白名单：支持配置 IP 或者...
TCP连接超时时间配置
具体配置 上文说到的ClientReadTimeout需要在客户端的初始化HttpClient连接池的代码中配置，拿API网关提供的SDK举例，在下面代码中配置：上文说到的APIGatewayBackendTimeout需要在API网关定义API的后端服务的时候配置，如下图所示：
DryRunSwagger-预检查swagger
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
共享实例
共享实例的所有云资源包括ECS/SLB/Redis等...总的公网最大入访带宽是5120M 最大公网出访带宽(bps)最大公网出访带宽就是实例页出口地址 IP的总和，一个IP是200M SLA 99.9%（2023年10月30号之前新建的API）99.0%（2023年10月30号之后新建的API）
DeleteApi-删除 API 定义
删除指定的API定义。接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该...
DeployApi-发布 API
接口说明 此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，...
ImportOAS-通过OAS导入API
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
使用简单认证（AppCode）方式调用API
API调用者到API网关控制台的”应用管理“找到AppCode/AppSecret进行签名认证的调用或者AppCode进行简单认证的API调用。2.创建支持简单认证方式API API提供者在创建API安全认证方式时需要选择”阿里云APP”；AppCode认证选项选择允许AppCode...
产品在控制台的管理都有什么？如何管理？
若您提供 API，您可以在控制台创建、管理、发布您的 API，还可以对您的 API 进行授权管理、流量控制等操作。
管理系统集群
绑定的API：列出了绑定了该系统集群作为后端服务类型的所有 API 及其基本信息，例如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 ...
Path是什么？
Path 是您的 API 调用时展示给客户的固定路径，也是 API 的标识，在同一分组下 HTTP Method+Path 不可以重复。在 Restful API 中，一般表示为资源，格式为资源/子资源，如：instance/disk。Path 中支持动态参数，用[param]表示，如：...
如何指定调用环境？
调用API时，默认是调用线上环境的API。如果要调用测试环境，请在header中增加参数：X-Ca-Stage:TEST。如果要调用预发环境，请在header中增加参数：X-Ca-Stage:PRE。
DescribeApiMarketAttributes-获取API的属性
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
- 产品推荐
- 这些文档可能帮助您