API调用特殊参数说明
参数列表 说明 特殊参数的Key为系统保留字，因此在API参数命名时应尽量避免与上述参数名重合，后续也会在设置参数时增加校验避免此类问题 参数 说明 示例值 return_fields 指定返回字段（多个时逗号分隔）aa,bb,ccc aggregation 聚合计算...
使用向导模式创建三方API
参数 说明 API最大调用QPS API最大调用QPS应为不大于10000的正整数。当 服务资源组 设置为“公共资源组”时，API最大调用QPS只能为1。更多信息，请参考 API流量控制支持的参数。超时配置 请选择API单次响应超时时间。当 服务资源组 设置为...
使用向导模式创建数据服务API
参数 说明 API名称 API的名称，自定义即可。所属应用 选择API的归属应用。单击 新增应用，可新建应用，更多信息请参见 新建应用。服务协议 选择服务的协议类型。API Path API调用时展示的固定路径，默认自动生成。调用认证方式 简单身份...
使用向导模式创建数据服务API
参数 说明 API名称 API的名称，自定义即可。所属应用 选择API的归属应用。单击 新增应用，可新建应用，更多信息请参见 新建应用。服务协议 选择服务的协议类型。API Path API调用时展示的固定路径，默认自动生成。调用认证方式 简单身份...
使用SQL模式创建数据服务API
参数 说明 API名称 API的名称，自定义即可。所属应用 选择API的归属应用。单击 新增应用，可新建应用，更多信息请参见 新建应用。服务协议 选择服务的协议类型。API Path API调用时展示的固定路径，默认自动生成。调用认证方式 简单身份...
使用SQL模式创建数据服务API
参数 说明 API名称 API的名称，自定义即可。所属应用 选择API的归属应用。单击 新增应用，可新建应用，更多信息请参见 新建应用。服务协议 选择服务的协议类型。API Path API调用时展示的固定路径，默认自动生成。调用认证方式 简单身份...
创建空间服务API
参数 说明 API最大调用QPS API最大调用QPS应为不大于10000的正整数。当 服务资源组 设置为“公共资源组”时，API最大调用QPS只能为1。更多信息，请参考 API流量控制支持的参数。超时配置 请选择API单次响应超时时间。当 服务资源组 设置为...
管理API
属性配置 参数 说明 API名称 数据API的名称，支持以汉字，英文，数字或下划线（_）组成，且只能以英文和汉字开头，长度为4~100个字符。描述 用于API的逻辑描述。例如描述API返回的数据，API的应用场景。路径 路径为API调用地址的组成部分。...
请求参数说明
本文为您介绍点播API关于请求参数PlayConfig、ReAuthInfo、UserData、SpriteSnapshotConfig、EncryptConfig的参数说明和配置示例。媒体播放自定义设置 PlayConfig 参数说明 媒体播放时的自定义设置字段，为JSON字符串，目前支持指定域名...
向量检索
是 返回结果参数说明如下所示。参数 对应API参数名称 说明 距离 score 向量相似度 不同的距离度量方式，向量间距离的数值表示并不相同，请参见 什么是向量。返回结果根据向量相似度降序排列。主键ID id 相似向量的主键ID。向量 vector 向量...
媒体处理参数说明
本文为您介绍点播API的媒体处理参数。HLS标准加密配置EncryptConfig 字段名称 类型 必填项 描述 CipherText String 是 密文密钥，用来获取明文密钥。DecryptKeyUri String 是 根据密文密钥获取解密密钥地址，例如：...
自定义Pro版集群的控制面组件参数
ACK集群Pro版 组件名 参数 参数说明 Kube API Server EnableAdmissionPlugins 默认为空。ServiceNodePortRange 可选范围10000～65535，默认为空。重要 您在修改NodePort端口范围时必须十分谨慎。务必保证NodePort端口范围与集群节点上Linux...
自定义Pro版集群的控制面组件参数
ACK集群Pro版 组件名 参数 参数说明 Kube API Server EnableAdmissionPlugins 默认为空。ServiceNodePortRange 可选范围10000～65535，默认为空。重要 您在修改NodePort端口范围时必须十分谨慎。务必保证NodePort端口范围与集群节点上Linux...
自定义Pro版集群的控制面组件参数
ACK集群Pro版 组件名 参数 参数说明 Kube API Server EnableAdmissionPlugins 默认为空。ServiceNodePortRange 可选范围10000～65535，默认为空。重要 您在修改NodePort端口范围时必须十分谨慎。务必保证NodePort端口范围与集群节点上Linux...
自定义Pro版集群的控制面组件参数
ACK集群Pro版 组件名 参数 参数说明 Kube API Server EnableAdmissionPlugins 默认为空。ServiceNodePortRange 可选范围10000～65535，默认为空。重要 您在修改NodePort端口范围时必须十分谨慎。务必保证NodePort端口范围与集群节点上Linux...
设置实例参数
max_parallel_workers={GREATEST(DBInstanceClassCPU*3/4,8)} 相关文档 PostgreSQL的更多参数解释，请参见 PostgreSQL参数说明。API修改参数方法，请参见：API 描述 ModifyParameter 修改RDS实例参数。DescribeParameterTemplates 查看数据...
创建集群时生成OpenAPI参数
创建集群时，如果由于请求参数组合不正确导致集群创建失败，您可以通过生成OpenAPI参数，为您创建集群时所请求的参数生成正确的参数组合。本文介绍如何在容器服务管理控制台创建集群时获得集群的OpenAPI参数。操作步骤 登录 容器服务管理...
参数定义包含什么？
描述参数在请求中的位置（path、header、query、body）、参数说明、参数示例及参数值限制。
创建数据模型
本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>数据模型。在数据模型列表页，单击列表右上方的 创建数据模型 按钮。在新打开的 创建数据模型 页面中，配置如下信息：模型名称：...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
创建API接口
在 新建API 的 添加API参数 页面，设置请求参数和返回参数，并单击 保存 或者 保存并调试，如下图所示。说明 保存 可保存当前设置，保存并调试 可跳转至 调试API 页面。单击 保存并调试 进入 调试API 页面，输入调试参数值并选择返回参数。...
API授权时支持的调用参数配置
在 API参数配置 区域，设置目标字段为请求参数，设置完成单击 下一步。在 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。前提条件 基于服务单元生成，需先完成服务单元的创建。具体操作，请参见 创建服务单元。使用限制 支持 服务项目管理员 和 开发用户 ...
参数映射与校验规则
可选，仅对 String 类型有效 RegularExpression pattern 枚举值 可选 EnumValue enum OpenAPI的参数配置参考：创建API->RequestParameter Swagger参数配置参考：通过导入Swagger创建API 参数校验的一些匹配规则：OpenAPi与Swagger对参数...
API调用特殊参数
我们提供了一系列内置的请求参数，在API的调用过程中...因此在调用时添加如图所示的参数：调用返回结果为： 说明 特殊参数的key为系统保留字，因此在API参数命名时应尽量避免与上述参数名重合，后续也会在设置参数时增加校验避免此类问题。
API调用特殊参数
我们提供了一系列内置的请求参数，在API的调用过程中...因此在调用时添加如图所示的参数：调用返回结果为： 说明 特殊参数的key为系统保留字，因此在API参数命名时应尽量避免与上述参数名重合，后续也会在设置参数时增加校验避免此类问题。
通过向导模式创建API（Dataphin表）
向导模式基于Dataphin逻辑表，通过可视化界面配置API参数的方式创建API。本文为您介绍如何使用向导模式生成API。前提条件 MaxCompute计算引擎下支持逻辑表创建API，需完成以下步骤：基于逻辑表生成API的场景中，需要完成逻辑表（维度逻辑表...
新建数据服务API-向导模式
配置API参数。选择云计算资源为“dataq_dws_rds”，服务资源组选择为“数据服务系统资源组”，新建模式选择“向导模式”，选择源数据表为“ys_xyk_bkxx”，在返回参数下勾选所有字段。在 请求参数 区域，单击+请求参数，选择参数名称...
通过SQL模式创建API（服务单元）
步骤二：配置API参数信息 在 新建API 页面，配置API基本信息和参数配置。API基本信息配置 参数 描述 API名称 填写API的名称。命名规则如下：只能包含汉字、字母、数字或下划线（_）。长度为4~42个字符。以字母开头。全局唯一。请求方式 API...
DescribeDeployedApi-查询API在指定环境中的定义
123456 DocShow string 文档可见，取值为：PUBLIC、PRIVATE PUBLIC MaxLength long 当 ParameterType=String，参数的最大长度限定 123456 DefaultValue string 默认值 20 ApiParameterName string API 参数名称 age EnumValue string 当 ...
发布API商品
如果您对示例代码进行过编辑，后续即使API参数发生变化，API网关也不会覆盖您的示例代码，请注意及时更新。3.4 发布和调试API API配置完成后，需要发布到环境中才可进行调试、调用，在本例中直接发布到了"线上"环境中，更多关于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....
使用外部授权 API
外部 API 参数：即 request.context 中的参数，可以从请求的 Header、Body、Cookie 和 Query 中提取。如上图配置所示，网关在调用 auth-server 时，会进行如下参数提取：从 Header 中取出 headerKey 的 value。从 Query 中取出 queryKey 的...
DescribeApiHistory-查询历史版本详情
123456 DocShow string 文档可见，取值为：PUBLIC、PRIVATE PUBLIC MaxLength long 当 ParameterType=String，参数的最大长度限定 123456 DefaultValue string 默认值 20 ApiParameterName string API 参数名称 age EnumValue string 当 ...
CLI参数格式说明
对于API中不同类型的字段，阿里云CLI遵循如下格式要求：参数大小写：由于API参数严格区分大小写，阿里云CLI的参数输入也严格区分大小写。参数值大小写：虽然部分参数值可以不区分大小写，但为了保证统一的书写规范，建议您对参数值也严格...
通过SQL模式创建API（Dataphin表）
步骤二：配置API参数信息 在 新建API 页面，配置API基本信息和参数配置。API基本信息配置 参数 描述 API名称 填写API的名称。命名规则如下：只能包含汉字、字母、数字或下划线（_）。长度为4~42个字符。以字母开头。全局唯一。请求方式 API...
通过直连数据源模式创建API
步骤二：配置API参数信息 在 新建API 页面，配置API基本信息和参数配置。API基本信息配置 参数 描述 API名称 填写API的名称。命名规则如下：只能包含汉字、字母、数字或下划线（_）。长度为4~42个字符。以字母开头。全局唯一。请求方式 API...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
参数格式说明
对于API中不同数据类型的字段，阿里云CLI遵循如下格式要求：参数大小写：由于API参数严格区分大小写，阿里云CLI的参数输入也严格区分大小写。参数值大小写：虽然部分参数值可以不区分大小写，但为了保证统一的书写规范，建议您对参数值也...
- 产品推荐
- 这些文档可能帮助您