API 流量治理
本文列出了 API 流量治理相关的所有 OpenAPI 及其请求参数、返回参数。编辑限流配置 sofa.apigateway.api.limitconfig.update 用于编辑指定 ID 的 API 的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 是 NQ3MMyVqDX6...
发布API商品
发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
ModifyTrafficControl-修改用户自定义的流控策略设置
接口说明 此功能面向开放 API 的用户 修改将对策略下绑定的 API 即时生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
通过日志服务查看API调用日志
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
API 版本管理
API 只有在发布后才能被订阅方使用。创建后的 API 可以根据业务需求进行编辑、下线和编辑重发布等操作。新版本发布上线后，老版本自动成为历史版本被下线。API 版本的生命周期如下：版本说明：每次发布一个版本时，系统为当前版本分配一个...
函数计算内网访问API网关
1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，同时很多时候出于安全考虑，往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式：在同一...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息...3 后续步骤 完成以上定义后和初步调试后，您就完成了API的创建。您可以发布API到测试、预发、线上环境，继续调试或供用户使用。还可以为API绑定 客户端签名说明文档 等安全配置。
查看API资产详情
申请API资产前，了解API资产详情，有利于判断需申请的资产是否符合自己的期望。本文介绍如何查看公开的API资产详情。前提条件 已在统一服务模块中创建API，并上线，具体操作，请参见 上线API。操作步骤 登录 数据资源平台控制台。在页面...
查看API资产详情
申请API资产前，了解API资产详情，有利于判断需申请的资产是否符合自己的期望。本文介绍如何查看公开的API资产详情。前提条件 已在统一服务模块中创建API，并上线，具体操作，请参见 上线API。操作步骤 登录企业数据智能平台。在页面左上角...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。API网关自调用允许跨Region调用，如果同Region，可以走内网调用。API网关自调同时支持跨账号调用，使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件，API网关...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
ModifyIpControl-修改IP访问控制
接口说明 此功能面向 API 提供者 该接口只能修改访问控制的名称和描述，访问控制类型不支持修改。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
管理数据模型
删除数据模型 说明 如果当前数据模型已被引用或已绑定了 API，则无法被删除。您可以通过以下任一方式删除数据模型：在数据模型列表页，单击相应数据模型右侧 删除 按钮，在确认框中单击 确定 即可。在数据模型的详情页，单击右上角的 删除 ...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
路径匹配规则
API 网关支持 绝对匹配、参数匹配 和 前缀匹配 三种路径匹配规则。绝对匹配 绝对匹配，表示只有请求的路径和配置的路径完全一样时才能匹配成功。示例 例如，当前 API 的匹配规则为 GET/path。请求示例：请求一：curl ...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
客户端调用API示例
您可以通过 API 网关，调用由其他阿里云用户或者第三方服务商开放的 API 服务。API 网关将为您提供一系列管理服务与支撑。调用API 您可以直接用API网关控制台为您提供的多语言SDK来调用API（SDK和文档下载），也可以自行编写HTTP(s)请求...
ApiGroupAttribute
描述"class="reference-link">描述 API分组详情 节点名"class="reference-link">节点名 ApiGroupAttribute 子节点"class="reference-link">子节点 名称 类型 描述 GroupId String API分组 ID，系统生成，全局唯一 GroupName String API组...
使用SDK调用API
本文主要引导用户如何通过调用API网关自动生成的SDK，来在业务系统中调用发布好的API。概述 在控制台自动生成的SDK内置了签名实现，可以免去繁琐的签名计算，若需要自行实现签名认证您可以参考 客户端签名说明文档 调用API的前期步骤可参考...
使用HTTPS并用域名访问
用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。API网关为每个分组默认提供了公网二级域名，如果客户端直接调用API分组提供的公网二级域名，将会受到每天...
ModifyApiGroupVpcWhitelist-修改API分组VPC白名单
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
申请API资产
本文介绍如何申请API资产。前提条件 已在运营模块中编目和公开API资产。已在系统设置模块中创建应用。操作步骤 登录 数据资源平台控制台。在顶部菜单栏，单击 图标，选择 发现。在顶部菜单栏，单击 资产目录。在 资产目录 页面，单击 API，...
申请API资产
本文介绍如何申请API资产。前提条件 已在运营模块中编目和公开API资产。已在系统设置模块中创建应用。操作步骤 登录企业数据智能平台。在顶部菜单栏，单击 图标，选择 发现。在顶部菜单栏，单击 资产目录。在 资产目录 页面，单击 API，可...
ModifyIpControlPolicyItem-修改IP访问控制下的策略
接口说明 此功能面向 API 提供者 增加该策略后，所有绑定该访问控制的 API，即时生效 修改是某条策略内容的全量修改 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK...
错误代码表
I410GG 410 Group's instance invalid 请求了非法的实例，分组可能已经不属于当前实例 I400SG 400 Invalid Stage 请求了未知的环境 I404NF 404 API not found${Reason} 根据请求的`Path`,`Method`在当前的环境中未找到API，请参考 I404NF...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
发布API
如果您的API是为了供自己的应用程序调用，需要在API网关中创建应用，将API授权到应用中，然后通过AppKey和AppSecret加密签名调用，详情请参见 客户端调用API示例。同时API网关提供了主流编程语言的SDK，您可以快速集成API至自己的应用中，...
ModifyApiGroupNetworkPolicy-修改api分组的网络策略
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
HTTP API 入门
说明 同一个 API 分组下，API 名称不能相同。描述：选填，用于描述 API 的作用等，64 个字符以内。API 授权应用类型：必选，指定可以订阅并调用该 API 的应用类型。根据本示例，需选择 应用。请求路径：必填，针对应用设置的请求资源的 URL...
后端服务调不通
需要强调，API网关访问外部的出口IP不能保证不会变动，通过设置安全组来判断请求来源的方法可能会由于API网关出口IP变化而导致API网关访问后端服务失败，因此我们不建议使用安全组方法。API网关提供了完整的后端签名验证的方式来做身份认证...
测试已获授权API
前提条件 已申请API资产，具体操作，请参见 申请API资产。操作步骤 登录 数据资源平台控制台。在页面左上角，单击 图标，选择 协同。在顶部菜单栏，单击 图标，选择目标工作组，单击 资产加工。在左侧导航栏，单击 图标，选择 API管理>已获...
ModifyApiDatasourceParameters-修改API数据源配置
修改指定API数据源的配置。接口说明 修改查询语句时，仅支持修改最上层的 JsonObject，不支持多层嵌套内的参数修改。具体的参数说明详见 创建 API 数据源。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功...
测试已获授权API
前提条件 已申请API资产，具体操作，请参见 申请API资产。操作步骤 登录企业数据智能平台。在页面左上角，单击 图标，选择 协同。在顶部菜单栏，单击 图标，选择目标工作组，单击 资产加工。在左侧导航栏，单击 图标，选择 API管理>已获...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
调用API
调用API即应用调用生产环境中的API。在为企业建立API生态场景中，您需要调用API进行二次开发或开放API给合作伙伴等，帮助企业实现数据的资产化和价值化。本文为您介绍如何调用API。前提条件 API已发布至数据服务市场。具体操作，请参见 ...
- 产品推荐
- 这些文档可能帮助您