API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
API 网关服务等级协议（SLA）
本服务等级协议（Service Level Agreement，简称“SLA”）规定了阿里云向客户提供的API网关的服务可用性等级指标及赔偿方案。API网关的服务等级协议（SLA）请参见 API网关服务等级协议。
产品简介
API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
RESTful API概览
本文列举了消息服务MNS主题模式提供的API。主题管理 API 说明 CreateTopic 创建主题 SetTopicAttributes 修改主题属性 GetTopicAttributes 获取主题属性 DeleteTopic 删除主题 ListTopic 获取主题列表 订阅管理 API 说明 Subscribe 创建...
API概览
本文列出了专属KMS提供的API接口及相关描述。密钥接口 API 描述 Encrypt 将明文加密为密文。Decrypt 将密文解密为明文。Sign 使用非对称密钥进行签名。Verify 使用非对称密钥进行验签。GenerateDataKey 生成数据密钥，并返回数据密钥的明文...
RESTful API概览
本文列举了消息服务MNS提供的API。队列管理 API 说明 支持方式 CreateQueue 创建队列 控制台、API调用 SetQueueAttributes 修改队列属性 GetQueueAttributes 获取队列属性 DeleteQueue 删除队列 ListQueue 获取队列列表 消息管理 API 说明 ...
API概览
IoT固件安全检测（FSS）提供的API包括提交检测任务、获取检测状态、获取检测报告、删除检测任务、查询授权信息、查询检测结果等。IoT固件安全检测 API 描述 CreateScanTask 创建检测任务。QueryTaskStatus 查询任务检测状态，如果使用检测...
API概览
BatchCompute 提供的 API 接口如下：Image 相关接口 API 描述 CreateImage 创建镜像。DeleteImage 删除镜像。GetImage 获取镜像信息。ListImages 批量获取镜像信息。Cluster 相关接口 API 描述 CreateCluster 创建集群。DeleteCluster 删除...
数据源配置常见问题
使用Open API可以方便地调用各云产品提供的API接口，通常用于获取阿里云产品的信息。如果您想获取阿里云产品的数据信息（例如ECS负载状况、SLS日志统计），在DataV中可以使用 Open API数据源。Open API仅支持调用阿里云产品提供的API。具体...
数据源配置常见问题
使用Open API可以方便地调用各云产品提供的API接口，通常用于获取阿里云产品的信息。如果您想获取阿里云产品的数据信息（例如ECS负载状况、SLS日志统计），在DataV中可以使用 Open API数据源。Open API仅支持调用阿里云产品提供的API。具体...
添加Open API数据源
Open API是阿里云提供的云产品开放接口的调用方式，使用Open API可以方便地调用各云产品提供的API接口，轻松实现控制及查询等功能。在DataV中，最常见的场景是使用Open API调用其他的云产品的API，获取数据并展示出来。前提条件 已准备好待...
添加Open API数据源
Open API是阿里云提供的云产品开放接口的调用方式，使用Open API可以方便地调用各云产品提供的API接口，轻松实现控制及查询等功能。在DataV中，最常见的场景是使用Open API调用其他的云产品的API，获取数据并展示出来。前提条件 已准备好待...
操作流程
三方API：统一服务支持创建第三方平台提供的API，通过生成API可以方便后续调用，减少资源操作成本。数据上报API：通过数据表方式生成API可以方便后续调用，减少资源操作成本。数据更新API：通过调试或调用创建的数据更新API修改数据库中的...
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
API概览
本文介绍KMS实例API提供的API接口及相关描述。密钥接口 使用KMS提供的密钥接口前，请关注以下信息：AdvanceEncrypt、AdvanceDecrypt、AdvanceGenerateDataKey和GenerateDataKey：KMS密钥应为对称密钥。Encrypt和Decrypt：KMS密钥可以为对称...
使用向导模式创建三方API
支持向导模式创建第三方平台提供的API，生成API以便后续调用，减少资源操作成本。本文介绍如何创建三方API。前提条件 已创建应用，具体操作，请参见 新建应用。操作步骤 登录 数据资源平台控制台。在页面左上角，单击 图标，选择 协同。在...
利用 API 实现资源和成本管理
利用 BssOpenAPI 实现资源和成本管理 BssOpenAPI 提供的功能 BssOpenAPI 是阿里云提供的实例、订单、账单和卡券管理等系列工具的API集合产品。通过 BssOpenAPI 我们可以实现从产品基本信息查询，到钱账票的统一管理功能。资源概念 BssOpen...
API 类商品接入说明
API 类商品接入，即允许云市场售卖您提供的 API 类商品。本文介绍 API 类商品在云市场上架的操作步骤。前提条件 入驻 API 集市。将您的 API 服务部署在阿里云 API 网关，详情请参见 发布API商品。API 类商品接入 登录云市场 服务商后台。在...
可重复基础设施
开发者通过平台提供的API探索工具或查阅文档来选定符合需求的OpenAPI。评估自身业务场景与能力支撑：哪部分业务自动化？开发资源投入成本？业务技术架构是否符合标准？开发者在实际业务场景中权衡取舍，通过OpenAPI找到云业务自动化、效率...
基本概念
DashScope灵积模型服务通过标准化的API提供“模型即服务”（Model-as-a-Service，MaaS）。不同于以往以任务为中心的AI API，DashScope构建在面向未来的、以模型为中心的理念下，因此也引入了一些新的概念和术语。开发者可以通过本文了解...
名词解释
服务授权 服务API的发布者赋予API消费方应用使用指定的API消费凭证来调用某个API的权限，就是授权。授权除了定性的允许、禁止之外，还可以包含更广泛的限制如访问频度控制、白名单等等。服务组 服务组（API组）是业务上的原子粒度分组，每...
API概览
本文介绍内容检测API提供的所有配置管理接口，帮助您调用API配置自定义文本库、图库和管理OSS检测内容等。导航 内容安全支持自定义文本库、图库和管理OSS检测内容，您可以在控制台执行相关操作，也可以通过接口调用进行操作，从而更好地...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
应用场景
API 提供者在此提供标准的 API 服务，开发者在此将标准化的 API 服务整合进自己的应用，从而衍生出新的应用，新的服务。API 网关以此促进企业建立商业生态、跨界创新。通过 API 网关将企业的核心能力，开放给合作伙伴，达成深度合作，协同...
功能概览
发布和路由 提供API发布管理，线上版本一键切换；支持多环境管理，满足日常研发、预发测试、生产环境并行使用需求；支持灰度发布功能；支持参数路由，可根据HTTP请求内容创建不同的路由转发规则，提高系统灵活性；API可用性 支持API应答...
基于Swagger完成API网关与用户CICD流程整合
该方法的核心是以swagger为桥接，通过API网关的ImportSwagger接口来完成您的API的自动创建和更新。一、概述 API网关提供了完备的OpenAPI接口，用户可以通过这些接口完成API网关的管理需要。用户CICD集成API网关的核心，其实就是对API网关...
为分组绑定插件
本文主要介绍如何为API分组绑定插件，并验证插件是否对分组下的API生效。1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效...
概述
API网关提供的SDK内置了签名实现，您可以直接用API网关控制台为您提供的多语言SDK来调用API，具体操作请参考 使用SDK调用API-如果您需要自己在客户端实现签名计算过程，可以参考 客户端签名计算过程说明文档 使用JWT认证方式调用API 还可...
导出标准OAS定义
API发布与扩展：通过将使用标准OAS规范的API定义转化为API网关的API资源，您能够快速在API网关创建和配置API，然后根据您的需求，自定义和扩展API的功能和行为。通过API网关的灵活性，您可以更好地管理和控制API的访问权限、流量限制和请求...
使用HTTPS并用域名访问
用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。API网关为每个分组默认提供了公网二级域名，如果客户端直接调用API分组提供的公网二级域名，将会受到每天...
IP访问控制插件
IP访问控制插件 是 API网关 提供的 API 安全防护组件之一，负责控制 API 的调用来源 IP（支持IP段）。您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的API请求。1.概述 支持白名单或黑名单方式：白名单：支持配置 IP 或者...
数据服务概述
数据服务与API网关（API Gateway）完全集成，支持您将数据服务快速发布到API网关，从而使用API网关提供的API权限管控、IP白名单控制、流量控制、计量计费、SDK下载等全面的API服务。因此在使用数据服务前，请先开通 API网关。更多API网关...
创建后端服务为HTTP的API
6 调用API 通过上述步骤，您已经创建API、创建APP、建立了授权关系，调试API完成，并将API发布到线上环境，本阶段将会模拟如何通过调用API网关提供的SDK，来在您的业务系统中调用发布好的API。步骤11 调用API 1、在 API调用 中找到 SDK，...
开放API（OpenAPI）
DataWorks开放平台提供OpenAPI能力，通过调用DataWorks的OpenAPI使用DataWorks的各项功能，实现应用和DataWorks的集成和交互。背景信息 DataWorks的OpenAPI提供100多个API功能，通过调用API，可以快速进行批量操作和系统集成对接等工作，...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
API调试及自助排错
本文将结合API调试页面提供的自助排错能力进行介绍。说明 API调试支持摘要签名认证、简单认证（AppCode）、BasicAuth插件认证。API调试支持 multipart/form-data，可在调试页面上传文件。调试页请求报文最大支持512KB，若请求报文较大，...
TCP连接超时时间配置
具体配置 上文说到的ClientReadTimeout需要在客户端的初始化HttpClient连接池的代码中配置，拿API网关提供的SDK举例，在下面代码中配置：上文说到的APIGatewayBackendTimeout需要在API网关定义API的后端服务的时候配置，如下图所示：
HTTPS 证书报错
只在与 API 提供商无法提供兼容性更好的主流 SSL 证书，且安全风险可控的前提下，可以考虑使用此方法。2.API提供者的 SSL 证书过期 提供者的 SSL 证书过期。解决方案 联系 API 提供者，要求其更换 SSL 证书。程序中忽略检查 SSL 证书有效性...
如何获取错误信息
所有的 API 请求只要到达了网关，网关就会返回请求结果信息。用户需要查看返回结果的头部，即 Header 部分。其中 X-Ca开头的均为网关返回，比较重要信息是：/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头...
- 产品推荐
- 这些文档可能帮助您