简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
CMN操作审计日志说明
ApiCall ListOrderSteps 查询工单步骤列表 ApiCall ListPhysicalSpaces 查询物理空间列表 ApiCall ListPortCollections 查询端口集列表 ApiCall ListScripts 查询脚本列表 ApiCall ListScriptVersions 查询脚本历史版本列表 ApiCall ...
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列表
服务端API列表 API 描述 Verify 服务端认证接口。VerifyAndEncrypt 服务端认证并加密接口。GetServerRandom 获取服务端随机数接口。GetServerAuthCodeAndEncryptData 获取服务端认证码接口。OtpGetId2 ID²动态下发接口。
管控类API概览
管控类API列表 API 描述 CreateHiTSDBInstance 创建实例。DeleteHiTSDBInstance 删除实例。ModifyHiTSDBInstanceClass TSDB实例变配，仅支持共享实例之间的变配扩容操作。DescribeRegions 部署地域列表。DescribeHiTSDBInstanceList 查询...
RemoveVpcAccess-撤销 VPC 授权
ApiId string API Id 551877242a4b4f3a84a56b7c3570e4a7 StageId string 环境 ID d1e1ee28f9fb4b729db0ee8ca76ff0a5 GroupId string API 分组 ID 78d54ac4424d4b1792e33ca35637e8e4 示例 正常返回示例 JSON 格式 {"RequestId":"CEF72CEB-54...
API概览
全局流量管理GTM提供以下相关API接口。地址池 API 描述 AddDnsGtmAddressPool-新增地址池 调用AddDnsGtmAddressPool新增地址池。...获取日志列表 API 描述 DescribeDnsGtmLogs-获取GTM操作日志列表 调用DescribeDnsGtmLogs获取日志列表。
API网关的审计事件
GetApiMethodsForConsole 获取同一接口下，不同方法列表。GetCustomizedInfo 获取自定义信息。GetCustomizedInfoForConsole 查询用户自定义的API内容。ImportSwagger 通过Swagger创建API。IsIncludedByUserWhitelist 检查用户是否在白名单...
CORS 配置
data ARRAY[ApiInfoVO]-data 根据 CORS ID 查询 API 分页列表 sofa.apigateway.cors.api.list 用于查询指定 ID 的 CORS 绑定的 API 分页列表。请求参数 名称 类型 是否必填 示例 描述 cors_id STRING 否 cors_id1 cors标识 param Api...
查看及管理API
查看及管理API列表 API创建完成后，您可在API列表执行发布、版本管理、删除等操作。区域 描述 ① 筛选及搜索区 您可根据API的名称或ID进行搜索，也可根据API类型、API分组进行筛选。② 列表区 为您展示API名称、API_ID、API类型、API分组、...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
添加API标签
为API添加标签，便于按照标签筛选或标记API。本文介绍如何批量添加API标签。前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 操作步骤 登录企业数据智能平台。在页面左上角，...
获取API调用信息
在API列表，API维度 页签下，单击目标 API名称，进入详情页。在基本信息区域，获得目标API的 所属应用 和 调用地址。在页面右上角，单击 图标，选择 系统设置>应用管理。应用列表中，选择目标API的所属应用，获取 应用code，单击操作列中的...
管理外部授权 API
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
添加API标签
前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 使用向导模式创建三方API 使用批量方式创建三方API 创建数据上报API 操作步骤 登录 数据资源平台控制台。在页面左上角，单击 ...
导入导出 API
批量导出 API 在 API 发布>API 管理 页面，在 API 列表左侧勾选需要导出的 API。单击 API 列表右下角的 批量导出 按钮，即可将选择的 API 转换为 JSON 文件保存至本地。批量导入 API 在 API 发布>API 管理 页面，单击 API 列表右上方的 ...
使用 RAM 管理 API
acs:apigateway:$regionid:$accountid:apigroup/*CreateApi 创建API acs:apigateway:$regionid:$accountid:apigroup/$groupId DeployApi 发布API acs:apigateway:$regionid:$accountid:apigroup/$groupId AbolishApi 下线API acs:api...
DescribeApisByBackend-根据后端查询 API 列表
1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...
管理授权对象
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的筛选按钮。在打开的筛选框中，选择...
API概览
微服务列表 API 描述 ListConsumedServices 调用 ListConsumedServices 接口获取订阅的微服务列表。ListPublishedServices 调用 ListPublishedServices 接口获取发布的微服务列表。ListAppServicesPage 调用 ListAppServicesPage 接口获取...
管理路由规则
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的筛选按钮。在打开的筛选框中，选择...
管理 CORS 规则
在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 配置信息、版本管理、监控、流量治理、CORS、授权对象、API 调试 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的...
绑定/解绑 API
绑定 API 在 CORS 规则列表页，单击规则右侧 操作 列中的 绑定 API。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API。单击页面底部的 确认，即可完成绑定。说明 一个规则下...
获取服务端信息
为了让客户端与网关建立连接，您必须在 API 网关控制台上获取以下信息：应用信息 应用标识 APPID 应用验证密钥 API 信息 API 域名地址 API 系统集群密钥 API 请求路径/接口/方法 应用信息 应用标识 APPID 在网关中，应用在环境中的唯一标识...
账单域API使用手册
SubscribeBillToOSS 详单订阅服务 UnsubscribeBillToOSS 取消详单订阅服务 QueryRelationList 查询企业财务关系列表 API选择方案 选择账单域API时，您可以结合需要查询的数据，对比每个API的入参、出参，做出最优的API接口决策。...
DATASOURCE:ApiGateway:Apis
Apis：API的详情列表。属性名称 类型 描述 约束 ApiIds List API编号列表。无 Apis List API的详情列表。无 Visibility String 可见性。取值：PUBLIC：公开。PRIVATE：私有。ApiId String API编号。无 ModifiedTime String 修改时间。...
版本管理
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...
DescribeDeployedApis-查询已发布 API 列表
查询已经发布到某指定环境中的API列表，即查询指定环境中正在运行的API列表。接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK...
绑定/解绑 API
在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API。单击页面底部的 确认，即可完成绑定。解绑 API 在 授权管理 页面，找到目标应用，单击其名称进入该授权应用详情页。解除 ...
API列表
API 描述 GetUserLicense 获取用户合约信息 ListFreqBandPlanGroups 获取频谱计划组支持列表 GetFreqBandPlanGroup 获取频谱计划组信息 网关管理相关API API 描述 CreateGateway 新增网关 DeleteGateway 删除网关 UpdateGateway 更新网关...
查看API操作历史
操作步骤 登录API网关控制台。在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击 管理 进入API详情页。在API详情页的左侧栏点击 操作历史。目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、...
管理 API 渠道
在 API 列表中，找到要查看的 API，单击 操作 列下的 查看 菜单，查看该 API 详情，包括 API 标识、API 名称、内容形式和创建时间。编辑 API 渠道 在 API 列表中，找到要编辑的 API，单击 操作 列下的 编辑 菜单，编辑 API 信息。重要 API ...
SDK 概述
本文介绍了云效代码管理 Codeup 提供的 SDK 信息。SDK 简介 云效代码管理 Codeup SDK 封装了 2020-04-14 版本API，以访问密钥（AccessKey）识别调用者身份，提供自动签名等功能，方便您通过API创建...OpenAPI 列表：OpenAPI 调试：SDK 代码：
应用管理
apiId":"h4ZWfWe9anCJn4Tye3tPMiGJZJ2PeGWq","apiStatus":"CLOSED","workspaceId":"antdemo"}]},"result_code":"OK"} 通过 APP ID 查询 API 分页列表 sofa.apigateway.app.api.list 用于查询指定 APPID 的应用所订阅的 API 分页列表。...
使用后端服务提高管理效率
创建并定义API 在左侧导航栏选择API列表，在API列表页，单击右上角创建API进入API创建页面；配置API基本信息：本环节是定义了API基本信息，包括API分组、API名称、安全认证方式、API类型、和描述等。选择您的分组，并写入对应配置，单击下...
授权管理
API授权：2.1 登录 API网关控制台，在左侧栏选择 开放API —— API列表，单击API后的 更多，选择 授权。2.2 选择要授权的环境，和要授权的应用。左侧为我的应用，此时直接单击搜索，会自动加载本账号下的APP。如果要给其他账号下APP授权，...
批量操作API
2、在API网关的控制台单击左侧栏的 API管理，单击进入 API列表。3、勾选需要批量操作的API，不支持隔页勾选。目前支持的批量操作包含导出swagger、API授权、发布、下线、删除、标签、批量修改API基础配置。重要 批量操作一定要仔细核对选中...
- 产品推荐
- 这些文档可能帮助您