阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
短信注册/登录
中进行短信网关和短信模板的配置 短信网关各项配置说明：SMS服务商：可以选择提供的服务商列表中的任一服务商 网关名称：短信网关名称 网关描述：短信网关描述 SMS URL：SMS URL API账户：API账户 API密码：API密码 短信标题：短信标题 API...
创建API数据源
密码：填写API密码。阿里云appKey auth AppKey：填写API的AppKey。AppSecret：填写API的AppSecret。None：API无认证。API Key Key：填写API Key认证方式的键。Value：填写API Key认证方式的值。添加至：将API Key添加至API请求体参数 ...
创建API数据源
密码：填写API密码。阿里云appKey auth AppKey：填写API的AppKey。AppSecret：填写API的AppSecret。None：API无认证。API Key Key：填写API Key认证方式的键。Value：填写API Key认证方式的值。添加至：将API Key添加至API请求体参数 ...
API概览
静态用户名密码 API 描述 CreateAccount 调用CreateOrGetAccount创建静态用户名密码。ListAccounts 调用ListAccounts查看指定实例下所有的静态用户名密码。DeleteAccount 调用DeleteAccount删除指定的静态用户名密码。
CreatePipeline-创建流水线
创建流水线API，支持创建YAML化流水线。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求语法 POST/...
重置实例登录密码
登录名 在线重置密码：支持修改创建实例时设置的用户名密码及您自行创建的用户名密码 离线重置密码：仅支持修改您在创建实例时选择的登录名的密码。Linux：root或ecs-user Windows：Administrator 新密码 与 确认密码 实例登录密码的长度为...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
DescribePurchasedApis-获取购买的 API 列表
PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 API 的线上...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
API 概览
流水线控制 API 名称 描述 运行流水线 运行流水线 终止运行流水线 可以取消运行流水线 删除流水线成员 可以删除流水线成员 更新流水线成员 可以更新流水线成员 增加流水线成员 可以增加流水线成员 使用流水线模板创建流水线 使用流水线模板...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
CreateApi-创建 API
支持汉字，英文，数字，下划线，且只能以英文和汉字开头，4~50 个字符 ApiName Visibility string 是 API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
密钥服务概述
关于应用程序如何集成主密钥进行数据加密、解密等密码方案，请参见 SDK参考。使用KMS提供的密钥接口前，请关注以下信息：AdvanceEncrypt、AdvanceDecrypt、AdvanceGenerateDataKey和GenerateDataKey：KMS密钥应为对称密钥。Encrypt和...
DescribeApiHistory-查询历史版本详情
接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些...注意：API网关不维护模型和API的关联关系，删除模型时可能会引起线上API的SDK导出失败等问题。因此，删除模型请谨慎操作。
密钥服务概述
阿里云加密服务 导入密钥材料 保持对密钥的控制 数据加密 KMS提供了云原生的密码运算API，相比于传统密码模块或密码软件库的API更简单易用。同时，KMS提供了多种SDK以加速开发过程。关于如何使用SDK进行代码开发，请参见 概述。功能 说明 ...
后端签名插件
API绑定后端签名插件后，API 网关向您后端服务请求时会使用这一对Key和Secret对请求内容进行加签处理，您后端服务可以对网关发送过来的请求做对称加签计算，对比网关的签名和服务器端计算的签名是否一致就可以对网关做身份验证。...
查看及管理API版本
对于API、函数和工作流程，每发布一次，便会产生一条版本记录。本文为您介绍如何查看API不同版本的信息，并进行回滚和对比操作。操作步骤 登录 DataWorks控制台，单击左侧导航栏的 数据服务，在下拉框中选择对应工作空间后单击 进入数据...
API概览
应用API开放 应用API开放 EnableApplicationApiInvoke 启用一个EIAM应用的Developer API调用功能 调用EnabledApplicationApiInvoke接口启用一个EIAM应用的Developer API调用功能。DisableApplicationApiInvoke 禁用一个EIAM应用的Developer...
按线上API关联
说明 全量新建、按应用新建、按线上API关联新建时获取到该关联项。应用需在系统设置模块创建，数据API需在统一服务模块创建并上线。服务 对应上线状态的数据API。说明 目前上报API和三方API暂时不支持被解决方案获取。数据API需在统一服务...
RAM用户概览
例如：如果RAM用户代表的是应用程序，则需要通过API访问资源，您只需给它创建AccessKey。如果RAM用户代表的是员工，则需要通过控制台访问资源，您只需给它设置登录密码。具体设置方法如下：控制台登录 您需要启用RAM用户控制台登录、设置...
创建并授权RAM用户
例如：如果RAM用户代表的是应用程序，则需要通过API访问资源，您只需给它创建访问密钥。如果RAM用户代表的是员工，则需要通过控制台访问资源，您只需给它设置登录密码。具体设置方法如下：控制台登录 您需要启用RAM用户控制台登录、设置RAM...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
中国内地密码机
请在加密服务控制台的 实例列表 页面，单击密码机实例的 规格 列，下载密码机实例管理工具，解压...在软件包中找到开发手册、SDK、示例程序等，您可以参考开发手册，调用API接口使用密码机。如果您需要开发接入方面的技术支持，请 联系我们。
OpenAPI列表
API API说明 BindGroupToApp 绑定群组到应用。CreateGroupPageQuery 创建群组分页查询。说明 该API只有超级管理员（SuperAdmin）和系统管理员能够调用。GetOnlineClusterById 根据群组ID获取群组详情。GetOnlineFeatureById 根据标签ID获取...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
跨域资源访问（CORS）
用逗号分隔 allowCredentials:true#是否允许Cookie maxAge:172800 说明 若使用API网关的公网二级域名调用API，仅线上环境支持跨域插件。因为用公网二级域名调用测试或预发环境时，需要在Header中加X-Ca-Stage参数来指定调用的环境，而浏览...
创建后端为函数计算的API
API返回内容为前面步骤中创建的函数返回内容，函数代码如下：7 调用API 通过上述步骤，您已经创建API、创建APP、建立了授权关系，调试API完成，并将API发布到线上环境，本阶段将会模拟如何使用APPCode的认证方式来在您的业务系统中调用发布...
创建服务项目
绑定应用或者被组合API引用时，拦截不允许发布：API绑定应用或者被组合API引用时，不允许新版本发布到线上，保证下游应用和组合API的正常调用。适用于使用范围广，影响面大的重要API，如果变更发布到线上会严重影响下游时可以拦截。被组合...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
版本管理
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
结构体说明
page_info ApiInfoVO 名称 类型 是否必填 示例 描述 api_cache_model ApiCacheVO 否-API 缓存模型 api_group_id STRING 否 api_group_id1 API 分组标识 api_group_name STRING 否 api_group_name1 所属 API 分组名称 api_id STRING 否 8...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
- 产品推荐
- 这些文档可能帮助您