简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
公共参数
公共返回参数 API返回结果采用统一格式，调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为XML格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码 RequestId。返回 2xx HTTP状态码表示调用...
公共参数
公共参数是每个接口都需要使用的请求参数和返回参数，包含公共请求参数和公共返回参数。公共请求参数 公共请求参数是每个接口都需要使用到的请求参数。表 1.公共请求参数表 名称 类型 是否必须 描述 Region string 是 威胁情报实例所在的...
通过向导模式创建API（Dataphin表）
向导模式基于Dataphin逻辑表，通过可视化界面配置API参数的方式创建API。本文为您介绍如何使用向导模式生成API。前提条件 MaxCompute计算引擎下支持逻辑表创建API，需完成以下步骤：基于逻辑表生成API的场景中，需要完成逻辑表（维度逻辑表...
创建数据模型
本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>数据模型。在数据模型列表页，单击列表右上方的 创建数据模型 按钮。在新打开的 创建数据模型 页面中，配置如下信息：模型名称：...
通过SQL模式创建API（Dataphin表）
步骤二：配置API参数信息 在 新建API 页面，配置API基本信息和参数配置。API基本信息配置 参数 描述 API名称 填写API的名称。命名规则如下：只能包含汉字、字母、数字或下划线（_）。长度为4~42个字符。以字母开头。全局唯一。请求方式 API...
创建集群时生成OpenAPI参数
创建集群时，如果由于请求参数组合不正确导致集群创建失败，您可以通过生成OpenAPI参数，为您创建集群时所请求的参数生成正确的参数组合。本文介绍如何在容器服务管理控制台创建集群时获得集群的OpenAPI参数。操作步骤 登录 容器服务管理...
创建API接口
在 新建API 的 添加API参数 页面，设置请求参数和返回参数，并单击 保存 或者 保存并调试，如下图所示。说明 保存 可保存当前设置，保存并调试 可跳转至 调试API 页面。单击 保存并调试 进入 调试API 页面，输入调试参数值并选择返回参数。...
API授权时支持的调用参数配置
在 API参数配置 区域，设置目标字段为请求参数，设置完成单击 下一步。在 API配置与测试 区域，选择目标请求参数，设置 授权时筛选 选项为 是，并单击下一步至最后一步保存成功。在对外授权时，可以在表单下方 授权过滤 处，为这个授权对象...
使用外部授权 API
外部 API 参数：即 request.context 中的参数，可以从请求的 Header、Body、Cookie 和 Query 中提取。如上图配置所示，网关在调用 auth-server 时，会进行如下参数提取：从 Header 中取出 headerKey 的 value。从 Query 中取出 queryKey 的...
新建数据服务API-向导模式
配置API参数。选择云计算资源为“dataq_dws_rds”，服务资源组选择为“数据服务系统资源组”，新建模式选择“向导模式”，选择源数据表为“ys_xyk_bkxx”，在返回参数下勾选所有字段。在 请求参数 区域，单击+请求参数，选择参数名称...
CLI接入指南
您可以使用 阿里云CLI 接入EDAS的API，完成日常的管理操作。安装CLI 安装CLI的步骤，请参见：在Windows上安装阿里云CLI 在Linux上安装阿里云CLI 在macOS上...更多信息 API调用公共参数 Java SDK接入指南 Python SDK接入指南 OpenAPI开发者门户
魔笔中想把列表页的第x页作为参数，集成进需要调用的...
问题描述 魔笔中想把列表页的第x页作为参数，集成进需要调用的API中，如何操作？问题原因 如果需要分页传参需要开启自定义逻辑流。解决方案 DataGrid 开启自定义逻辑流分页，然后创建逻辑流，可自定义第一个参数为返回的实体，第二个参数为...
API流量控制支持的参数
API流量控制参数 API创建过程中，需要设置流量控制参数，对API调用的频率、响应超时时间、缓存失效时间等进行控制。单位时间API最大调用次数，即API调用最大QPS，手动填写，最大不超过10000。超时配置，API单次响应超时时间，下拉可选，...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
创建API测试任务
通过创建API测试任务，模拟真实的调用场景，通过网关调用API，测试API运行状态，查看创建的API是否能达到预期。本文介绍如何创建API测试任务。前提条件 API已上线，具体操作，请参见 上线API。操作步骤 登录 数据资源平台控制台。在页面...
创建API测试任务
通过创建API测试任务，模拟真实的调用场景，通过网关调用API，测试API运行状态，查看创建的API是否能达到预期。本文介绍如何创建API测试任务。前提条件 API已上线，具体操作，请参见 上线API。操作步骤 登录企业数据智能平台。在页面左上角...
为什么要定义参数？
参数是 API 请求的重要组成部分，网关可以根据参数定义给你的用户生成 API 手册。
绑定/解绑 API
授权对象创建成功后，您可在该授权对象下批量绑定或解绑指定的 API。...批量解绑：若需要一次解绑当前授权应用下的多个 API，可先勾选多个 API 后，单击页面底部的 批量解除绑定，在弹出的确认框中单击 确定，即可批量解除绑定多个 API。
绑定/解绑 API
创建 CORS 规则后，您可在规则下绑定/解绑指定的 API。...批量解绑：若需要一次解绑当前规则下的多个 API，可先通过左侧的复选框勾选多个 API 后，单击页面底部的 批量解除授权，在弹出的确认框中单击 确定，即可批量解除 API 的绑定。
ALIYUN:ApiGateway:Api
ALIYUN:ApiGateway:Api类型用于创建API。语法 {"Type":"ALIYUN:ApiGateway:Api","Properties":{"ErrorCodeSamples":List,"Description":String,"ServiceConfig":Map,"SystemParameters":List,"ServiceParameters":List,...
名词解释
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
公共参数
公共参数是指每个接口都需要使用到的请求参数和返回参数。本文介绍 RPC 风格的 API 的请求参数和返回参数。API 公共请求参数和公共返回参数如下：说明 消息服务类 API 属于 ROA 风格，请公共参数请参见 公共参数。公共请求参数 名称 类型 ...
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 当 ...
CreateApi-创建 API
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:CreateApi Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定的分组编号 08ae4aa0f95e4321849ee57f4e0b3077 ApiName string 是 设置 API 的名称，...
调用方式
如果你使用 SDK 来发起 API 请求，您只需要设置一些公共参数和 API 的具体参数，SDK 会自动编码。优化求解器的API是RPC风格，您可以通过发送HTTP/HTTPS请求调用API。其请求结构如下：http://Endpoint/?Action=xx&Parameters Endpoint：调用...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
调用方式
请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息，详情请参见 公共参数。下面是一个调用 ListEnterpriseDingtalkGroups 接口查询企业服务群列表的示例：说明 为了便于用户查看，本文档中的示例都做了...
调用方式
配置审计接口调用是向配置审计API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 配置审计的API是RPC风格，您可以通过发送...
调用方式
请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息，详情请参见 公共参数。下面是一个调用 ClassifyPOI 接口获取POI分类的示例：说明 为了便于用户查看，本文档中的示例都做了格式化处理。...
请求结构
虚商集成接口调用是向API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。PRC 风格 API 请求结构如下：http(s):/Endpoint/?Action=xx&...
创建授权对象
授权管理用于定义授权对象的基本信息，一个授权对象可以绑定多个 API。在 API 订阅者创建应用后，API 发布者可根据应用创建授权对象。操作步骤 登录 API 网关控制台。在左侧导航栏中单击 API 发布>授权管理，进入授权列表。单击授权列表右...
管理参数映射
查看参数映射 在参数映射列表页，您可以查看该参数映射的概览信息，包括参数映射名称、配置模板、绑定 API 数量、描述、映射类型以及创建时间。查看参数映射详情 在参数映射列表中，您还可以单击任一参数映射名称，进入该映射规则的详情页...
调用API
云价签接口调用是向云价签API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 云价签的API是RPC风格，您可以通过发送HTTP GET请求...
调用API
您需要并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 区块链服务的API是RPC风格，您可以通过发送HTTP POST请求调用区块链服务。其请求结构如下：...
请求结构
请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息，详情请参见 公共参数。请求参数 每个请求都需要指定要执行的操作，即Action参数（例如CreateDatabase），以及每个操作都需要包含的公共请求参数和...
请求结构
云市场接口调用是向云市场 API 的服务端地址发送 HTTP GET 请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用 UTF-8 字符集进行编码。HTTP 调用 您可以通过向服务端发送 HTTP GET 请求调用云...
调用API
调用CDT的API接口是向CDT的API的服务端地址发送HTTPSGET请求。您需要按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 CDT的API是RPC风格，您可以通过发送HTTPS请求...
调用方式
智能外呼接口调用是向智能外呼API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 智能外呼的API是RPC风格，您可以通过发送...
- 产品推荐
- 这些文档可能帮助您