简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
创建集群时生成OpenAPI参数
创建集群时，如果由于请求参数组合不正确导致集群创建失败，您可以通过生成OpenAPI参数，为您创建集群时所请求的参数生成正确的参数组合。本文介绍如何在容器服务管理控制台创建集群时获得集群的OpenAPI参数。操作步骤 登录 容器服务管理...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
创建数据模型
本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>数据模型。在数据模型列表页，单击列表右上方的 创建数据模型 按钮。在新打开的 创建数据模型 页面中，配置如下信息：模型名称：...
创建API接口
数据服务功能是将数据服务化，通过接口将数据库中的数据提供给上层应用。该功能仅适用于专业版。您可以通过以下方式进行数据服务功能设置：登录 Quick BI控制台。在Quick BI产品首页，按照下图指引，新建API。在 新建API 的 配置基础信息 ...
使用向导模式创建三方API
说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致可能导致编辑完成后，编辑内容不生效。修改服务资源组后，会影响API Path。复制API 在API资源列表 操作 列，选择 更多>...
API授权时支持的调用参数配置
在 API参数配置 区域，设置目标字段为请求参数，设置完成单击 下一步。在 API配置与测试 区域，选择目标请求参数，设置 授权时筛选 选项为 是，并单击下一步至最后一步保存成功。在对外授权时，可以在表单下方 授权过滤 处，为这个授权对象...
创建空间服务API
说明 编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致可能导致编辑完成后，编辑内容不生效。复制API 在API资源列表 操作 列，选择 更多>复制，在API资源列表中生成一个新的...
通过向导模式创建API（服务单元）
向导模式基于服务单元，通过可视化界面配置API参数的方式创建API。本文为您介绍如何使用向导模式生成API。前提条件 基于服务单元生成，需先完成服务单元的创建。具体操作，请参见 创建服务单元。使用限制 支持 服务项目管理员 和 开发用户 ...
新建数据服务API-向导模式
配置API参数。选择云计算资源为“dataq_dws_rds”，服务资源组选择为“数据服务系统资源组”，新建模式选择“向导模式”，选择源数据表为“ys_xyk_bkxx”，在返回参数下勾选所有字段。在 请求参数 区域，单击+请求参数，选择参数名称...
通过向导模式创建API（Dataphin表）
向导模式基于Dataphin逻辑表，通过可视化界面配置API参数的方式创建API。本文为您介绍如何使用向导模式生成API。前提条件 MaxCompute计算引擎下支持逻辑表创建API，需完成以下步骤：基于逻辑表生成API的场景中，需要完成逻辑表（维度逻辑表...
API调用特殊参数说明
参数列表 说明 特殊参数的Key为系统保留字，因此在API参数命名时应尽量避免与上述参数名重合，后续也会在设置参数时增加校验避免此类问题 参数 说明 示例值 return_fields 指定返回字段（多个时逗号分隔）aa,bb,ccc aggregation 聚合计算...
API调用特殊参数
我们提供了一系列内置的请求参数，在API的调用过程中...因此在调用时添加如图所示的参数：调用返回结果为： 说明 特殊参数的key为系统保留字，因此在API参数命名时应尽量避免与上述参数名重合，后续也会在设置参数时增加校验避免此类问题。
API调用特殊参数
我们提供了一系列内置的请求参数，在API的调用过程中...因此在调用时添加如图所示的参数：调用返回结果为： 说明 特殊参数的key为系统保留字，因此在API参数命名时应尽量避免与上述参数名重合，后续也会在设置参数时增加校验避免此类问题。
TestDataServiceApi
name 参数名称 BodyParams.N.ParamValue String 否 test 参数值 PathParams.N.ParamKey String 否 path1 参数名称 PathParams.N.ParamValue String 否 api 参数值 HeadParams.N.ParamKey String 否 requestId 参数名称 HeadParams.N....
使用简单认证（AppCode）方式调用API
注意：定义API参数的时候，不需要定义携带AppCode的头或者Header参数。3.调用方法 API提供者将API设置成允许AppCode调用之后，API调用者就可以使用简单认证方式进行调用了，不用再在客户端实现复杂的签名算法了。本章我们介绍下如何通过...
通过SQL模式创建API（服务单元）
步骤二：配置API参数信息 在 新建API 页面，配置API基本信息和参数配置。API基本信息配置 参数 描述 API名称 填写API的名称。命名规则如下：只能包含汉字、字母、数字或下划线（_）。长度为4~42个字符。以字母开头。全局唯一。请求方式 API...
参数映射与校验规则
可选，仅对 String 类型有效 RegularExpression pattern 枚举值 可选 EnumValue enum OpenAPI的参数配置参考：创建API->RequestParameter Swagger参数配置参考：通过导入Swagger创建API 参数校验的一些匹配规则：OpenAPi与Swagger对参数...
通过SQL模式创建API（Dataphin表）
步骤二：配置API参数信息 在 新建API 页面，配置API基本信息和参数配置。API基本信息配置 参数 描述 API名称 填写API的名称。命名规则如下：只能包含汉字、字母、数字或下划线（_）。长度为4~42个字符。以字母开头。全局唯一。请求方式 API...
DescribeApiDoc-查询API说明文档
123456 DefaultValue string 默认值 20 ApiParameterName string API 参数名称 Length EnumValue string 当 ParameterType=Int、Long、Float、Double 或 String，允许输入的散列值，不同的值用英文的逗号分隔，形如：1,2,3,4,9 或 A,B,C,E,...
通过直连数据源模式创建API
步骤二：配置API参数信息 在 新建API 页面，配置API基本信息和参数配置。API基本信息配置 参数 描述 API名称 填写API的名称。命名规则如下：只能包含汉字、字母、数字或下划线（_）。长度为4~42个字符。以字母开头。全局唯一。请求方式 API...
数据服务入门
在API的编辑页面，配置API参数。本文示例配置如下图。选择API的数据源。在 选择表 区域，选择生成API所需的数据源表。参数 描述 数据源类型 选择需要基于哪类数据源创建API。本文示例选择MySQL类型数据源。数据源名称 选择需要基于该类型...
发布API商品
如果您对示例代码进行过编辑，后续即使API参数发生变化，API网关也不会覆盖您的示例代码，请注意及时更新。3.4 发布和调试API API配置完成后，需要发布到环境中才可进行调试、调用，在本例中直接发布到了"线上"环境中，更多关于API网关的...
使用外部授权 API
外部 API 参数：即 request.context 中的参数，可以从请求的 Header、Body、Cookie 和 Query 中提取。如上图配置所示，网关在调用 auth-server 时，会进行如下参数提取：从 Header 中取出 headerKey 的 value。从 Query 中取出 queryKey 的...
DescribeDeployedApi-查询API在指定环境中的定义
123456 DocShow string 文档可见，取值为：PUBLIC、PRIVATE PUBLIC MaxLength long 当 ParameterType=String，参数的最大长度限定 123456 DefaultValue string 默认值 20 ApiParameterName string API 参数名称 age EnumValue string 当 ...
DescribeApiHistory-查询历史版本详情
123456 DocShow string 文档可见，取值为：PUBLIC、PRIVATE PUBLIC MaxLength long 当 ParameterType=String，参数的最大长度限定 123456 DefaultValue string 默认值 20 ApiParameterName string API 参数名称 age EnumValue string 当 ...
GetServiceProvisions-查询服务开通状态
如未指定 OSS 地域，默认与接口参数 RegionId 相同。您必须且仅能指定 TemplateBody、TemplateURL、TemplateId 或 Services 其中一个参数。oss:/ros-template/demo TemplateId string 否 模板 ID。支持共享模板和私有模板。您必须且仅能...
InvokeDataAPIService
调用该接口调用数据算法服务API，获取SQL查询结果。QPS限制 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为1。说明 RAM用户共享阿里云账号配额。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功...
GetDataAPIServiceDetail
调用该接口获取数据算法服务API详情。QPS限制 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为1。说明 RAM用户共享阿里云账号配额。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
公共参数
本文档列举了物联网络管理平台 API 的公共请求参数和公共返回参数。公共请求参数是调用每个 API 时都需要使用的请求参数。名称 类型 是否必需 描述 Format String 是 返回值的类型，支持 JSON 和 XML 类型。Version String 是 API版本号，...
CreateDataAPIService
调用该接口创建数据算法服务API。QPS限制 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为1。说明 RAM用户共享阿里云账号配额。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
创建后端服务为HTTP的API
1 概述 您需要依次完成以下步骤：创建分组 定义API 创建应用和API授权 调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组 在 API管理 中选择 分组管理，选择Region，点击 ...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
使用后端服务提高管理效率
本文将快速引导您在API网关创建后端服务，并使用该后端服务创建，发布，管理API。概述 随着用户管理的API越来越多，为了让用户更方便的对API进行治理，API网关将现在支持的后端服务提取为region上的资源。用户可以在API网关控制台统一配置...
公共参数
本文介绍 PolarDB-X 每个接口都需要使用的请求参数和返回参数详情。公共请求参数 名称 类型 是否必须 描述 Format String 否 返回消息的格式。取值为JSON（默认值）或XML。Version String 是 API版本号，使用YYYY-MM-DD日期格式，取值为...
公共参数
公共参数是每个接口都需要使用的请求参数和返回参数，包含公共请求参数和公共返回参数。公共请求参数 公共请求参数是每个接口都需要使用到的请求参数。表 1.公共请求参数表 名称 类型 是否必须 描述 Region string 是 威胁情报实例所在的...
API网关流量安全
API网关服务端平均延时过高告警 API网关后端服务器错误率过高告警 API网关请求成功率过低告警 API网关服务端平均延时过高告警 告警ID sls_app_audit_dataflow_at_api_latency 告警名称 API网关服务端平均延时过高告警 版本号 1 类别 云平台...
- 产品推荐
- 这些文档可能帮助您