名称 类型 描述 示例值 object 按照 API 名称分组的 API 列表。name string API 名称。test-api versionEnabled boolean 是否开启版本管理。true versionedHttpApis array 版本化的 API 版本信息。HttpApiApiInfo API 信息。
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 API列表。3.选择需要查看的API点击操作列下 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 编辑 按钮...
云原生API网关支持API设计、开发、测试、发布、下线等生命周期管理。
描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiHisItem 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName ...
ApiSummarys 描述"class="reference-link">描述 API概要信息项 节点名"class="reference-link">节点名 ApiSummary 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 ...
描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 ApiInfo 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String...
API unsupport the channel:HTTP，API 只允许 HTTPS 访问，而发起 API 请求时却使用了 HTTP，则会得到此提示。API unsupport the channel:HTTPS，API 只允许 HTTP 访问，而 API 请求却使用的是HTTPS，则会得到此提示。解决方案：API ...
本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数 名称 类型 是否必填 示例 描述 param ApiGroupVO 是 param tenant_id STRING 是 ...
AuthorizedApis 描述"class="reference-link">描述 应用和API的对应关系 节点名"class="reference-link">节点名 AuthorizedApi 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String API所在区域 GroupId String API分组 ...
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
描述 绑定到插件的API概要信息 节点名 ApiPluginSummary 子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String...
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
名称 类型 示例 描述 data BOOLEAN true,false data 更新授权应用限流 sofa.apigateway.api.authapplimit.update 用于更新指定授权应用的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 否 api_id1 API 标识 auth_app_...
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
描述 列举API上IP访问控制信息项的类型 节点名 ApiIpControlItem 子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 IpControlId String IP访问控制ID IpControlName String IP访问控制名称 BoundTime String 绑定时间
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
操作步骤 登录API网关控制台。在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击 管理 进入API详情页。在API详情页的左侧栏点击 操作历史。目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、...
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
创建API并添加接口 管理API版本 发布API 在线调试API 下线API 版本管理 当API存在版本变更时，可通过版本管理实现新旧API的并存与升级。管理API版本 发布历史管理 记录API发布信息，并支持发布回滚。切换历史版本 API策略管理 对API及接口...
请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与跟踪。X-Ca-Error-Message。API网关返回的错误消息，当请求出现错误时API网关会通过响应头...
接口说明 此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，...
API名称 API版本 配额 配额维度 UpdateResource 2022-08-30 10/1(s)地域：*API限速维度：regionId,API,ParentUid GetResourceType 2022-08-30 100/1(s)地域：*API限速维度：regionId,API,ParentUid CreateResource 2022-08-30 10/1(s)地域...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。...在两个分组上创建两个业务API 在每个分组下分别生成一个业务API，两个API均设置为APP鉴权模式，假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：...
本文介绍了如何结合云企业网（CEN），构建跨Region的集中式API管理方案。同时您也可以参考本例中的步骤，结合CEN、高速通道，构建在VPC间、VPC与本地数据中心间的集中式API管理，从而实现全网资源都可以发布在API网关、并通过API网关进行...
1.下载SDK 控制台提供两种SDK的下载方式，如下：1.1 在 调用API 的 已授权API的SDK 中下载应用APP的SDK，此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java。其他语言调用示例在页面下方。1.2 在 开放API 的...
重要 您需要先在云原生API网关服务里创建 容器服务 的服务来源，详情可参见 创建服务来源。操作步骤 登录 云原生API网关控制台。在左侧导航栏，选择 API管理，并在顶部菜单栏选择地域。单击 创建API，在创建API弹框中单击 HTTP API 卡片中...
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看region（地域）、分组、以及API的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
API 提供者在此提供标准的 API 服务，开发者在此将标准化的 API 服务整合进自己的应用，从而衍生出新的应用，新的服务。API 网关以此促进企业建立商业生态、跨界创新。通过 API 网关将企业的核心能力，开放给合作伙伴，达成深度合作，协同...
API网关（API Gateway），提供API托管服务，覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等API各个生命周期阶段，帮助您快速建设以API为核心的系统架构。构建中台。通过API网关强大的适配和集成能力，可以将各种业务系统的...
RELEASE:线上 PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 ...
添加API接口后，您需要为API接口添加策略，提高API的安全性、性能和可维护性。前提条件 已完成REST API创建并添加接口。具体操作，请参见 创建REST API并添加接口。操作步骤 登录 云原生API网关控制台。在左侧导航栏，单击 API管理，并在...
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
本文介绍API网关和云原生API网关的SDK和API的支持情况，供您进行对应的开发操作。API网关 为了您快速使用API网关产品，阿里云为您提供了多种API网关的交互方式。API参考 CLI参考 SDK参考 Terraform 资源编排 云原生API网关 为了您快速使用...
背景信息 API网关-监控服务关联角色（AliyunServiceRoleForApiGatewayMonitoring）是为了方便用户对同一分组上的所有API应用相同的报警配置时，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关通过服务...
下线后，API 状态切换为 未发布，无法被该 API 的订阅方应用继续调用。您可以通过以下任一方法下线 API 当前版本：在 API 列表中选择要下线的 API，单击 下线 确认。在 API 详情页面，单击右上角的 下线 按钮。在 API 详情 版本管理 页签中...