ModifyApiGroupNetworkPolicy-修改api分组的网络策略
修改api分组的网络。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用...
发布API商品
发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
功能总览
API 网关为网络隔离的系统间提供高性能、高安全、高可靠的通信。满足企业对外部合作伙伴开放业务的同时，帮助客户更好的进行场景和业务的创新。网关主要功能模块如下：API 全生命周期管理 快速构建多种协议类型的 API 支持按需导入导出 API...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
公共参数
本文档列举了物联网络管理平台 API 的公共请求参数和公共返回参数。公共请求参数是调用每个 API 时都需要使用的请求参数。名称 类型 是否必需 描述 Format String 是 返回值的类型，支持 JSON 和 XML 类型。Version String 是 API版本号，...
API 属性说明
本文将列出在 CNStack 控制台创建并发布 API 时，您需要配置的相关属性。API 定义 基本信息 属性 必填项 说明 API 名称 是 用于识别 API。支持中文、英文、数字、下划线（_）、连接符（-），且只能以英文和中文开头。32 个字符以内。同一个...
授权信息
无 apigateway:ModifyApi ModifyApi Write 全部资源*无 无 apigateway:ModifyApiConfiguration ModifyApiConfiguration Write 全部资源*无 无 apigateway:ModifyApiGroup ModifyApiGroup Write 全部资源*无 无 apigateway:ModifyApi...
CreateApi-创建 API
接口说明 此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为：单用户 QPS 不超过 50。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
VpcConfig
节点名"class="reference-link">节点名 VpcConfig 子节点"class="reference-link">子节点 名称 类型 是否必填 描述 VpcId String 否 专用网络ID InstanceId String 否 专用网络中的实例ID（Ecs/负载均衡）Port Integer 否 实例对应的端口号...
实例级别访问控制
API网关提供实例级别的访问控制，您可以分别配置针对IPv4和IPv6的访问控制策略组应用于实例，仅专享实例支持配置实例级别访问控制策略，并且仅对公网生效。1.创建访问控制策略组 1.1 在API网关控制台中实例页面，单击 访问控制，即进入访问...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
授权信息
条件关键字 描述 类型 bssapi:ProductCode 操作资源的产品code，示例：ecs STRING bssapi:ProductType 操作资源的产品类型，示例：ecs STRING 相关操作 您可以创建自定义权限策略，并将权限策略授予RAM用户、RAM用户组或RAM角色。...
混访混挂迁移示例
专有网络和经典网络存在很大的不同，除了安全隔离外，专有网络使您在云上具备了网络管理能力，但这些管理需要使用相关的网络产品实现。本文档中的迁移示例仅供参考，很多系统都比迁移示例的系统复杂。在迁移前需要仔细评估，梳理系统依赖，...
通过日志服务查看API调用日志
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
VpcAccessAttribute
描述"class="reference-link">描述 已授权的VPC信息 节点名"class="reference-link">节点名 VpcAccessAttribute 子节点"class="reference-link">子节点 名称 类型 描述 VpcId String 专用网络Id InstanceId String 专用网络中的实例Id（Ecs...
Gateway API
组件介绍 Gateway API是Kubernetes中用于对服务网络流量进行建模的一系列资源。它的目标是建立一套表现力强、易扩展、面向角色的服务网络模型。优势如下。面向角色：资源抽象与使用Kubernetes的团队组织架构保持一致。可移植：与Ingress和...
系统集群
本文列出了系统集群相关的所有 OpenAPI 及其请求参数、返回参数。创建系统集群 sofa.apigateway.sys.create 用于创建一个后端系统集群。请求参数 名称 类型 是否必填 示例 描述 param SystemClusterVO 是-param tenant_id STRING 是 ...
创建应用
在弹出的 创建应用 窗口中，选择或输入以下相关信息：应用类型：目前仅支持选择 应用，表示订阅的应用运行在 Web 浏览器、H5 容器、小程序、JS、业务系统中。应用名称：输入应用的名称，用于识别应用。描述：选填，用于描述应用的作用等，...
DescribeApiDoc-查询API说明文档
若您是开放 API 的用户，由于该接口面向 API 调用者鉴权，所以您需要确认该 API 为 PUBLIC 类型或者您的相关 APP 已被授权。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
管理授权对象
绑定的 API 在授权应用详情页的 绑定的 API 标签页中，可查看当前授权应用已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细...
应用管理
本文列出了应用管理相关的所有 OpenAPI 及其请求参数、返回参数。创建应用 sofa.apigateway.app.create 用于创建一个应用。请求参数 名称 类型 是否必填 示例 描述 param AppInfoVO 是 param tenant_id STRING 是 TSCPDICNT 租户标识 ...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些字段的取值范围等。同时，通过定义模型，并在用户创建的API中加以引用，用户在API的SDK导出时，关联的Model会自动生成对应的...
创建授权对象
在 API 订阅者创建应用后，API 发布者可根据应用创建授权对象。操作步骤 登录 API 网关控制台。在左侧导航栏中单击 API 发布>授权管理，进入授权列表。单击授权列表右上方的 创建授权对象。在弹出的 创建授权对象 窗口中，选择或输入相关...
API分组的归属实例迁移
2 迁移步骤 您可以在控制台的左侧栏的 API管理 —— 分组管理 —— 分组详情页 中找到变更分组实例链接，单击变更分组实例，选择 目标实例，务必仔细阅读注意事项，之后单击 确认迁移 完成分组迁移，分组迁移会实时生效在API网关二级域名的...
错误码
本文分类型列举调用物联网络管理平台 API 出错时，返回的错误码。其中公共错误码为所有 API 方法都有可能返回的错误。以下表格中的某些行包含一个以上错误码，其中最后一个为粗体。粗体的错误码在目前公测版的平台不存在，但今后会取代非...
QueryRequestLogs-获取请求日志
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
API网关灰度发布最佳实践
API网关客户在应用迭代过程中会不断有新版本API发布，在新版本正式发布前，可以使用灰度流量控制先进行小规模验证，将升级带来的影响限定在指定的用户范围内可以最大程度上保障线上业务的稳定运行，通过收集使用体验的数据，对应用新版本的...
路由规则
本文列出了联系方式相关的所有 OpenAPI 及其请求参数、返回参数。创建路由规则 sofa.apigateway.router.create 用于快速创建一个路由规则。请求参数 名称 类型 是否必填 示例 描述 param RouterInfoVO 是-param tenant_id STRING 是 ...
相关协议
关于网络智能服务的相关协议，请查看 网络智能服务的服务协议。
创建参数映射
API 网关支持参数映射。参数映射是将请求或响应参数中的不规范或者不统一的参数，映射为符合客户端或者服务端规范的参数。该功能常用于多部门协同、实现参数统一规范，以及实现统一错误码等场景。操作步骤 进入 API 网关控制台页面，在左侧...
DescribeDomain-查询自定义域名详情信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
CustomDomain
CustomDomains 描述"class="reference-link">描述 域名信息 节点名"class="reference-link">节点名 ...取值：NORMAL：正常 ABNORMAL：异常，该状态会影响API调用，需尽快解决 DomainRemark String 域名相关备注，如描述域名异常状态原因
配置Trace链路追踪
您可以参考本文在API网关控制台配置trace链路追踪日志上传到阿里云链路追踪平台，链路追踪 Tracing Analysis 提供了完整的调用链路还原、调用请求量统计、链路拓扑、应用依赖分析等工具，可以帮助用户提高开发诊断效率。本功能仅支持专享...
SetDomain-给指定分组绑定自定义域名
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
创建路由规则
在网关接收到请求后，会通过路由规则将请求路由到后端系统，您可在此创建相关的路由规则。操作步骤 登录 API 网关控制台页面。在左侧导航栏中单击 路由规则，进入路由规则列表。单击路由规则列表右上方的 创建路由规则。在弹出的 创建路由...
专享实例集群
API网关现在支持使用专享实例组建专享实例集群，突破最大规格专享实例的限制，以提供更高性能。概述 API网关当前可以提供的专享实例能够支持的最大能力有限（实例规格），当最大规格的专享实例还无法满足您的使用需要时，网关支持将同地域...
创建 CORS 规则
但在实际应用中，经常会发生跨域访问。为此，W3C 提供了一个标准的跨域解决方案：跨域资源共享（Cross-Origin Resource Sharing，CORS），支持安全的跨域请求和数据传输。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>...
ServiceConfig
是否启用VPC通道，目前可以取值：TRUE：启用VPC通道 FALSE：不启用VPC通必须先添加VPC授权成功后才能启用 VpcConfig String 否 如果启用VPC通道，VPC通道相关配置项，详情见 VpcConfig FunctionComputeConfig String 否 当后端是函数计算时...
- 产品推荐
- 这些文档可能帮助您