API网关_API网关文档介绍内容-天翼云

云原生网关
认证鉴权网关需要对请求的身份进行校验,当前云原生网关支持jwt、oidc及通过扩展插件的方式实现对请求的身份认证和鉴权。

来自：
帮助文档
微服务引擎
产品简介
名词解释
云原生网关
API审计
本章节介绍API审计日志功能概述 API审计日志功能通常用于记录和跟踪用户在操作服务网格控制台时产生的写行为,便于管理者对控制台的行为进行追溯。审计日志内容主要记录了执行时间、操作类型、操作结果状态以及操作人等关键信息。同时,用户可以通过执行时间、操作人以及业务类型等多种条件进行数据筛选和查看。操作在控制台->网格安全中心-> 审计日志菜单下,即可看到相关的日志信息,如下图:

来自：
帮助文档
应用服务网格
用户指南
网格安全中心
API审计
NAT网关概述
VPC内的实例出方向访问通过SANT规则控制,入方向访问通过DNAT规则控制,一个NAT网关可以创建多个SNAT和DNAT规则。产品优势避免业务公网暴露 VPC下的资源实例如果需要访问公网,通过NAT网关,实例无需单独绑定公网IP即可访问公网,从而避免将业务直接暴露在公网,从而实现安全防护作用。降低成本通过NAT网关,VPC下的资源实例可以共享弹性公网IP和带宽实例,无需单独为每个资源实例分配弹性公网IP和带宽实例,可以有效降低成本。

来自：
帮助文档
智能边缘云
用户指南
边缘网络
NAT网关
NAT网关概述
绑定NAT网关
本文介绍如何将弹性IP EIP绑定到NAT网关上。前提条件已经创建了NAT网关,且NAT网关的地域必须和EIP的地域相同。操作步骤登录网络控制台。单击控制中心左上角的,选择地域。在目标EIP的操作列,单击“绑定”。在绑定弹性IP页面,选择要绑定的NAT网关实例。并单击确定即可完成绑定。

来自：
帮助文档
弹性IP
用户指南
绑定与解绑云资源
绑定NAT网关
用户网关查询
查询已创建的VPN用户网关。接口功能介绍查询已创建的VPN用户网关接口约束支持主备模式资源池。

来自：
帮助文档
VPN连接
API参考
API
主备模式资源池用户网关功能
用户网关查询
用户网关修改
修改已创建的VPN用户网关(目前只能修改网关名字)。接口功能介绍修改已创建的VPN用户网关(目前只能修改网关名字)。

来自：
帮助文档
VPN连接
API参考
API
主备模式资源池用户网关功能
用户网关修改
VPN网关退订
支持退订一个包周期计费/按需的VPN网关。退订后,将退还对应部分VPN网关费用。接口功能介绍支持退订一个包周期计费/按需的VPN网关。退订后,将退还对应部分VPN网关费用。接口约束支持集群模式资源池,并且当前VPN网关没有绑定用户网关和VPN连接。

来自：
帮助文档
VPN连接
API参考
API
集群模式资源池VPN网关功能
VPN网关退订
VPN网关退订
支持退订一个包周期计费/按需的VPN网关。接口功能介绍支持退订一个包周期计费/按需的VPN网关。退订后,将退还对应部分VPN网关费用。接口约束支持主备模式资源池,并且当前VPN网关没有绑定用户网关和VPN连接。

来自：
帮助文档
VPN连接
API参考
API
主备模式资源池VPN网关功能
VPN网关退订
VPN网关修改
修改已创建的VPN网关。接口功能介绍修改已创建的VPN网关。接口约束支持主备模式资源池,并且目前只支持修改名字,带宽和连接数修改请走VPN网关升配接口。

来自：
帮助文档
VPN连接
API参考
API
主备模式资源池VPN网关功能
VPN网关修改
查看API列表
选择“所有防护对象”,页面右侧展示所有的API资产。选择单个域名站点,页面右侧展示选中的域名站点API资产。API列表页面上方展示了所选防护对象的API资产统计信息。API数:统计已识别的API资产数量。今日新增:统计自然时间今日新增的API数量。活跃API:统计活跃API数量。失活API:统计失活API数量。搜索目标API资产:可通过最近活跃时间、请求方法、生命周期、来源、业务用途、API路径进行搜索。

来自：
帮助文档
Web应用防火墙（原生版）
用户指南
API安全
API管理
查看API列表
用户网关创建
创建VPN用户网关。接口功能介绍创建VPN用户网关。

来自：
帮助文档
VPN连接
API参考
API
主备模式资源池用户网关功能
用户网关创建
API自动发现
本节介绍如何配置API自动发现任务,并将发现的API资产添加到API资产列表中。 API自动发现主要用于帮助用户自动或半自动发现API资产。当API资产规模较小时(不超过100条),可选择开启“确认为API资产”,自动将发现的API确认为API资产。当API资产规模校大时(超过100条),API自动发现任务可发现API资产,用户需进行人工识别和确认后,添加为API资产。前提条件已开通Web应用防火墙(原生版)实例企业版或旗舰版。已完成防护域名接入,并正常防护。

来自：
帮助文档
Web应用防火墙（原生版）
用户指南
API安全
API管理
API自动发现
下线/删除API
本章节主要介绍下线/删除API。操作场景已发布的API因为其他原因需要停止对外提供服务,可以将API从相关环境中下线,相关操作请参见下线API。下线后的API如果要继续使用,需要重新进行发布操作,但需注意下线API不会保留原有的授权信息。下线后的API如果确认不再提供服务,可以将API删除,相关操作请参见删除API。说明下线API不会保留原有的授权信息。下线将导致此API在指定的时间无法被访问,请确保已经告知使用此API的用户。

来自：
帮助文档
数据治理中心 DataArts Studio
用户指南
数据服务
开发API
管理API
下线/删除API
VPN网关续订
支持VPN网关包周期计费的订购。接口功能介绍支持VPN网关包周期计费的续订。接口约束支持集群模式资源池,并且用户VPN网关非按需订单,用户配额未满;用户账户余额充足,该接口无法使用优惠券支付,若余额不足会创建一个待支付订单。

来自：
帮助文档
VPN连接
API参考
API
集群模式资源池VPN网关功能
VPN网关续订
API资产列表
本文介绍了边缘安全加速平台API防护模块下API资产列表的使用方法。功能介绍 API资产管理列表展示了客户粒度,即所有接入域名下的API资产。用户可在API资产列表中进行查询、新增、删除、编辑等操作。 API资产定义边缘安全加速平台对于API资产的定义由三部分组成:域名、URI、Method。

来自：
帮助文档
边缘安全加速平台
安全与加速
安全
API安全
资产管理
API资产列表
停用/恢复API
本章节主要介绍停用/恢复API。已发布的API因为其他原因(如需要编辑API等)需要暂停对外提供服务,可以暂时将API从相关环境中停用。停用后您可以通过恢复API,使该API继续对外提供服务。说明停用API会保留原有的授权信息,在停用期间您可以对API进行编辑、调试等操作。停用API将导致此API在指定的时间无法被访问,请确保已经告知使用此API的用户。前提条件已创建API。 API已发布到该环境。

来自：
帮助文档
数据治理中心 DataArts Studio
用户指南
数据服务
开发API
管理API
停用/恢复API
管理API资产
本节介绍如何管理通过手动添加或自动发现的API资产。 API列表页面展示通过手动添加的API资产,和自动发现任务发现并已确认为API的资产,在该页面可以对这些API资产进行管理,包括编辑、删除操作。编辑API资产登录天翼云控制中心。单击页面顶部的区域选择框,选择区域。在产品服务列表页,选择“安全 > Web应用防火墙(原生版)”。在左侧导航栏,选择“API安全 > API管理”,进入API管理页面。在“API列表”中,单击操作列的“编辑”。

来自：
帮助文档
Web应用防火墙（原生版）
用户指南
API安全
API管理
管理API资产
API自发现
结束/放弃API自发现任务当API自发现任务下发之后,自发现结束时间未到达之前,用户可手动结束/放弃自发现任务。说明结束表示停止自发现任务,同时基于当前数据生成API自发现结果。放弃表示停止自发现任务,且不生成API自发现结果。 API待确认列表在【API待确认列表】中,您可以查看API任务的发现结果,并且需要对API自发现的结果进行标记,如确认为API,可标记为API。标记后的API接口,可以添加至【API资产】,添加后将不会再展示在【API待确认列表】中。

来自：
帮助文档
边缘安全加速平台
安全与加速
安全
API安全
资产管理
API自发现
设置API可见
3.进入“开发API > API目录”或“开发API > API管理”页面,在API列表操作列中,选择“编辑”。注意,仅当API处于已创建、已驳回、已下线、已停用的情况下才能进行API修改。 4.在基本配置处,修改“服务目录可见性”参数的取值,可以选择为“当前工作空间可见”、“当前项目可见”或“当前租户可见”。然后保存修改。 5.修改完成后,重新恢复或发布API,即可修改此API在服务目录中的可见范围。

来自：
帮助文档
数据治理中心 DataArts Studio
用户指南
数据服务
开发API
管理API
设置API可见
VPN网关续订
支持VPN网关包周期计费的续订。接口功能介绍支持VPN网关包周期计费的续订接口约束支持主备模式资源池,并且用户VPN网关非按需订单,用户配额未满;用户账户余额充足,该接口无法使用优惠券支付,若余额不足会创建一个待支付订单。

来自：
帮助文档
VPN连接
API参考
API
主备模式资源池VPN网关功能
VPN网关续订
VPN网关订购
多AZ资源池VPN网关订购。接口功能介绍多AZ资源池VPN网关订购接口约束支持集群模式资源池。 URI POST /v4/vpn/vpn-gateway/new 路径参数无 Query参数无请求参数请求头header参数无请求体body参数参数是否必填参数类型说明示例下级对象 vpnName 是 String VPN网关名字 vpc-9ce5 clientToken 否 String 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一。

来自：
帮助文档
VPN连接
API参考
API
集群模式资源池VPN网关功能
VPN网关订购
云原生网关
本章节介绍云原生网关CGW子产品的产品规格云原生网关版本&规格版本节点规格节点数量基础版 2C4G/4C8G/8C16G/16C32G 1 集群版 2C4G/4C8G/8C16G/16C32G 2 ~ 9 x86架构云原生网关性能数据主机类型版本安全水位线QPS(30% CPU,应答包1K,HTTP请求) X86-通用型基础版2C4G 2500 X86-通用型基础版4C8G 5000 X86-通用型基础版8C16G 9000

来自：
帮助文档
微服务引擎
产品简介
产品规格
云原生网关
API调用指南
3.2对应接口URL 以图片鉴黄为例,选择【API参考-API-图片鉴黄】,右侧即可查看URL。 4.查看接口文档以图片鉴黄为例:点击【API参考-API】,选择【图片鉴黄】,右侧即可查看、请求方法、接口要求、请求URL、请求参数、返回值说明、状态码等信息。 5.构造请求点击【API参考-如何调用API】,选择【构造请求】。 6.认证鉴权在帮助中心菜单中点击【认证鉴权】,可根据右侧步骤完成认证鉴权。

来自：
帮助文档
内容审核
用户指南
API调用指南
API调用指南
7.调试接口并查看状态码调试后,如果API返回状态码为200,表示请求成功,API调试结束。

来自：
帮助文档
安全生产
用户指南
API调用指南
API调用指南
3.2对应接口URI 以文本纠错为例,选择【API参考-API-文本纠错】,右侧即可查看URI。 4.查看接口文档以文本纠错为例,点击【API参考-API】,选择【文本纠错】,右侧即可查看、请求方法、接口要求、请求URI、请求参数、返回值说明、状态码等信息。 5.构造请求点击【API参考-如何调用API】,选择【构造请求】。 6.认证鉴权在帮助中心菜单中点击【认证鉴权】,可根据右侧步骤完成认证鉴权。

来自：
帮助文档
自然语言处理
用户指南
API调用指南
API调用指南
以通用型OCR为例,选择【API参考-API-通用型OCR】,右侧即可查看URI。 4.查看接口文档以通用型OCR为例:点击【API参考-API】,选择【通用型OCR】,右侧即可查看、请求方法、接口要求、请求URI、请求参数、返回值说明、状态码等信息。 5.构造请求点击【API参考-如何调用API】,选择【构造请求】。 6.认证鉴权在帮助中心菜单中点击【认证鉴权】,可根据右侧步骤完成认证鉴权。

来自：
帮助文档
印刷文字识别
用户指南
API调用指南
API调用指南
3.2对应接口URI 以人脸检测为例,选择【API参考-API-人脸检测】,右侧即可查看URI。 4.查看接口文档以人脸检测为例:点击【API参考】-【API】,选择【人脸检测】,右侧即可查看、请求方法、接口要求、请求URL、请求参数、返回值说明、状态码等信息。 5.构造请求点击【API参考-如何调用API】,选择【构造请求】。 6.认证鉴权在帮助中心菜单中点击【认证鉴权】,可根据右侧步骤完成认证鉴权。

来自：
帮助文档
人脸识别
用户指南
API调用指南
VPN网关订购
支持按需/包年包月订购VPN网关。接口功能介绍支持按需/包年包月订购VPN网关。接口约束支持主备模式资源池,并且用户VPN网关配额未满;用户账户余额充足,该接口无法使用优惠券支付,若余额不足会创建一个待支付订单。

来自：
帮助文档
VPN连接
API参考
API
主备模式资源池VPN网关功能
VPN网关订购
用户网关删除
删除已创建的用户网关。接口功能介绍删除已创建的用户网关接口约束支持主备模式资源池。

来自：
帮助文档
VPN连接
API参考
API
主备模式资源池用户网关功能
用户网关删除
创建混合存储网关
2.单击“存储混合存储网关”进入混合存储网关控制台,点击“创建混合存储网关”,示图如下: 3.在创建混合存储网关页面,选择如下网关配置参数,配置完成后单击“下一步:确认配置”,配置参数如下表: 参数解释网关名称输入网关的名称。说明网关名称的字符限制:必须大小写字母或中文开头,支持中文,英文大小写,数字,“.”,“_”或“-”;长度不超过50个字符。网关位置网关目前仅支持部署在【天翼云】,用户通过天翼云混合存储网关控制台对网关进行管理。网关类型目前仅支持选择【文件网关】。

来自：
帮助文档
混合存储网关
快速入门
通过控制台使用混合存储网关
创建混合存储网关
API&kubectl
本文为您介绍Serverless集群的API和kubectl如何连接等问题。用户访问集群API Server的方式有哪些? 集群API方式:集群API需要使用证书认证访问,在云容器引擎控制台集群信息 > 连接信息获取kubeconfig文件,通过kubectl直接连接集群API Server。

来自：
帮助文档
Serverless容器引擎
常见问题
API&kubectl
API概览
本节主要介绍各个管理模块的API概览。智能视图服务产品API概览请参考API概览。设备管理功能名称英文名称描述创建设备 createDevice 本接口用于创建设备。删除设备 deleteDevice 本接口用于删除设备。修改设备 modifyDevice 本接口用于修改设备信息。查询设备 describeDevice 本接口用于通过设备ID查询设备信息。查询设备列表 describeDevices 本接口用于查询设备列表。

来自：
帮助文档
智能视图服务
API参考
API概览

天翼云最新活动

618智算钜惠季

爆款云主机2核4G限时秒杀，88元/年起！

免费体验DeepSeek，上天翼云息壤

新老用户均可免费体验2500万Tokens，限时两周

云上钜惠

爆款云主机全场特惠，更有万元锦鲤券等你来领！

算力套餐

让算力触手可及

天翼云脑AOne

连接、保护、办公，All-in-One！

中小企业应用上云专场

产品组合下单即享折上9折起，助力企业快速上云

息壤高校钜惠活动

天翼云息壤杯高校AI大赛，数款产品享受线上订购超值特惠

天翼云电脑专场

移动办公新选择，爆款4核8G畅享1年3.5折起，快来抢购！

智算服务

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

天翼云最新活动

产品推荐

物理机

GPU云主机

多活容灾服务

一体化计算加速平台·异构计算

一站式智算服务平台

智算一体机

人脸属性识别

人脸活体检测

人脸比对

推荐文档

升级

管理只读实例

Microsoft SQL Server