API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
API使用规范
简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里云根据自身业务计划相继推出的可编程使用的云服务。API使用 2.1.阿里云自行独立判断您是否可获得...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
API概览
本产品（小程序Serverless/2019-06-15）的OpenAPI采用 RPC 签名风格，签名细节参见 签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求...
使用OpenAPI
本文为您介绍使用API网关OpenAPI的基本信息及注意事项。说明 关于如何使用阿里云OpenAPI，请参见学习文档：使用OpenAPI。基本信息 版本说明 版本号 说明 2016-07-14 推荐 接入点说明 参见 服务接入点。用户身份 用户身份 支持情况 阿里云...
概述
角色说明 API 网关产品涉及以下两个角色：API 发布者：将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者：使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下：...
数据服务概述
数据服务与API网关（API Gateway）完全集成，支持您将数据服务快速发布到API网关，从而使用API网关提供的API权限管控、IP白名单控制、流量控制、计量计费、SDK下载等全面的API服务。因此在使用数据服务前，请先开通 API网关。更多API网关...
使用指引
新版说明-推荐使用 API概览 OpenAPI 列表参见「API目录」，如 CreateRepository-创建/导入代码库 老版说明 使用教学请查看：API 使用快速入门 如需获取个人访问令牌请查看：个人访问令牌 OpenAPI 列表请参见「Codeup-OpenAPI 合集」，如 ...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
数据服务
使用场景包括：最小粒度的数据输出：当企业需要对外提供数据时，相较于直接对外提供表数据，使用API的方式可以控制到行级（SQL过滤条件）和列级（查询字段），这样能帮助用户只对外暴露最小单元的数据，保障数据安全。可视化制作：对于多数...
API调度
您可以使用API触发任务调度。关于API触发的使用方式，请参见 服务接入点。
API 触发
您可以使用 API 触发任务调度。API 触发的使用方式请参见 调用方式。
基本概念
DashScope中所有不同的模型API服务都可以使用一个API-KEY、以一致的编程方式进行调用，方便开发者进行跨模态的、多个模型的接续调用。请妥善保存和使用API-KEY，如需进一步了解API-KEY有关的安全信息，请参考 保护并正确使用API-KEY。领域...
API调度
您可以使用API触发任务调度。关于API触发的使用方式，请参见 服务接入点。
SetApisAuthorities-给多个API添加APP访问权限
接口说明 此功能面向 API 提供者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
SetAppsAuthorities-给多个APP添加API访问权限
接口说明 此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
概述
使用AppCode调用API（简单身份认证）AppCode认证方式，调用简单，但安全性较低，适合于内网系统之间的API调用。API网关通过检查客户端调用API时的Request Header或Query中，是否包含有满足要求的AppCode来进行认证。具体操作过程请参考 ...
查看已获授权API
前提条件 申请使用API成功，具体操作，请参见 申请使用API。使用租户一般用户登录。操作步骤 登录 数据资源平台控制台。在页面左上角，单击 图标，选择 协同。在顶部菜单栏，单击 图标，选择目标工作组，单击 资产加工。说明 若您已在 资产...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
使用限制
本文描述了API网关的使用限制。限制项 限制描述 使用API网关服务的用户限制 用户需实名认证 用户创建API分组数量限制-每个账号下，每个Region的API分组（含绑定域名和未绑定域名的分组）的总数上限200个；每个账号下，每个Region默认最多...
如何使用API创建非标准网段
概述 本文主要介绍如何使用API创建非标准网段。详细信息 当通过控制台创建的标准网段无法满足需求时，可以通过VPC的API接口创建标准网段的子网。登录 OpenAPI Explprer控制台，参考如下步骤创建。适用于 专有网络 VPC
环境管理
目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的测试环境资源，从而可以保证在同一套API配置的情况下，供您的测试人员进行测试使用。在API网关上进行环境管理的时候，您需要做两部分工作：API的后...
TCP连接超时时间配置
本文档站在API网关的角度对API网关的客户端和后端服务做出TCP连接超时时间配置的建议，以便用户更好地使用API网关，避免遇到一些已知的问题。关于基于HTTP协议的TCP超时时间，常见的有以下几个配置：连接建立超时时间（ConnectionTimeout）...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
功能简介
已获授权API 对已获授权API通过API维护和应用维度进行查看，支持测试API、下载API使用文档、下载密钥SDK和归还权限，也支持查看单个API的授权详情，包括：授权人、授权时间、访问路径、AppKey和AppSecret等。已对外授权API 支持查看通过...
名词解释
使用API网关，您需要对以下名词有所了解。名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求...
API调用特殊参数说明
使用场景 交管云控平台使用数据资源平台统一服务作为数据服务发布、管理的平台，交通行业线的API开发者在为API服务编写查询SQL时，会选择使用比较基础的语法，例如只包含SELECT和WHERE条件做一些简单的查询逻辑。等到API开发完成上线后，...
跨域资源访问（CORS）
用逗号分隔 allowCredentials:true#是否允许Cookie maxAge:172800 说明 若使用API网关的公网二级域名调用API，仅线上环境支持跨域插件。因为用公网二级域名调用测试或预发环境时，需要在Header中加X-Ca-Stage参数来指定调用的环境，而浏览...
ServiceConfig
后端服务超时时间，单位：毫秒 ContentTypeCatagory String 否 调用后端服务HTTP服务时，ContentType头的取值策略：DEFAULT：使用API网关默认的值 CUSTOM：自定义 CLIENT：使用客户端上行的ContentType的头 ContentTypeValue String 否 ...
发布API商品
3.5 API商品的域名 在使用API网关进行API全生命周期管理的场景中，您需要在分组上绑定您的正式域名后，业务系统、客户端程序才能正式调用这些发布的API。但针对这些准备上架到云市场的API分组，则不必您绑定域名，在云市场服务商控制台中，...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
事件处理
为了监听文档的交互行为，可以使用ApiEvent事件机制，本文介绍事件处理机制和使用方法。概述 JS-SDK提供了 ApiEvent 事件机制，使您可以监听文档的交互行为，并在触发时运行一些JavaScript代码。提供的事件分为公共事件和组件事件（例如...
名词解释
API消费者可以创建多个API消费凭证，每个凭证可被一个或一组API消费方应用使用，通常可以把凭证作为API消费方应用的分组。API提供方应用 和消费方相对，指接入CSB开放出服务API的提供者应用。API发布者 API提供方应用在CSB上发布服务和管理...
申请使用API
本文介绍如何申请使用API。申请API 前提条件 API已上线，具体操作，请参见 API上线并查看详情。API已在运营工作台编目及公开，具体操作，请参见 API资产。已新建API消费应用，具体操作，请参见 新建API消费应用。使用租户一般用户登录。...
统一服务
API的生命周期管理：API支持数据服务API、三方API、数据上报API、空间服务API 和数据更新API。支持API的创建、编辑和测试，支持的API类型包括实时查询类、离线批量类、流式数据类、非结构化数据类。API管理：支持对API上线、下线、测试等...
功能简介
已获授权API 对已获授权API通过API维护和应用维度进行查看，支持测试API、下载API使用文档、下载密钥SDK和归还权限，也支持查看单个API的授权详情，包括：授权人、授权时间、访问路径、AppKey和AppSecret等。已对外授权API 支持查看通过...
步骤一：资源准备
创建Mock接口 实验中会对两个接口进行编排，为了方便使用，您可以使用 API网关 进行接口Mock。关于API网关的快速使用入门可参考 创建后端服务为HTTP的API，本实验仅需使用API网关的少量功能，操作步骤如下：开通API网关。在进行Mock配置...
API概览
本产品（无影云应用/2021-02-18）的OpenAPI采用 RPC 签名风格，签名细节参见 签名机制说明。...API目录 API 标题 API概述 GetAuthCode 获取授权码 获取一个包含用户身份信息和权限信息的授权码，在集成场景中可使用该授权码唤起云应用。
- 产品推荐
- 这些文档可能帮助您