GetApiTemplate-查看API模板内容
错误信息 描述 400 ConflictParameters Parameters that must not be used together.%s 多个参数间存在冲突。400 IncompleteSignature The request signature is invalid.API请求签名不合法。400 InvalidAction The action%s requested is ...
RenewChangeInstance-续费变配服务
disk Code string 是 第 n 个模块属性 code 配置，n 的取值范围为（1~100），如有多个模块属性参数，按照 n=1,2,3…n 的形式拼接多个参数。Bandwidth ClientToken string 否 用于保证请求的幂等性。JASIOFKVNVIXXXXXX RenewPeriod long 是 ...
绑定/解绑 API
创建 CORS 规则后，您可在规则下绑定/解绑指定的 API。...批量解绑：若需要一次解绑当前规则下的多个 API，可先通过左侧的复选框勾选多个 API 后，单击页面底部的 批量解除授权，在弹出的确认框中单击 确定，即可批量解除 API 的绑定。
ModifyInstance-实例变更服务
test Code string 是 第 n 个模块属性 code 配置，n 的取值范围为（1~100），如有多个模块属性参数，按照 n=1,2,3…n 的形式拼接多个参数。说明 只设置需要变更配置的模块属性信息，如 A,B 两个属性中，只有 A 需要变更配置，则只传 A 属性...
CreateInstance-实例创建服务
disk Code string 是 第 n 个模块属性 code 配置，n 的取值范围为（1~100），如有多个模块属性参数，按照 n=1,2,3…n 的形式拼接多个参数。InstanceType 返回参数 名称 类型 描述 示例值 object Code string 状态码。Success Message ...
绑定/解绑 API
授权对象创建成功后，您可在该授权对象下批量绑定或解绑指定的 API。...批量解绑：若需要一次解绑当前授权应用下的多个 API，可先勾选多个 API 后，单击页面底部的 批量解除绑定，在弹出的确认框中单击 确定，即可批量解除绑定多个 API。
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
后端服务地址如何录入？
后端服务地址中可以存在多个动态参数，多个动态参数名称不可重复。后端服务地址中的动态参数需要配合 Path 中的动态参数使用，在配置 Path 时，配置与 Path 的映射关系。示例：https://api.domain.com/resource/subresource/[subresourceid...
API概览
GetParameters 获取一个或多个普通参数的详细信息 获取一个或多个参数的详细信息。加密参数 加密参数 CreateSecretParameter 创建一个加密参数 创建一个加密参数。请确保在使用该接口前有操作CreateSecret API的权限。...
应用场景
避免多个场景多套API，大幅降低管理运维成本。3.轻松实现系统集成，规范化、标准化 通过 API 网关对系统间接口进行规范统一，用标准化的接口实现系统集成；快速完成资源整合和管理，消除快速发展造成的冗余和浪费，聚力发展业务。
DescribeDomainList
您可以设置该参数，模糊查询多个域名是否已接入WAF防护。PageNumber Integer 否 1 分页查询时，返回第几页数据。默认值为 1，表示返回第1页数据。PageSize Integer 否 10 分页查询时，每页包含多少条结果。默认值为 10，表示每页包含10条...
DescribeDefenseRules-分页查询防护规则
您可以设置该参数，查询多个防护规则。多个防护规则之间使用英文逗号（,）分隔。templateId Long 可选 24354 要查询的防护模板 ID。您可以设置该参数，查询某个防护模板中的防护规则。orderBy String 可选 name 设置防护规则排序方式。取值...
DescribeDefenseResources-分页查询防护对象
您可以设置该参数，查询多个已接入 WAF 的防护对象。多个防护对象之间使用英文逗号（,）分隔。instanceId String 可选 alb-nifa24*要查询的防护对象的实例 ID。您可以设置该参数，精确查询已接入 WAF 的防护对象的实例 ID。domain String ...
API调用特殊参数
我们提供了一系列内置的请求参数，在API的调用过程中，用户可以通过这些特殊的请求参数，在数据API原有的查询逻辑上添加聚合、排序、过滤返回字段等等额外的逻辑，或者在返回结果里透出额外的信息字段等等。使用场景 交管云控平台使用 数据...
API调用特殊参数
我们提供了一系列内置的请求参数，在API的调用过程中，用户可以通过这些特殊的请求参数，在数据API原有的查询逻辑上添加聚合、排序、过滤返回字段等等额外的逻辑，或者在返回结果里透出额外的信息字段等等。使用场景 交管云控平台使用 企业...
API概览
本手册将详细介绍WebAPI的功能、使用方法及详细参数的设定。API说明文档：包括应用相关API，上传数据API，数据搜索API。API访问上分为URL请求串及请求Header参数两部分，所有请求均必须包含该两部分才能执行。术语表 术语 全称 中文 说明 ...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
功能特性
批量授权与导入导出 当需要将单个 API 绑定给多个应用时，或单个应用需要绑定多个 API 时，支持通过批量授权方式统一绑定。API 管理过程中，也支持直接通过批量导入和导出的方式创建 API，大大提高配置效率。安全认证 为了保证数据在传输...
通过服务编排的方式创建API
基于已开发好的API，将多个API通过服务编排的方式创建API。本文为您介绍如何通过服务编排的方式创建API。步骤一：选择生成API的方式 在Dataphin首页，单击顶部菜单栏 服务。系统默认进入 市场 页面。按照下图操作指引，进入 新建API 创建...
后端签名插件
Key1+"="+Value1+"&"+Key2+"="+Value2+."&"+KeyN+"="+ValueN 说明 这里 Query 或 Form 参数的 Value 可能有多个，多个的时候只取第一个 Value 参与签名计算；只要传递了的参数，签名过程中的等号“=“无论什么情况都需要保留，比如这两个...
请求结构
OpenAPI 服务地址 TSDB API 的服务接入地址为：hitsdb.aliyuncs.com 。OpenAPI 通信协议 支持通过...OpenAPI 请求参数 每个请求都需要指定要执行的操作，即 Action 参数。此外，每个操作都需要包含的公共请求参数和指定操作所特有的请求参数。
Restful API
Elasticsearch官方参考文档 单文档API：Index API Get API Delete API Update API 多文档API：Multi Get API Bulk API Delete By Query API Update By Query API Reindex API 使用REST Client交互 客户端访问仅支持HTTP/TCP方式，建议您...
请求结构
OpenAPI服务地址 PolarDB-X 1.0 API的服务接入地址为：drds.aliyuncs.com 。OpenAPI通信协议 支持...OpenAPI请求参数 每个请求都需要指定要执行的操作，即Action参数。此外，每个操作都需要包含的 公共请求参数 和指定操作所特有的请求参数。
通过云控制API实现资源管理
让开发者无需维护多套SDK、学习多个产品的OpenAPI。在极大降低学习成本和代码复杂度的同时，能够在云产品新特性发布时，通过简单新增资源属性即可完成新特性集成。本文以专用网络资源为例，为您介绍如何通过云控制API实现专有网络VPC资源的...
API调用特殊参数说明
参数列表 说明 特殊参数的Key为系统保留字，因此在API参数命名时应尽量避免与上述参数名重合，后续也会在设置参数时增加校验避免此类问题 参数 说明 示例值 return_fields 指定返回字段（多个时逗号分隔）aa,bb,ccc aggregation 聚合计算...
自定义服务API
在 发布成功 页面，单击 再次新建，可创建多个自定义API；单击 去列表查看，可查看已创建的API。后续操作 已创建的自定义服务API可以调用来获取数据。具体操作，请参见 管理与使用。调用示例，请参见：Java SDK调用示例 Python SDK调用示例...
通过向导模式创建API（Dataphin表）
API请求参数和返回参数配置 在配置API 请求参数 和 返回参数 过程中，您需要先确定API的入参和出参的来源（逻辑表），再将入参和出参分别添加至 请求参数 和 返回参数 区域，最后配置 请求参数 和 返回参数 的基本信息。在 参数配置 面板，...
通过命令行调用API
您可以通过以下特点判断API类型：API参数中包含Action字段的是RPC API，需要PathPattern参数的是RESTful API。一般情况下，一个云产品的API类型是一致的。启动Cloud Shell 登录 OpenAPI 门户。在顶部导航栏，单击 选择云产品，在面板中根据...
CORS 配置
本文列出了 CORS 跨域资源共享相关的 OpenAPI 及其请求参数、返回参数。创建 CORS 配置 sofa.apigateway.cors.create 用于创建 CORS 配置。请求参数 名称 类型 是否必填 示例 描述 param CorsInfoVO 否-CORS 配置信息 tenant_id STRING 否 ...
GetRankingModelTemplate-查看排序模型配置详情
请求语法 GET/v2/openapi/instances/{instanceId}/ranking-model-templates/{templateId} 请求参数 名称 类型 必填 描述 示例值 instanceId string 否 实例 ID airec-test templateId string 否 模型 ID 123 返回参数 名称 类型 描述 示例...
DescribeLogServiceStatus
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DescribeLogServiceStatus 要执行的操作。取值...
通过注册方式创建API
Body：在解析请求参数时如果有多个参数，则会封装成一个Body。参数类型 当参数位置为 Body 时，支持选择参数类型为 Array(int)、Array(string)和 Object。当参数位置为其他时，参数类型包括 DOUBLE、FlOAT、STRING、DATE(yyyy-MM-dd HH:mm:...
Nacos
集群：微服务应用所在的集群名称，非必填参数，如果需要设置多个集群，那么多个集群名称请以逗号间隔。若您的Nacos服务开启了权限认证，那么您也需要填写相关的鉴权信息。如果您使用的是原生Nacos且开启了账号密码认证，那么您需要选择的...
GetExtraDataSource-查看其他数据源详情
请求语法 GET/v2/openapi/instances/{instanceId}/extra-data-sources/{type}/{dataSourceId} 请求参数 名称 类型 必填 描述 示例值 instanceId string 是 实例 ID airec-test type string 是 数据源类型 UserCustomDataSource ...
通过向导模式创建API（服务单元）
API请求参数和返回参数配置 在配置API 请求参数 和 返回参数 过程中，您需要先确定API的入参和出参的来源（服务或单元），再将入参和出参分别添加至 请求参数 和 返回参数 区域，最后配置 请求参数 和 返回参数 的基本信息。在 参数配置 ...
V2版本RPC风格请求体&签名机制
按照参数首字母的字典顺序对参数排序，字典序大写字母在小写字母前面，排序参数包括 公共请求参数和接口自定义参数（即 OpenAPI 文档中的请求参数），不包括公共请求参数中的 Signature 参数。公共请求参数详情，请参见上文 公共请求参数。...
RemoveAppsAuthorities-撤销多个APP对指定API的访问...
撤销多个APP对指定API的访问权限，多个APP一个API。接口说明 此功能面向 API 提供者和 API 使用者 撤销前请查看添加授权记录的授权者，API 所有者只能撤销 Provider 的授权，API 使用者只能撤销 Consumer 的授权 调试 您可以在OpenAPI ...
SetSignatureApis-绑定签名密钥与API
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:SetSignatureApis Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 当前API无需请求参数 返回参数 名称 类型 描述 示例值 当前API暂无返回参数 示例 正常返回示例 JSON ...
SwitchApi-切换指定环境中正在运行中的API定义
SwitchApi Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 当前API无需请求参数 返回参数 名称 类型 描述 示例值 当前API暂无返回参数 示例 正常返回示例 JSON 格式 {"RequestId":""} 错误码 访问 错误中心 查看更多错误码。...
通过SQL模式创建API（Dataphin表）
API请求参数和返回参数配置 在配置API 请求参数 和 返回参数 过程中，您需要先确定入参和出参的来源（Dataphin逻辑表），再编写API SQL并解析出 请求参数 和 返回参数，最后配置 请求参数 和 返回参数 的基本信息。在 参数配置 页面，选择...
- 产品推荐
- 这些文档可能帮助您