简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API安全
单击API列表右上角的 图标，API安全将为您创建一个导出任务。单击 API安全 页面右上角的 导出记录。定位到要下载的文件，单击 操作 列的 下载。说明 如果您设置了查询条件，则导出文件只包含查询到的数据，否则包含所有数据。导出文件生成...
管理应用
编辑应用信息 打开应用编辑界面有以下两种方式：在应用列表页，单击应用右侧 操作 列中的 编辑 即可打开编辑应用界面。单击应用名进入应用详情页后，单击页面右上方的 编辑 即可打开编辑应用界面。打开的 编辑应用 界面与创建应用界面内容...
导入导出 API
批量导出 API 在 API 发布>API 管理 页面，在 API 列表左侧勾选需要导出的 API。单击 API 列表右下角的 批量导出 按钮，即可将选择的 API 转换为 JSON 文件保存至本地。批量导入 API 在 API 发布>API 管理 页面，单击 API 列表右上方的 ...
管理授权对象
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的筛选按钮。在打开的筛选框中，选择...
管理外部授权 API
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
添加API标签
在左侧导航栏，单击 图标，选择 API管理>API 列表。在 API列表，选中目标API，单击 批量操作，选择 添加标签。在 批量添加标签 对话框中选择标签，或在标签名称框自定义填写需要添加的标签名称，单击 确认。在API列表页面，单击 图标，根据...
管理路由规则
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的筛选按钮。在打开的筛选框中，选择...
添加API标签
在左侧导航栏，单击 图标，选择 API管理>API 列表。在 API列表，选中目标API，单击 批量操作，选择 添加标签。在 批量添加标签 对话框中选择标签，或在标签名称框自定义填写需要添加的标签名称，单击 确认。在API列表页面，单击 图标，根据...
管理 CORS 规则
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 配置信息、版本管理、监控、流量治理、CORS、授权对象、API 调试 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的...
API概览
DescribeApisByApp 根据应用查询API列表 根据APP查询关联的API列表。DescribeAuthorizedApis 查询已授权的API列表 查询指定 APP 已授权的API列表，即指定 APP 的API列表。DescribeApiDoc 查询API说明文档 查询指定API的服务说明文档。...
管理 API 渠道
在 API 列表中，找到要查看的 API，单击 操作 列下的 查看 菜单，查看该 API 详情，包括 API 标识、API 名称、内容形式和创建时间。编辑 API 渠道 在 API 列表中，找到要编辑的 API，单击 操作 列下的 编辑 菜单，编辑 API 信息。重要 API ...
查看API操作历史
在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击 管理 进入API详情页。在API详情页的左侧栏点击 操作历史。目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、解绑插件。
获取API调用信息
API的调用权限依赖应用进行管理，因此您在调用API时，需要先获取...在已获授权API列表，应用维度 页签下，选择目标应用，获取 应用code。单击 图标，选择目标API，单击操作列中的 授权详情，获取 认证方式、访问路径、AppKey 和 AppSecret。
查看及管理API
查看及管理API列表 API创建完成后，您可在API列表执行发布、版本管理、删除等操作。区域 描述 ① 筛选及搜索区 您可根据API的名称或ID进行搜索，也可根据API类型、API分组进行筛选。② 列表区 为您展示API名称、API_ID、API类型、API分组、...
管理 API 分组
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
测试已获授权API
通过测试API，了解API运行结果详情。...应用维度：以应用为视角展示对应应用下的API，单击加号展开应用下的API列表。在 已获授权API 列表，单击待调试API 操作 列的 测试。进入 测试 页面，配置请求参数默认值，单击 开始测试，核对返回内容。
版本管理
2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 编辑 按钮。编辑API定义的流程和创建API定义一致，详细信息参见 创建 API，如果您想...
API列表
以下是ID²服务端和设备端的API列表。设备端API 设备端API详细信息，请参考 设备端API。API 描述 id2_client_init ID² Client SDK初始化，使用ID²设备端其它API之前，需要先调用该API进行初始化操作。id2_client_get_id 获取ID²字符串。...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
绑定/解绑 API
在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API。单击页面底部的 确认，即可完成绑定。说明 一个规则下可绑定多个 API，但一个 API 只可绑定一个规则。解绑 API 在 CORS ...
批量操作API
2、在API网关的控制台单击左侧栏的 API管理，单击进入 API列表。3、勾选需要批量操作的API，不支持隔页勾选。目前支持的批量操作包含导出swagger、API授权、发布、下线、删除、标签、批量修改API基础配置。重要 批量操作一定要仔细核对选中...
绑定/解绑 API
在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API。单击页面底部的 确认，即可完成绑定。解绑 API 在 授权管理 页面，找到目标应用，单击其名称进入该授权应用详情页。解除 ...
查看API授权详情
应用维度：以应用为视角展示对应应用下的API，单击加号展开应用下的API列表。在 已获授权API 列表，单击 操作 列中的 授权详情，可查看API授权详情。说明 如果授权数据范围无数据，表示没有设置授权过滤参数，若需设置，具体操作，请参见 ...
DetachApiProduct-解除API与API产品的绑定关系
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e Apis object[]是 API 列表 ApiId string 是 API 的 ID ba84c55eca46488598da17c0609f3ead StageName string 是 环境名称，取值...
AttachApiProduct-将API绑定到指定API产品
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e Apis object[]是 API 列表 ApiId string 是 API 的 ID 551877242a4b4f3a84a56b7c3570e4a7 StageName string 是 环境名称，枚举...
API概览
API列表 API 描述 CreateAppGroup 调用CreateAppGroup创建应用分组。CreateJob 调用CreateJob创建任务。GetJobInfo 调用GetJobInfo获取指定Jobid任务详情，通常用来更新任务。UpdateJob 调用UpdateJob更新任务配置信息。DeleteJob 调用...
创建后端为函数计算的API
步骤9 创建应用 在 调用API 菜单中选择 应用管理，创建一个APP，如下图所示。可以看到阿里云APP下有两种认证方式，AppKey和AppCode。本例中我们选择使用APPCode的方式进行简单认证。关于阿里云APP的更多描述可见此文档 API授权。步骤10 对...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
事件总线
创建API 在API网关控制台左侧导航栏选择 API管理-API列表，在界面的右上角单击 创建API。API基本信息 本环节是定义了API基本信息，包括API分组、API名称、安全认证方式、API类型、和描述等。选择刚刚创建的分组，写入对应配置，安全认证...
DescribeDeployedApis-查询已发布 API 列表
查询已经发布到某指定环境中的API列表，即查询指定环境中正在运行的API列表。接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK...
产品主页信息
产品OpenAPI主页记录了OpenAPI相关的重点信息。进入产品主页 访问 OpenAPI门户。...上图展示的是 短信服务 SMS（Short Message Service）的云产品主页。页面重点信息 推荐API版本 云产品...API概览 API概览记录当前推荐的API版本的所有API列表。
API列表
以下是物联网边缘计算API列表。实例管理API API 描述 CreateEdgeInstance 创建边缘实例。DeleteEdgeInstance 删除边缘实例。UpdateEdgeInstance 更新边缘实例。GetEdgeInstance 获取边缘实例详情。QueryEdgeInstance 查询当前账号下的所有...
使用后端服务提高管理效率
创建并定义API 在左侧导航栏选择API列表，在API列表页，单击右上角创建API进入API创建页面；配置API基本信息：本环节是定义了API基本信息，包括API分组、API名称、安全认证方式、API类型、和描述等。选择您的分组，并写入对应配置，单击下...
创建及管理API标签
查看API标签 在 服务开发 页面的API列表中，双击相应的API名称。单击页面右侧的 属性。在 标签 区域，查看当前API的标签。说明 您也可以在此处对当前API进行新建、添加和删除标签等操作。如果当前API已被发布，您还可以通过下述操作，查看...
管控类API概览
管控类API列表 API 描述 CreateHiTSDBInstance 创建实例。DeleteHiTSDBInstance 删除实例。ModifyHiTSDBInstanceClass TSDB实例变配，仅支持共享实例之间的变配扩容操作。DescribeRegions 部署地域列表。DescribeHiTSDBInstanceList 查询...
DATASOURCE:ApiGateway:Apis
DATASOURCE:ApiGateway:Apis类型用于查询API网关的API列表。语法 {"Type":"DATASOURCE:ApiGateway:Apis","Properties":{"EnableTagAuth":Boolean,"ApiName":String,"Visibility":String,"ApiId":String,"CatalogId":String,"GroupId":...
API 版本管理
API 只有在发布后才能被订阅方使用...您可以通过以下任一方法下线 API 当前版本：在 API 列表中选择要下线的 API，单击 下线>确认。在 API 详情页面，单击右上角的 下线 按钮。在 API 详情>版本管理 页签中，单击 线上版本 右侧的 下线 按钮。
DescribeAuthorizedApis-查询已授权的API列表
查询指定 APP 已授权的API列表，即指定 APP 的API列表。接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以...
- 产品推荐
- 这些文档可能帮助您