构建语言支持
4.4.1、4.5.1、4.6、4.7、4.8.1、4.9、4.10.3、5.3.1、5.4.1、5.5.1、5.6.4、6.5、6.6、6.7、6.8、6.8.1、6.8.2、6.8.3、6.9、6.9.1、6.9.2、7.0、7.0.1、7.0.2、7.1、7.1.1、7.2、7.3、7.3.1、7.3.2、7.3.3、7.4.1、7.4.2、7.5 JDK 1.6 ...
GetDataServicePublishedApi
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetDataServicePublishedApi 系统规定参数。...
ListDataServiceApis
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListDataServiceApis 系统规定参数。取值：...
系统集群
本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。创建系统集群 sofa.apigateway.sys.create 用于创建一个后端系统集群。请求参数 名称 类型 是否必填 示例 描述 param SystemClusterVO 是-param tenant_id STRING 是 ...
OpenApiGatewayService-开通服务
2D39D1B3-8548-508A-9CE2-7F4A3F2A7989 示例 正常返回示例 JSON 格式 {"OrderId":"210981*530495","RequestId":"2D39D1B3-8548-508A-9CE2-7F4A3F2A7989"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂无...
参数映射与校验规则
123"${User}.${Group}.api.io 123.g01.api.io User:"123"Group:"g01"${Admin}.admin.api.io${User}.${Group}.api.io.123.api.io User:"123"${Admin}.admin.api.io${User}.${Group}.api.io 123.admin.api.io Admin:"123"${Admin}.admin.api...
ModifyApiGroupInstance-修改api分组所属的实例
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
镜像构建问题
从海外下载基础镜像导致流水线镜像构建任务缓慢 问题描述：当您使用云效进行镜像构建时，如果你的 Dockerfile 中，指定下载 dockerhub 的镜像，比如：FROM Nginx FROM java:8 FROM openjdk:8-jdk-alpine Flow 在构建时，就会从 Dockerhub ...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
CreatePlugin-创建API网关插件
接口说明 此接口面向开放 API 的用户 限制每个用户同一类型的插件可以创建的数量，不同类型，上限不同 高级功能的插件定义限制使用 插件创建后未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效。调试 您可以在OpenAPI ...
DescribePluginSchemas-描述插件模式
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
参数访问控制插件
1.概述 访问控制插件可以根据请求参数或上下文，来执行条件判断，用于过滤不希望传递到后端的请求，参考 参数与条件表达式的使用 来了解如何定义参数和使用条件表达式。2.配置说明 在这个例子中假设我们的API请求Path为/{userId}/.,API使用...
使用简单认证（AppCode）方式调用API
阿里云API网关提供多种针对客户端请求的安全认证方式，包括阿里云APP认证方式、jwt插件、第三方鉴权等。对于”阿里云APP“这种认证方式，目前用户可以设置两种认证形式：1.签名认证；2.简单认证。1.概述 对于请求的签名认证方式，可以参考...
CreateInstance-创建实例
PricingCycle 为 Year，表示按年付费，取值范围为 1~3。说明 ChargeType 取值为 PrePaid 时，本参数可用且必须传入。1 PricingCycle string 否 指定预付费实例为包年或包月类型，取值范围如下：year：年 month：月 说明 若付费类型为 ...
SdkGenerateByGroup-按分组生成SDK
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:SdkGenerateByGroup Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 GroupId string 是 api 分组 id，系统生成，全局唯一 1a991a450b9548a1a3df38fd3af117c2 Language ...
应用管理
key":"5790AHAxbUjxXMEzMFV74l6wtzZH*","authentication_type":"SECRET"},"app_id":"TGcdFd3i1v4EOUXD","operator":""},"result_code":"OK"} 删除应用 sofa.apigateway.app.delete 用于删除指定 APPID 的应用。请求参数 名称 类型 是否必填...
配置后端服务Host（域名头）
5.后端路由插件配置Host 后端路由插件中可以通过httpTargetHostName 或vpcTargetHostName来指定API网关请求后端的域名头（Host），这种方式优先级最高，更多配置详情可以参考文档 后端路由 的1.3章节。Host头优先级 如果同时用这几种方式...
ModifyInstanceAttribute-修改指定实例的信息
是否开启 API 网关自调用域名 false Token string 否 客户端 Token，用于保证请求的幂等性 c20d86c4-1eb3-4d0b-afe9-c586df1e2136 IntranetSegments string 否 自定义网段，所配置的网段将被视为私网地址 172.0.0.1/24 MaintainStartTime ...
DescribePluginsByApi-查询API上绑定的插件
接口说明 此功能面向开放 API 的用户 支持分页 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
ModifyVpcAccessAndUpdateApis-修改VPC授权信息，并且...
VpcName Token string 否 口令 c20d86c4-1eb3-4d0b-afe9-c586df1e2136 NeedBatchWork boolean 否~是否需要刷新关联的 API，警告 如果您的 VPC 授权需要更新，并且该授权被 API 关联并已经发布上线，需要配置为 true，否则您的 API 的后端...
DescribeInstances-查询实例列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
通过服务编排的方式创建API
基于已开发好的API，将多个API通过服务编排的方式创建API。本文为您介绍如何通过服务编排的方式创建API。步骤一：选择生成API的方式 在Dataphin首页，单击顶部菜单栏 服务。系统默认进入 市场 页面。按照下图操作指引，进入 新建API 创建...
API网关灰度发布最佳实践
假设，某个API授权给了多个应用，在API后端服务有升级的情况下，为了控制升级对线上可能存在的未知影响，我们可以参照本文3.1 给出的后端路由插件配置，将其中两个应用的请求路由到新版后端服务。基于JWT的灰度：当API绑定JWT插件时，API...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
后端路由
1098,2011中的一个，且使用HTTPS协议请求$CaHttpScheme='HTTPS' and ($CaAppId=1001 or$CaAppId=1098 or$CaAppId=2011)1.3.Backend的定义与覆盖规则 Backend的结构与API网关导入Swagger时的结构一致，详细请参考文档 导入API网关的扩展...
API分组的归属实例迁移
1 不同实例的适用场景 共享实例（VPC）：多租户共享出口IP与带宽，易受其他租户影响，更适合开发测试、评估和小规模的生产环境使用。专享实例（VPC）：用户可以通过支付规格配置费用自助购买更高的RPS，获取独享的资源，包含公网入口IP地址...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribePlugins-查询插件列表
接口说明 支持分页 支持按照插件业务类型查询 支持按照插件 ID 查询 支持按照插件名称查询 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 ...
DescribeApiHistory-查询历史版本详情
查询指定API的某一次历史发布版本的定义详情，即某一次历史发布时发布的API定义。接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次...
DescribePricingModule-查询产品模块信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
SetDomainCertificate-为自定义域名添加SSL证书
接口说明 此功能面向 API 提供者。SSL 证书必须与域名匹配。绑定 SSL 证书后，可提供基于 HTTPS 的 API 服务。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码...
API 分组
{"param":{"group_name":"apigroup3","api_group_id":"gjrjknp1s4alzubn","description":"abcd"},"tenant_id":"JADDGOCN","workspace_id":"antdemo"} 返回示例 {"data":true,"result_code":"OK"} 通过 ID 查询 API 分组 sofa.apigateway....
QuerySettleBill-结算账单查询服务
RequestId":"AE3F4057-DFC9-4B81-8858-F620651010C9","Success":true,"Data":{"NextToken":"CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U",...
DescribeProductAmortizedCostByAmortizationPeriod-...
Data":{"NextToken":"CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U","AccountID":"185766xxxx","AccountName":"test@test.aliyunid.com ",...
后端内网域名解析（仅专享实例）
后端内网域名指的是在API网关中配置的后端服务地址。当后端服务地址为内网域名时，API网关提供实例级别的后端服务内网域名解析。概述 例如，后端服务使用的内网域名是通过 PrivateZone 解析时，解析只能在客户指定的VPC内生效，API网关不在...
DescribeInstanceAmortizedCostByAmortizationPeriod-...
Data":{"NextToken":"CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U","AccountID":"185766xxxx","AccountName":"test@test.aliyunid.com",...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao dypnsapi.aliyuncs.com华北2（北京）cn-beijing dypnsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dypnsapi.aliyuncs.com华北5（呼和浩特）...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao dytnsapi.aliyuncs.com华北2（北京）cn-beijing dytnsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dytnsapi.aliyuncs.com华北5（呼和浩特）...
Java SDK 说明
JDK 1.8，运行 java-version 查看当前 Java 版本。Maven 3.5.4 及以上版本，在终端运行 mvn-v 查看当前 Maven 版本。在 Linux 下使用 SDK，要求 GLIBC 版本高于 2.14。Maven依赖 x86_64环境<dependency><groupId>...
启动失败
用户资源组JDK设置错误 报错信息 解决方法 MaxCompute新建任务，调度配置有多个网关资源组，一般有一个默认的资源组，需要JDK为1.8及以上版本，出现上述报错的主要原因可能是JDK版本过低，手动更换一个资源组即可。找不到工程的Volume 报错...
- 产品推荐
- 这些文档可能帮助您