dos api-dos api文档介绍内容-阿里云

绑定/解绑 API

绑定 API 在授权管理页面，找到目标应用，单击其名称进入该授权应用详情页。在打开的绑定的 API 标签页中，单击 API 列表右上方的绑定 API。在弹出的绑定 API 窗口中，勾选需要绑定的 API。单击页面底部的确认，即可完成绑定。解绑 ...

创建后端为函数计算的API

本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...

API 分组

本文列出了 API 分组相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 分组 sofa.apigateway.apigroup.create 用于快速创建一个 API 分组。请求参数名称类型是否必填示例描述 param ApiGroupVO 是 param tenant_id STRING 是 ...

DescribeApiProductApis-查询API产品绑定的API列表

查询API产品绑定的API列表调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称类型必填描述示例值 ...

服务接入点

亚太地域名称地域ID 公网接入地址 VPC接入地址华北1（青岛）cn-qingdao apigateway.cn-qingdao.aliyuncs.com apigateway-vpc.cn-qingdao.aliyuncs.com 华北2（北京）...southeast-2 apigateway.ap-southeast-2.aliyuncs....

名词解释

名词解释应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权授予某个APP调用某个API...

对象存储

创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...

API概览

我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...

DescribeDeployedApis-查询已发布 API 列表

接口说明此功能面向开放 API 的用户调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 ...

版本管理

1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...

DescribeApis-查询定义中的 API 列表

接口说明此功能面向开放 API 的用户接口返回所有定义中的 API 列表，以及概况信息请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果调试您可以在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)地域...

获取服务端信息

为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法应用信息应用标识 APPID 在网关中，应用在环境中的唯一标识...

ApiHisItem

描述"class="reference-link">描述列举API信息项的类型节点名"class="reference-link">节点名 ApiHisItem 子节点"class="reference-link">子节点名称类型描述 RegionId String 所在的region GroupId String API分组编号 GroupName ...

AuthorizedApi

AuthorizedApis 描述"class="reference-link">描述应用和API的对应关系节点名"class="reference-link">节点名 AuthorizedApi 子节点"class="reference-link">子节点名称类型描述 RegionId String API所在区域 GroupId String API分组 ...

ApiSummary

ApiSummarys 描述"class="reference-link">描述 API概要信息项节点名"class="reference-link">节点名 ApiSummary 子节点"class="reference-link">子节点名称类型描述 RegionId String 所在的region GroupId String API分组编号 ...

创建后端服务为HTTP的API

1 概述您需要依次完成以下步骤：创建分组定义API 创建应用和API授权调试API 调用API 2 创建分组 API分组是API的管理单元，因此需要先创建API分组，然后在分组下创建API。步骤1 创建分组在 API管理中选择分组管理，选择Region，点击 ...

ApiInfo

描述"class="reference-link">描述列举API信息项的类型节点名"class="reference-link">节点名 ApiInfo 子节点"class="reference-link">子节点名称类型描述 RegionId String 所在的region GroupId String API分组编号 GroupName String...

ApiPluginSummary

描述绑定到插件的API概要信息节点名 ApiPluginSummary 子节点名称类型描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String...

API调试及自助排错

API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...

DeleteApiProduct-删除API产品

删除API产品，会自动删除API与API产品的绑定关系（如果存在API产品与APP的授权关系，将删除失败）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权...

AttachApiProduct-将API绑定到指定API产品

将API绑定到指定的API产品（如果指定的API产品不存在，将自动创建）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出...

API unsupport the channel

API unsupport the channel:HTTP，API 只允许 HTTPS 访问，而发起 API 请求时却使用了 HTTP，则会得到此提示。API unsupport the channel:HTTPS，API 只允许 HTTP 访问，而 API 请求却使用的是HTTPS，则会得到此提示。解决方案：API ...

授权信息

API：是指操作对应的API接口。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。资源类型：是指操作中支持授权的资源类型。具体说明如下：对于必选的资源类型，用背景高亮的方式表示。对于不支持资源...

API 管理

},"workspace_id":"antdemo","upstream_path":"/openapi/apigateway/test/api1","sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd","path":"/openapi/apigateway/test/api1","domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",...

多级API网关

用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。...在两个分组上创建两个业务API 在每个分组下分别生成一个业务API，两个API均设置为APP鉴权模式，假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：...

DescribeApisByBackend-根据后端查询 API 列表

1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...

ApiIpControlItem

描述列举API上IP访问控制信息项的类型节点名 ApiIpControlItem 子节点名称类型描述 ApiId String API编号 ApiName String API名称 IpControlId String IP访问控制ID IpControlName String IP访问控制名称 BoundTime String 绑定时间

查看API操作历史

操作步骤登录API网关控制台。在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击管理进入API详情页。在API详情页的左侧栏点击操作历史。目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、...

API网关监控

本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...

混合云API集中管理

本文介绍了如何结合云企业网（CEN），构建跨Region的集中式API管理方案。同时您也可以参考本例中的步骤，结合CEN、高速通道，构建在VPC间、VPC与本地数据中心间的集中式API管理，从而实现全网资源都可以发布在API网关、并通过API网关进行...

API 版本管理

下线后，API 状态切换为未发布，无法被该 API 的订阅方应用继续调用。您可以通过以下任一方法下线 API 当前版本：在 API 列表中选择要下线的 API，单击下线>确认。在 API 详情页面，单击右上角的下线按钮。在 API 详情>版本管理页签中...

使用SDK调用API

1.下载SDK 控制台提供两种SDK的下载方式，如下：1.1 在调用API 的已授权API的SDK 中下载应用APP的SDK，此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java。其他语言调用示例在页面下方。1.2 在开放API 的...

ModifyApi-修改API定义

接口说明"此接口面向开放 API 的用户该接口需要全量更新，不支持部分参数更新修改 ApiName 时需要注意，同一个分组内 API 不允许重名修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复该接口调用的 QPS 限制为：单用户 QPS ...

DeleteApi-删除 API 定义

接口说明此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算...

AbolishApi-下线 API

接口说明此功能面向开放 API 的用户，和发布 API 相对应将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算...

创建后端服务为VPC内资源的API

概述您需要依次完成以下步骤：创建VPC授权创建分组创建并定义API 创建应用和API授权安全组放行调试API 调用API 1.创建VPC环境购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...

概述

4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...

DescribePluginApis-查询插件绑定的API列表

调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...

DeployApi-发布 API

接口说明此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试您可以在OpenAPI Explorer中直接运行该接口，...

dos api

新品推荐