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

为简易认证添加AppCode
操作场景简易认证指调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。说明为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。每个应用最多可创建5个AppCode。

来自：
帮助文档
API网关
调用API网关
应用管理
为简易认证添加AppCode
添加特殊凭据或租户
添加特殊凭据步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“策略管理”页面,单击已创建的策略,进入流控详情。步骤 5 单击“添加特殊凭据”,弹出“添加特殊凭据”对话框。步骤 6 通过以下两种方式,添加特殊凭据。添加已有凭据:单击“已有凭据”,选择已有凭据,输入阈值。添加其他凭据:单击“其他”,输入其他用户的凭据ID和阈值。

来自：
帮助文档
API网关
开放API网关
流量控制
添加特殊凭据或租户
用户使用手册
天翼云API网关用户指南.pdf

来自：
帮助文档
API网关
文档下载
用户使用手册
购买专享版实例
步骤 3 单击管理控制台左上角,然后单击“API网关 APIG”。步骤 4 在左侧导航栏单击“专享版”。步骤 5 单击“购买专享版实例”,进入实例购买的配置页面。表 API网关专享版实例参数说明参数项说明区域指APIG专享版实例部署的区域,建议和您其他的业务部署在相同区域,这样不同的业务可以在VPC内以子网方式通信,节省公网带宽成本,降低网络延时。可用区指同一区域内电力、网络等资源物理隔离的地理区域,一般为互相独立的机房。

来自：
帮助文档
API网关
快速入门
购买专享版实例
资源规划
资源和成本规划资源数量云容器引擎CCE1API网关专享版实例1

来自：
帮助文档
API网关
最佳实践
APIG开放CCE云容器应用
资源规划
数据治理中心与其他服务的关系
API网关服务 DataArts Studio通过API网关服务(API Gateway,简称APIG)对外开放各组件的API接口。数据湖探索服务 DataArts Studio支持将数据湖探索服务(Data Lake Insight,简称DLI)作为数据湖底座,进行数据集成、开发、治理与开放。 MapReduce服务 DataArts Studio支持将MapReduce服务(简称MRS)作为数据湖底座,进行数据集成、开发与治理。

来自：
帮助文档
数据治理中心 DataArts Studio
产品简介
数据治理中心与其他服务的关系
配置模式生成API
3.进入“API管理”页面,单击“新建”,填写API基本信息。详见下表: API基本信息配置说明 API名称支持中文、英文、数字、下划线,且只能以英文或中文开头,3-64个字符。 API目录一个特定功能或场景的API集合,类似文件夹,是数据服务中API的最小组织单元,也是API网关中的最小管理单元。您可单击“新建”进行新建,也可选择新建API目录已创建的API分组。请求Path API访问路径,例如:/v2/{project_id}/streams。

来自：
帮助文档
数据治理中心 DataArts Studio
用户指南
数据服务
开发API
创建API
配置模式生成API
绑定域名
概述 API分组支持绑定域名。绑定域名后,可通过该域名访问分组下的API,但前提是该域名需指向该云原生网关实例。操作步骤登录微服务引擎MSE云原生网关管理控制台,选择资源池。在左侧导航栏,选择云原生网关 > 网关列表,进入对应网关实例的控制台。在左侧导航栏,选择API托管 > 分组管理。绑定域名点击对应分组右侧省略号中的绑定域名,即可进入绑定域名弹窗。也可以在分组详情页中,点击域名模块的修改按钮进入。

来自：
帮助文档
微服务引擎
用户指南
云原生网关
API托管
分组管理
绑定域名
删除环境
操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“环境变量”区域,选择环境。步骤 5 在待删除的环境所在行,单击“删除”,弹出“删除环境”对话框。说明仅在环境未被API发布时,支持删除。步骤 6 单击“确定”,完成环境管理信息。

来自：
帮助文档
API网关
开放API网关
环境管理
删除环境
重置Secret
重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。前提条件已创建凭据。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > 凭据管理”。步骤 4 单击凭据名称 ,进入凭据详情页面。步骤 5 单击“重置Secret”。步骤 6 在弹窗中单击“确定”。

来自：
帮助文档
API网关
调用API网关
应用管理
重置Secret
删除分组
操作场景 API分组在创建后,如需对创建的数据进行删除,可以删除此分组。前提条件已创建分组。操作步骤步骤 1 登录管理控制台,进入API网关控制台界面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航选择“API管理 > API分组"。步骤 4 通过以下任意一种方式,进入“删除分组”对话框。在待删除的API分组所在行,单击“更多 > 删除”。单击“分组名称”,进入分组详情页面,在右上角单击“删除”。

来自：
帮助文档
API网关
开放API网关
API分组管理
删除分组
删除凭据
操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > 凭据管理”,进入凭据管理信息页面。步骤 4 通过以下任意一种方式,进入“删除凭据”对话框。在待删除的凭据所在行,单击“删除”。单击“凭据名称”,进入凭据详情页面,在右上角单击“删除”。说明仅在应用未绑定任何API时,支持删除,否则请先解绑API。步骤 5 单击“确定”,完成凭据的删除。

来自：
帮助文档
API网关
调用API网关
应用管理
删除凭据
删除负载通道
说明如果API已经使用VPC通道,且API已发布到环境,此时无法删除此VPC通道。前提条件已创建VPC通道。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 单击“负载通道”页签,进入到负载通道列表页面。步骤 5 通过以下任意一种方法,弹出“删除负载通道”对话框。在待删除的负载通道所在行,单击“删除”。单击“负载通道名称”,进入负载通道详情页面。

来自：
帮助文档
API网关
开放API网关
负载通道
删除负载通道
删除签名密钥
操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在策略管理页面,选择“签名密钥”,进入密钥策略列表。步骤 5 通过以下任意一种方法,弹出“删除密钥策略”对话框。在待删除的密钥策略所在行,单击“删除”。单击“密钥策略名称”,进入签名密钥策略详情页面。在右上角单击“删除”。说明仅在签名密钥未绑定任何API时,支持删除,否则请先解绑API。

来自：
帮助文档
API网关
开放API网关
签名密钥
删除签名密钥
删除自定义认证
已在API中使用的自定义认证无法被删除。前提条件已创建自定义认证。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“自定义认证”页签,在待删除的自定义认证所在行,单击“删除”,弹出“删除自定义认证”对话框。步骤 5 单击“确定”。

来自：
帮助文档
API网关
开放API网关
自定义认证
删除自定义认证
热门咨询
API注册不使用VPC通道时,后端服务地址可以是什么? 后端服务地址是否一定要配置为ECS的地址? 后端服务是否支持绑定私网ELB地址? 后端服务地址可以填写私有地址(子网IP)吗? API网关可以绑定内网域名吗? API调用 API调用失败的可能原因有哪些? API调用返回错误码如何处理? "API Not Found"如何解决? No backend available,怎么解决? 后端服务调用失败或超时原因分析 API认证鉴权是否支持HTTPS的双向认证?

来自：
帮助文档
API网关
常见问题
热门咨询
删除流控策略
操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“策略管理”页面,通过以下任意一种方式,弹出“删除流控策略”对话框。在待删除的流控策略所在行,单击“删除”。单击待删除的策略名称,进入流量控制详情页面,在右上角单击“删除”。说明仅在流控策略未绑定任何API时,支持删除,否则请先解绑API。在流量控制详情页面,单击待解绑API所在行的“解除”。

来自：
帮助文档
API网关
开放API网关
流量控制
删除流控策略
删除访问控制策略
操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 选择“ 访问控制”,进入访问控制策略列表页面。步骤 5 通过以下任意一种方式,弹出“删除访问控制策略”对话框。在待删除的访问控制策略所在行,单击“删除”。单击待删除的访问控制策略名称,进入访问控制详情页面,在右上角单击“删除”。说明仅在访问控制策略未绑定任何API时,支持删除,否则请先解绑API。

来自：
帮助文档
API网关
开放API网关
访问控制
删除访问控制策略
创建访问控制策略
操作场景访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和帐户,您可以通过设置IP地址或帐户的黑白名单来拒绝/允许某个IP地址或帐户访问API。访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的API生效。说明每个用户最多可以创建100个访问控制策略。同一个环境中一个API只能被一个访问控制策略绑定,一个访问控制策略可以绑定多个API。创建访问控制策略步骤 1 进入API网关控制台页面。

来自：
帮助文档
API网关
开放API网关
访问控制
创建访问控制策略
创建HTTP函数
配置触发器信息,此处以创建“API网关服务(APIG专享版)”触发器为例。说明示例中“安全认证”暂时选择“None”,用户在配置时应根据实际情况选择。App:采用 Appkey&Appsecret 认证,安全级别高,推荐使用。IAM:IAM 认证,只允许IAM用户能访问,安全级别中等。None:无认证模式,所有用户均可访问。配置完成后,单击“确定”。API触发器创建完成后,会在API网关生成API“API_test_http”。

来自：
帮助文档
函数工作流
用户指南
构建函数
使用空白模板创建函数
创建HTTP函数
消费者（应用）管理
在路由的视角下操作步骤进入微服务引擎MSE控制台; 在顶部菜单栏选择资源池; 单击左侧导航栏云原生网关 > 网关列表 ; 选择实例->实例详情>路由配置,,选择目标路由; 路由详情>授权信息,选中需要解除授权的应用 > 批量接触授权 ; 在API的视角下操作步骤进入微服务引擎MSE控制台; 在顶部菜单栏选择资源池; 单击左侧导航栏云原生网关 > 网关列表 ; 选择实例->实例详情 > API托管 > API列表,选择目标API; API详情>授权信息,选中需要解除授权的应用 >批量接触授权

来自：
帮助文档
微服务引擎
用户指南
云原生网关
API托管
消费者管理
消费者（应用）管理
普通集成
、API网关说明:具体支持的服务和API请参考天翼云OpenAPI文档。

来自：
帮助文档
函数计算
用户指南
云工作流
工作流集成
普通集成
创建环境和环境变量
图环境变量示意图操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“环境变量”区域,选择环境。如果未创建环境,可单击“创建环境”创建。步骤 5 单击“添加环境变量”,填写变量信息。注意在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。表新增变量信息项描述变量名变量的名,称必须与创建API时定义的变量标识完全相同。变量值变量路径。

来自：
帮助文档
API网关
开放API网关
环境管理
创建环境和环境变量
使用方式
API概览 OpenAPI OpenAPI为天翼云提供的统一API网关,目前支持通过OpenAPI访问西藏资源池,如其他区域需通过API访问调用,请联系媒体存储技术团队。 OpenAPI接入,请使用以下终端节点:https://xstore-dsp-xzls1-a.ctapi.ctyun.cn。适用服务区域范围:西藏资源池1区。 API概览

来自：
帮助文档
媒体存储
用户指南
使用方式
资源配置
Hosts配置在迁移开始之前需要在RDA安装机器和源端待迁移主机hosts文件中配置调用接口域名解析到天翼云对应资源池API网关的地址,以便迁移相关的产品服务可以正常通过API接口访问。

来自：
帮助文档
云迁移工具RDA
快速入门
资源配置
支持接入的云服务日志
网关(API Gateway)访问日志apig-access7~180 天

来自：
帮助文档
态势感知（专业版）（新版）
用户指南
日志审计
云服务接入
支持接入的云服务日志
HTTP函数
减少请求处理环节函数可以直接接收并处理HTTP 请求,API 网关不再需要做 json 格式转换,减少请求处理环节,提升 Web 服务性能。编写体验舒适化 HTTP函数的编写体验更贴近编写原生 Web 服务,可以使用 Node.js 原生接口,保证和本地开发服务体验一致。限制 HTTP函数只允许创建APIG共享版、APIG专享版、APIC的触发器类型,其他触发器不支持。同一个函数支持绑定多个API触发器,但所有 API 都必须在一个APIG服务下。

来自：
帮助文档
函数工作流
产品简介
函数类型
HTTP函数
创建自定义认证
使用自定义认证调用API的流程如下图所示: 图使用自定义认证调用API 前提条件已在函数工作流服务中完成函数创建。创建自定义认证步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。步骤 3 在左侧导航栏选择“API管理 > API策略”。步骤 4 在“自定义认证”页面,单击“创建自定义认证”。配置自定义认证参数。表自定义认证参数说明信息项描述认证名称您自定义的认证名称,用于区分不同的自定义认证。

来自：
帮助文档
API网关
开放API网关
自定义认证
创建自定义认证
API说明
本文主要介绍混合存储网关产品的API使用说明。 OpenAPI门户提供了产品的API文档、API调试、SDK中心等。关于用户如何使用混合存储网关产品API的详细介绍,请参见使用API。您可以在OpenAPI门户了解到具体的调用前必知、API概览、如何调用API,以及具体API接口的详细说明。

来自：
帮助文档
混合存储网关
API参考
API说明
绑定域名
当独立域名为泛域名(例如*.aaa.com)时,用户可以通过泛域名的所有子域名(例如default.aaa.com,1.aaa.com)访问...API。前提条件已有独立域名。已将独立域名A记录解析到实例的入口地址上。如果API分组中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前获取SSL证书的内容和密钥,并创建SSL证书。操作步骤步骤 1 进入API网关控制台页面。步骤 2 根据实际业务在左侧导航栏上方选择实例。

来自：
帮助文档
API网关
用户指南
API管理
绑定域名
API
API名称填写API路由名称,不允许重复。描述填写API路由的描述。发布发布的API允许访问。协议HTTP:允许客户端使用 HTTP 协议访问网关,系统默认访问使用 HTTP 协议,若取消勾选则只允许 HTTPS。HTTPS:允许客户端配置证书后使用 HTTPS 请求访问网关。API版本填写API路由版本,管理不同版本的API,使得新旧版本可以并行存在且互不影响,方便客户端平滑升级。

来自：
帮助文档
数据安全专区
用户指南
API安全网关操作指导
资源
API
术语解释
API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关开放给用户调用。API包括基本信息、前后端的请求路径和参数以及请求相关协议。安全风险安全风险是对资产安全状况的综合评估,反映了一段时间内资产遭受的安全风险。安全风险通常体现为一个量化的数值,便于用户理解目前资产的安全状况,数值大小并不代表资产的绝对安全或危险,仅作为资产遭受攻击严重程度的参考。

来自：
帮助文档
数据安全中心
产品介绍
术语解释

天翼云最新活动

12.12年度钜惠

爆款云主机2核2G仅需28.8元/年，X实例35.1元/半年起！ 8代机+XSSD新客专享2.5折！

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

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

云上钜惠

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

算力套餐

让算力触手可及

天翼云AI产品特惠

人脸识别+文字识别焕新，新用户免费试用

中小企业服务商合作专区

国家云助力中小企业腾飞，高额上云补贴重磅上线

出海产品促销专区

爆款云主机低至2折，高性价比，不限新老速来抢购！

天翼云电脑专场

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

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

天翼云最新活动

产品推荐

GPU云主机

弹性高性能计算

训推服务

AI Store

算力互联调度平台

模型推理服务

一站式智算服务平台

知识库问答

人脸检测

推荐文档

天翼云最佳实践⑥：Win Server php-asp 环境安装

安全防护

基本概念

全面了解天翼云⑧：NFS安装教程

服务器迁移的功能

创建

产品定义