活动

天翼云最新优惠活动,涵盖免费试用,产品折扣等,助您降本增效!
查看全部活动
热门活动
  • 免费体验DeepSeek,上天翼云息壤 NEW 新老用户均可免费体验2500万Tokens,限时两周
  • 云上钜惠 HOT 爆款云主机全场特惠,更有万元锦鲤券等你来领!
  • 算力套餐 HOT 让算力触手可及
  • 天翼云脑AOne NEW 连接、保护、办公,All-in-One!
  • 一键部署Llama3大模型学习机 0代码一键部署,预装最新主流大模型Llama3与StableDiffusion
  • 中小企业应用上云专场 产品组合下单即享折上9折起,助力企业快速上云
  • 息壤高校钜惠活动 NEW 天翼云息壤杯高校AI大赛,数款产品享受线上订购超值特惠
  • 天翼云电脑专场 HOT 移动办公新选择,爆款4核8G畅享1年3.5折起,快来抢购!
  • 天翼云奖励推广计划 加入成为云推官,推荐新用户注册下单得现金奖励
免费活动
  • 免费试用中心 HOT 多款云产品免费试用,快来开启云上之旅
  • 天翼云用户体验官 NEW 您的洞察,重塑科技边界

智算服务

打造统一的产品能力,实现算网调度、训练推理、技术架构、资源管理一体化智算服务
智算云(DeepSeek专区)
科研助手
  • 算力商城
  • 应用商城
  • 开发机
  • 并行计算
算力互联调度平台
  • 应用市场
  • 算力市场
  • 算力调度推荐
一站式智算服务平台
  • 模型广场
  • 体验中心
  • 服务接入
智算一体机
  • 智算一体机
大模型
  • DeepSeek-R1-昇腾版(671B)
  • DeepSeek-R1-英伟达版(671B)
  • DeepSeek-V3-昇腾版(671B)
  • DeepSeek-R1-Distill-Llama-70B
  • DeepSeek-R1-Distill-Qwen-32B
  • Qwen2-72B-Instruct
  • StableDiffusion-V2.1
  • TeleChat-12B

应用商城

天翼云精选行业优秀合作伙伴及千余款商品,提供一站式云上应用服务
进入甄选商城进入云市场创新解决方案
办公协同
  • WPS云文档
  • 安全邮箱
  • EMM手机管家
  • 智能商业平台
财务管理
  • 工资条
  • 税务风控云
企业应用
  • 翼信息化运维服务
  • 翼视频云归档解决方案
工业能源
  • 智慧工厂_生产流程管理解决方案
  • 智慧工地
建站工具
  • SSL证书
  • 新域名服务
网络工具
  • 翼云加速
灾备迁移
  • 云管家2.0
  • 翼备份
资源管理
  • 全栈混合云敏捷版(软件)
  • 全栈混合云敏捷版(一体机)
行业应用
  • 翼电子教室
  • 翼智慧显示一体化解决方案

合作伙伴

天翼云携手合作伙伴,共创云上生态,合作共赢
天翼云生态合作中心
  • 天翼云生态合作中心
天翼云渠道合作伙伴
  • 天翼云代理渠道合作伙伴
天翼云服务合作伙伴
  • 天翼云集成商交付能力认证
天翼云应用合作伙伴
  • 天翼云云市场合作伙伴
  • 天翼云甄选商城合作伙伴
天翼云技术合作伙伴
  • 天翼云OpenAPI中心
  • 天翼云EasyCoding平台
天翼云培训认证
  • 天翼云学堂
  • 天翼云市场商学院
天翼云合作计划
  • 云汇计划
天翼云东升计划
  • 适配中心
  • 东升计划
  • 适配互认证

开发者

开发者相关功能入口汇聚
技术社区
  • 专栏文章
  • 互动问答
  • 技术视频
资源与工具
  • OpenAPI中心
开放能力
  • EasyCoding敏捷开发平台
培训与认证
  • 天翼云学堂
  • 天翼云认证
魔乐社区
  • 魔乐社区

支持与服务

为您提供全方位支持与服务,全流程技术保障,助您轻松上云,安全无忧
文档与工具
  • 文档中心
  • 新手上云
  • 自助服务
  • OpenAPI中心
定价
  • 价格计算器
  • 定价策略
基础服务
  • 售前咨询
  • 在线支持
  • 在线支持
  • 工单服务
  • 建议与反馈
  • 用户体验官
  • 服务保障
  • 客户公告
  • 会员中心
增值服务
  • 红心服务
  • 首保服务
  • 客户支持计划
  • 专家技术服务
  • 备案管家

了解天翼云

天翼云秉承央企使命,致力于成为数字经济主力军,投身科技强国伟大事业,为用户提供安全、普惠云服务
品牌介绍
  • 关于天翼云
  • 智算云
  • 天翼云4.0
  • 新闻资讯
  • 天翼云APP
基础设施
  • 全球基础设施
  • 信任中心
最佳实践
  • 精选案例
  • 超级探访
  • 云杂志
  • 分析师和白皮书
  • 天翼云·创新直播间
市场活动
  • 2025智能云生态大会
  • 2024智算云生态大会
  • 2023云生态大会
  • 2022云生态大会
  • 天翼云中国行
天翼云
  • 活动
  • 智算服务
  • 产品
  • 解决方案
  • 应用商城
  • 合作伙伴
  • 开发者
  • 支持与服务
  • 了解天翼云
    • 关系数据库SQL Server版
    • 企业主机安全
    • 云防火墙
    • CDN加速
    • 物理机
    • GPU云主机
    • 天翼云电脑(政企版)
    • 天翼云电脑(公众版)
    • 云主机备份
    • 弹性云主机
      搜索发现
      关系数据库SQL Server版企业主机安全云防火墙CDN加速物理机GPU云主机天翼云电脑(政企版)天翼云电脑(公众版)云主机备份弹性云主机
    • 文档
    • 控制中心
    • 备案
    • 管理中心
    • 登录
    • 免费注册

    查看所有产品

    数据治理中心 DataArts Studio

    数据治理中心 DataArts Studio

    目录
      • 产品动态
      • 产品简介
      • 产品定义
      • 产品优势
      • 功能特性
      • 应用场景
      • 术语解释
      • 权限管理
      • 权限列表
      • 约束与限制
      • 数据治理中心DataArts Studio与其他服务的关系
      • 计费说明
      • 资源节点
      • 产品规格
      • 产品价格
      • 计费模式
      • 购买
      • 变更
      • 续订
      • 退订
      • 准备工作
      • 准备工作简介
      • 创建DataArts Studio实例
      • 创建DataArts Studio基础包
      • (可选)创建DataArts Studio增量包
      • 访问DataArts Studio实例控制台
      • 管理工作空间
      • 创建并管理工作空间
      • (可选)修改作业日志存储路径
      • 授权用户使用DataArts Studio
      • 创建IAM用户并授予DataArts Studio权限
      • (可选)自定义工作空间角色
      • 添加工作空间成员和角色
      • (可选)获取认证信息
      • 用户指南
      • 使用DataArts Studio前的准备
      • 管理控制台
      • 创建数据连接
      • 资源迁移
      • 使用教程
      • 新建MRS Hive连接
      • 新建DWS连接
      • 新建MySQL连接
      • DataArts Studio支持的数据源
      • 数据集成
      • 数据集成概述
      • 约束与限制
      • 支持的数据源
      • 管理集群
      • 创建CDM集群
      • 解绑/绑定集群的EIP
      • 重启集群
      • 删除集群
      • 下载集群日志
      • 查看集群基本信息/修改集群配置
      • 监控指标
      • 支持的监控指标
      • 设置告警规则
      • 查看监控指标
      • 管理连接
      • 新建连接
      • 管理驱动
      • 管理Agent
      • 管理集群配置
      • 配置常见关系数据库连接
      • 配置分库连接
      • 配置MySQL数据库连接
      • 配置Oracle数据库连接
      • 配置DLI连接
      • 配置Hive连接
      • 配置HBase连接
      • 配置HDFS连接
      • 配置OBS连接
      • 配置FTP/SFTP连接
      • 配置Redis/DCS连接
      • 配置DDS连接
      • 配置CloudTable连接
      • 配置CloudTable OpenTSDB连接
      • 配置MongoDB连接
      • 配置Cassandra连接
      • 配置Kafka连接
      • 配置DMS Kafka连接
      • 配置Elasticsearch/云搜索服务(CSS)连接
      • 管理作业
      • 新建表/文件迁移作业
      • 新建整库迁移作业
      • 配置作业源端参数
      • 配置OBS源端参数
      • 配置HDFS源端参数
      • 配置HBase/CloudTable源端参数
      • 配置Hive源端参数
      • 配置DLI源端参数
      • 配置FTP/SFTP源端参数
      • 配置HTTP源端参数
      • 配置常见关系数据库源端参数
      • 配置MySQL源端参数
      • 配置Oracle源端参数
      • 配置分库源端参数
      • 配置MongoDB/DDS源端参数
      • 配置Redis源端参数
      • 配置Kafka/DMS Kafka源端参数
      • 配置Elasticsearch或云搜索服务源端参数
      • 配置OpenTSDB源端参数
      • 配置作业目的端参数
      • 配置OBS目的端参数
      • 配置HDFS目的端参数
      • 配置HBase/CloudTable目的端参数
      • 配置Hive目的端参数
      • 配置常见关系数据库目的端参数
      • 配置DWS目的端参数
      • 配置DDS目的端参数
      • 配置DCS目的端参数
      • 配置云搜索服务目的端参数
      • 配置DLI目的端参数
      • 配置OpenTSDB目的端参数
      • 配置定时任务
      • 作业配置管理
      • 管理单个作业
      • 批量管理作业
      • 审计
      • 支持云审计的关键操作
      • 如何查看审计日志
      • 使用教程
      • 创建MRS Hive连接器
      • 创建MySQL连接器
      • MySQL数据迁移到MRS Hive分区表
      • MySQL数据迁移到OBS
      • MySQL数据迁移到DWS
      • MySQL整库迁移到RDS服务
      • Oracle数据迁移到云搜索服务
      • Oracle数据迁移到DWS
      • OBS数据迁移到云搜索服务
      • OBS数据迁移到DLI服务
      • MRS HDFS数据迁移到OBS
      • Elasticsearch整库迁移到云搜索服务
      • DDS数据迁移到DWS
      • 进阶实践
      • 增量迁移原理介绍
      • 文件增量迁移
      • 关系数据库增量迁移
      • 时间宏变量使用解析
      • HBase/CloudTable增量迁移
      • 事务模式迁移
      • 迁移文件时加解密
      • MD5校验文件一致性
      • 字段转换
      • 指定文件名迁移
      • 正则表达式分隔半结构化文本
      • 记录数据迁移入库时间
      • 文件格式介绍
      • 数据架构
      • 数据架构概述
      • 数据架构使用流程
      • 准备工作
      • 添加审核人
      • 管理配置中心
      • 数据调研
      • 流程设计
      • 主题设计
      • 标准设计
      • 新建码表
      • 新建数据标准
      • 模型设计
      • 关系建模
      • 逻辑模型设计
      • 物理模型设计
      • 维度建模
      • 新建维度
      • 管理维度表
      • 新建事实表
      • 指标设计
      • 业务指标
      • 技术指标
      • 新建原子指标
      • 新建衍生指标
      • 新建复合指标
      • 新建时间限定
      • 数据集市建设
      • 新建汇总表
      • 通用操作
      • 逆向数据库(关系建模)
      • 逆向数据库(维度建模)
      • 导入导出表
      • 关联质量规则
      • 查看表
      • 批量修改主题/目录/流程
      • 审核中心
      • 使用教程
      • 数据架构示例
      • 数据开发
      • 数据开发概述
      • 数据管理
      • 数据管理流程
      • 新建数据连接
      • 新建数据库
      • (可选)新建数据库模式
      • 新建数据表
      • 脚本开发
      • 脚本开发流程
      • 新建脚本
      • 开发脚本
      • 开发SQL脚本
      • 开发Shell脚本
      • 开发Python脚本
      • 提交版本并解锁
      • (可选)管理脚本
      • 复制脚本
      • 复制名称与重命名脚本
      • 移动脚本/脚本目录
      • 导出导入脚本
      • 查看脚本引用
      • 删除脚本
      • 迁移脚本责任人
      • 批量解锁
      • 作业开发
      • 作业开发流程
      • 新建作业
      • 开发作业
      • 调度作业
      • 提交版本并解锁
      • (可选)管理作业
      • 复制作业
      • 复制名称和重命名作业
      • 移动作业/作业目录
      • 导出导入作业
      • 删除作业
      • 迁移作业责任人
      • 批量解锁
      • 解决方案
      • 运行历史
      • 运维调度
      • 运维概览
      • 作业监控
      • 批作业监控
      • 实时作业监控
      • 实例监控
      • 补数据监控
      • 通知管理
      • 管理通知
      • 通知周期概览
      • 备份管理
      • 配置管理
      • 配置
      • 配置环境变量
      • 配置OBS桶
      • 管理作业标签
      • 配置委托
      • 配置默认项
      • 管理资源
      • 节点参考
      • 节点概述
      • 节点数据血缘
      • 方案概述
      • 配置数据血缘
      • 查看数据血缘
      • CDM Job
      • Rest Client
      • Import GES
      • MRS Kafka
      • Kafka Client
      • ROMA FDI Job
      • DLI Flink Job
      • DLI SQL
      • DLI Spark
      • DWS SQL
      • MRS Spark SQL
      • MRS Hive SQL
      • MRS Presto SQL
      • MRS Spark
      • MRS Spark Python
      • MRS Flink Job
      • MRS MapReduce
      • CSS
      • Shell
      • RDS SQL
      • ETL Job
      • Python
      • Create OBS
      • Delete OBS
      • OBS Manager
      • Open/Close Resource
      • Data Quality Monitor
      • Sub Job
      • For Each
      • Dummy
      • EL表达式参考
      • 表达式概述
      • 基础操作符
      • 日期和时间模式
      • Env内嵌对象
      • Job内嵌对象
      • StringUtil内嵌对象
      • DateUtil内嵌对象
      • JSONUtil内嵌对象
      • Loop内嵌对象
      • OBSUtil内嵌对象
      • 表达式使用示例
      • 使用教程
      • 作业依赖详解
      • IF条件判断教程
      • 获取Rest Client算子返回值教程
      • For Each算子使用介绍
      • 开发一个Python脚本
      • 开发一个DWS SQL作业
      • 开发一个Hive SQL作业
      • 开发一个DLI Spark作业
      • 开发一个MRS Flink作业
      • 开发一个MRS Spark Python作业
      • 数据质量
      • 业务指标监控
      • 业务指标监控概述
      • 新建指标
      • 新建规则
      • 新建业务场景
      • 查看业务场景实例
      • 数据质量监控
      • 数据质量监控概述
      • 新建规则模板
      • 新建质量作业
      • 新建对账作业
      • 查看规则实例
      • 查看质量报告
      • 使用教程
      • 新建一个业务场景
      • 新建一个质量作业
      • 新建一个作业对账实例
      • 数据目录
      • 数据地图
      • 简介
      • 资产总览
      • 数据目录
      • 标签管理
      • 数据权限
      • 数据权限简介
      • 数据目录权限
      • 数据表权限
      • 审批中心
      • 数据安全(待下线)
      • 数据安全简介
      • 数据密级
      • 数据分类
      • 脱敏策略
      • 元数据采集
      • 元数据简介
      • 任务管理
      • 任务监控
      • 使用教程
      • 开发一个增量元数据采集任务
      • 通过数据地图查看数据血缘关系
      • 方案概述
      • 配置数据血缘
      • 查看数据血缘
      • 数据服务
      • 数据服务概览
      • 规格说明
      • 开发API
      • 准备工作
      • 创建专享版集群
      • 新建审核人
      • 创建API
      • 配置模式生成API
      • 脚本模式生成API
      • 注册API
      • 调试API
      • 发布API
      • 管理API
      • 设置API可见
      • 停用/恢复API
      • 下线/删除API
      • 复制API
      • 全量导出/导出/导入API
      • 流量控制
      • 调用API
      • 审核中心操作说明
      • 常见问题
      • 计费类
      • 购买类
      • 操作类
      • 管理中心
      • 数据集成
      • 数据架构
      • 数据开发
      • 数据质量
      • 数据目录
      • 数据服务
      • 相关协议
      • 数据治理中心 DataArts Studio产品服务协议
      • 数据治理中心 DataArts Studio产品服务等级协议
      • 文档下载
      • 数据治理中心 DataArts Studio用户操作指南
      • 数据治理中心 DataArts Studio故障排除
        计算
        弹性云主机
        GPU云主机
        物理机
        镜像服务
        轻量型云主机
        弹性伸缩服务
        一体化计算加速平台·异构计算
        弹性高性能计算
        多活容灾服务
        CDN与边缘
        算力互联调度平台
        CDN加速
        边缘安全加速平台
        全站加速
        安全加速(文档停止维护)
        应用加速(文档停止维护)
        智能边缘云
        云电竞
        科研助手
        Serverless边缘容器
        边缘容器集群(ECK专有版)
        性能测试PTS
        边缘重保服务
        实时云渲染
        人工智能
        一站式智算服务平台
        天翼云息壤一体化智算服务平台
        智算一体机
        模型适配专家服务
        人脸识别
        内容审核
        印刷文字识别
        安全生产
        自然语言处理
        iBox边缘盒子
        企业应用
        云通信-短信
        一键登录(文档停止维护)
        管理工具
        统一身份认证(一类节点)
        统一身份认证(二类节点)
        企业项目管理
        甄选应用
        新域名服务
        天翼通达OA
        SSL证书
        智慧看店
        翼建站
        翼云快销
        云网安全运营中心
        安全邮箱
        天翼智慧工厂
        WPS云文档天翼云版
        智能商业平台
        翼企业服务
        电脑维护
        网管专家服务
        EMM手机管家
        中望CAD(央企)
        智能组网(东南区版)
        云网智慧管理平台
        翼云数据管理
        翼IT业务监控
        翼云素质教育平台
        翼微卡
        翼电子签
        翼安全邮箱
        新华融翼
        支持与服务
        专家技术服务
        基础服务
        备案管家
        网站备案
        备案指引
        客户支持计划
        服务等级目标
        存储
        云硬盘
        对象存储
        并行文件服务 HPFS
        海量文件服务 OceanFS
        弹性文件服务
        混合存储网关
        云备份
        云硬盘备份
        云主机备份
        云容灾
        云存储网关
        存储容灾服务
        云服务备份
        云空间
        容器与中间件
        Serverless容器引擎
        云容器引擎
        分布式容器云平台
        弹性容器实例
        容器镜像服务
        云容器引擎(旧版)
        函数工作流
        分布式消息服务RabbitMQ
        分布式消息服务RocketMQ
        分布式消息服务Kafka
        分布式消息服务MQTT
        微服务引擎
        微服务云应用平台
        应用编排服务
        应用服务网格
        应用性能监控
        云日志服务
        函数计算
        EasyCoding敏捷开发平台
        软件开发生产线CodeArts
        视频
        媒体存储
        极速直播
        视频直播
        云点播
        智能视图服务
        网络
        弹性IP
        对等连接
        NAT网关
        共享带宽
        虚拟私有云
        内网DNS
        弹性负载均衡
        VPC终端节点
        VPN连接
        天翼云SD-WAN
        天翼云SD-WAN(尊享版)
        云间高速(尊享版)
        云间高速(标准版)
        云专线
        云专线CDA
        云专线(福建)
        算力专网
        企业交换机
        数据库
        关系数据库MySQL版
        关系数据库PostgreSQL版
        云数据库GeminiDB
        云数据库GaussDB
        数据管理服务
        关系数据库SQL Server版
        云数据库TaurusDB
        分布式缓存服务Redis版
        分布式关系型数据库
        文档数据库服务
        数据库复制
        云数据库ClickHouse
        数据库专家服务
        分布式融合数据库HTAP
        数据传输服务DTS
        安全及管理
        Web应用防火墙
        服务器安全卫士
        Anti-DDoS流量清洗
        网页防篡改(原生版)
        DDoS高防IP
        微隔离防火墙
        渗透测试
        漏洞扫描
        数据加密
        终端杀毒
        域名无忧
        云解析
        云下一代防火墙
        数据库安全
        SSL VPN
        DDoS高防(边缘云版)
        企业主机安全
        Web应用防火墙(原生版)
        服务器安全卫士(原生版)
        Web应用防火墙(独享版)
        云审计
        云防火墙(原生版)
        态势感知(专业版)
        数据安全中心
        云防火墙
        云等保专区
        漏洞扫描(专业版)
        托管检测与响应服务(原生版)
        云堡垒机(原生版)
        日志审计(原生版)
        证书管理服务
        数据库审计
        容器安全卫士
        态势感知(专业版)(新版)
        云安全中心
        云密评专区
        安全体检
        密钥管理
        运维安全中心(云堡垒机)
        态势感知
        安全专区
        等保咨询
        Web应用防火墙(边缘云版)
        网站安全监测
        爬虫管理
        专属云与混合云
        专属云(计算独享型)
        专属云(存储独享型)
        专属云容器引擎
        专属云分布式消息服务Kafka
        专属云(关系型数据库MySQL)
        混合云一体机
        用户服务
        账号中心
        费用中心
        法律声明
        短信验证能力
        重点操作短信验证
        更多
        天翼云学堂
        天翼云APP
        合作伙伴认证
        云终端
        天翼云电脑(政企版)
        天翼云电脑(公众版)
        天翼云手机
        大数据
        数据仓库服务
        数据治理中心 DataArts Studio
        数据湖探索
        翼MapReduce
        云搜索服务
        大数据管理平台 DataWings
        迁移与管理
        应用运维管理
        云迁移工具RDA
        云监控服务
        应用性能管理
        主机迁移服务SMS
        API网关
        云迁移服务CMS
        创新能力专区
        存储资源盘活系统
        对象存储(经典版)I型

        本页目录

        配置API基本信息

        配置取数逻辑

        测试API

        修改API

        选择产品所在区域 根据产品所在区域的不同,文档内容也会对应进行调整
        二类节点
        二类节点
        华东地区
        苏州
        华南地区
        福州1/广州4
        西北地区
        西安2
        西南地区
        贵州1
        北方地区
        华北
        选择节点类型
        二类节点
        华东地区
        苏州
        华南地区
        福州1/广州4
        西北地区
        西安2
        西南地区
        贵州1
        北方地区
        华北
        帮助中心 数据治理中心 DataArts Studio 用户指南 数据服务 开发API 创建API 脚本模式生成API
        选择产品所在区域 根据产品所在区域的不同,文档内容也会对应进行调整
        二类节点
        二类节点
        华东地区
        苏州
        华南地区
        福州1/广州4
        西北地区
        西安2
        西南地区
        贵州1
        北方地区
        华北
        选择节点类型
        二类节点
        华东地区
        苏州
        华南地区
        福州1/广州4
        西北地区
        西安2
        西南地区
        贵州1
        北方地区
        华北
        脚本模式生成API
        更新时间 2023-08-17 17:32:05
        • 新浪微博
        • 微信
          扫码分享
        • 复制链接
        最近更新时间: 2023-08-17 17:32:05
        下载本页

        脚本模式生成API

        2023-08-17 09:32:05

        为了满足高阶用户的个性化查询需求,数据服务也提供了自定义SQL的脚本模式,允许您自行编写API的查询SQL,并支持多表关联、复杂查询条件以及聚合函数等能力。

        配置API基本信息

        1.在DataArts Studio控制台首页,选择实例,点击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。

        详见下图:选择数据服务

        image.png

        2.在左侧导航选择服务版本(例如:专享版),进入总览页。

        3.进入“API管理”页面,单击“新建”,填写API基本信息。

        详见下表: API基本信息

        配置 说明
        API名称 支持中文、英文、数字、下划线,且只能以英文或中文开头,3-64个字符。
        API目录 一个特定功能或场景的API集合,类似文件夹,是数据服务中API的最小组织单元,也是API网关中的最小管理单元。 您可单击“新建”进行新建,也可选择已创建的API分组。
        请求Path API访问路径,例如:/v2/{project_id}/streams。 请求Path即完整的url中,域名之后、查询参数之前的部分,如下图中的“/blogs/188138”。详见下图: 统一资源定位符url说明image.png
        在请求路径中,可以使用大括号{}标识路径中的参数作为通配符。如“/blogs/{blog_id}”表示/blogs后可以携带任何参数,例如“/blogs/188138”和“/blogs/0”均会匹配至/blogs/{blog_id},由此API统一处理。 此外,相同域名下,不允许重复的请求路径出现。路径参数作为通配符时,名称不具备唯一性,例如“/blogs/{blog_id}”和“/blogs/{xxxx}”,会被视作相同路径。
        参数协议 用于传输请求的协议,支持HTTP和HTTPS协议。
        HTTP属于基础的网络传输协议,无状态、无连接、简单、快速、灵活、使用明文传输,在使用上较为便捷,但是安全性欠佳。
        HTTPS是在HTTP协议上进行了SSL或TLS加密校验的协议,能够有效验证身份以及保护数据完整性。相对的,访问HTTPS的API,需要配置相关的SSL证书或跳过SSL校验,否则将无法访问。
        请求方式 HTTP请求方式,表示请求什么类型的操作,包含GET、POST等,遵循resultful风格。
        GET:请求服务器返回指定资源,推荐使用GET请求。
        POST:请求服务器新增资源或执行特殊操作,仅在注册API时使用。POST请求当前不支持body体,而是直接透传。
        描述 对API进行简要描述。
        标签 对API设置标签。用于标记当前API的属性,创建后可以通过标签快速检索定位API。单个API最多可设置20个标签。
        审核人 拥有API的审核权限。 单击“新建”,进入“审核中心>审核人管理”页面,新建审核人。
        安全认证 API认证方式:
        APP认证:表示由API网关服务负责接口请求的安全认证,安全级别最高。
        IAM认证:表示借助IAM服务进行安全认证,安全级别中等。
        无认证:属于无防护的模式,无需认证即可访问,安全级别低,不推荐使用。
        服务目录可见性 发布后,所选范围内的用户均可以在服务目录中看到此API。
        当前工作空间可见
        当前项目可见
        当前租户可见
        访问日志 勾选,则此API的查询结果将会产生记录并被保留7天,可以在“运营管理>访问日志”处通过选择“请求日期”的方式查看对应日期的日志。
        最低保留期限 API解绑前预留的最低期限。0表示不设限制。 API进行停用/下线/取消授权时,会通知已授权用户,并为用户预留至少X小时,直到所有授权用户均完成解除或处理,或者到达截止时间,API才会停用/下线/取消授权。
        入参定义 配置API请求中的参数,包含资源路径中的动态参数,请求URI中的查询参数和Header参数。 添加入参定义时,如果参数设定为必填,则API在访问时,必须传入指定参数;如果非必填,则在API访问时,未传入的参数,会使用默认值进行代替。 参数大小限制如下:
        query+path,url最大32KB
        header,最大128KB
        body, 最大128KB
        以配置资源路径中的动态参数为例进行说明,例如资源路径(请求Path)设置为: /v2/{project_id}/streams,资源路径中的{project_id}为动态参数,需要在此进行配置。 1. 单击“添加”,参数名配置为project_id。 2. 参数位置选择PATH。 3. 类型设置为STRING。 4. 选择性配置示例值和描述。

        4.配置好API基本信息后,单击“下一步”,即可进入API取数逻辑页面。

        配置取数逻辑

        “取数方式”选择“脚本方式”:

        1.选择数据源、数据连接、数据库和队列,获取到需要配置的表。

        说明

        数据服务仅支持部分数据源,详情请参见图 DataArts Studio支持的数据源。您需提前在DataArts Studio管理中心中配置好数据源,按照脚本编辑提示要求输入SQL语句。

        2.编写API查询SQL。

        在脚本编辑页面,按照脚本编辑提示要求输入SQL语句。

        说明
        • SELECT查询的字段即为API返回参数,支持返回别名。

        • WHERE条件中的参数为API请求参数,参数格式为${参数名}。

        3.选择分页方式。

        默认分页是指在创建API时输入了SQL,数据服务会自动基于SQL外层包装分页逻辑。例如输入的SQL脚本为:

        SELECT name as Student_Name FROM tableofresults

        数据服务在处理调试或者调用时,将自动在用户SQL外层包装分页逻辑,从而变成以下脚本:

        SELECT * FROM (SELECT name as Student_Name FROM tableofresults) LIMIT {pageSize} OFFSET {offsetValue}

        其中pageNum、offsetValue为调试或者调用时传入参数的值。如果未定义pageNum参数的话,数据服务将默认给API设置一个pageNum参数;offsetValue是调试或者调用时传入参数pageSize的值计算得到,如果用户未定义pageSize参数的话,数据服务将默认给API设置一个pageSize参数。

        自定义分页是指用户在创建API时,数据服务将不对用户SQL进行处理,分页逻辑完全由用户定义。如果用户需要创建分页的API的话,则可以在写SQL时加入分页逻辑。例如:

        SELECT name as Student_Name FROM tableofresults LIMIT {pageSize} OFFSET {offsetValue}

        4.添加排序参数。

        在排序参数列表中,设置排序字段是否可选,排序方式和描述。单击image.png,将入参和排序参数添加为SQL语句的API请求参数。

        说明

        添加排序参数前,请确保SQL语句正确。

        5.编辑请求参数信息

        编写好API查询SQL后,单击“测试SQL”,在数据库字段页签内绑定HTTP入参。参见配置取数逻辑中的6配置pre_order_by参数。

        说明

        pre_order_by是非必填参数,当未配置pre_order_by参数值时,则选取非可选排序字段作为排序的依据。

        测试API

        完成API参数的配置并保存后,单击左下角的“开始测试”,可进入API测试环节。

        填写参数值,单击“开始测试”,即可在线发送API请求,在右侧可以看到API请求详情及返回内容。如果测试失败,请仔细查看错误提示并做相应的修改重新测试。 配置过程中需要注意正常返回示例的设置。

        完成API测试之后,单击“确定”,即成功生成了一个数据API。

        修改API

        生成API后,如果您需要修改API内容,可在“开发API > API目录”或“开发API > API管理”处选择对应API,点击“编辑”按钮进行修改API的相关操作。

        说明

        仅当API处于已创建、已驳回、已下线、已停用的情况下才能进行API修改。

        分享文章
        • 新浪微博
        • 微信
          扫码分享
        • 复制链接
        本章节主要介绍脚本模式生成API。

        为了满足高阶用户的个性化查询需求,数据服务也提供了自定义SQL的脚本模式,允许您自行编写API的查询SQL,并支持多表关联、复杂查询条件以及聚合函数等能力。

        配置API基本信息

        1.在DataArts Studio控制台首页,选择实例,点击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。

        详见下图:选择数据服务

        image.png

        2.在左侧导航选择服务版本(例如:专享版),进入总览页。

        3.进入“API管理”页面,单击“新建”,填写API基本信息。

        详见下表: API基本信息

        配置 说明
        API名称 支持中文、英文、数字、下划线,且只能以英文或中文开头,3-64个字符。
        API目录 一个特定功能或场景的API集合,类似文件夹,是数据服务中API的最小组织单元,也是API网关中的最小管理单元。 您可单击“新建”进行新建,也可选择已创建的API分组。
        请求Path API访问路径,例如:/v2/{project_id}/streams。 请求Path即完整的url中,域名之后、查询参数之前的部分,如下图中的“/blogs/188138”。详见下图: 统一资源定位符url说明image.png
        在请求路径中,可以使用大括号{}标识路径中的参数作为通配符。如“/blogs/{blog_id}”表示/blogs后可以携带任何参数,例如“/blogs/188138”和“/blogs/0”均会匹配至/blogs/{blog_id},由此API统一处理。 此外,相同域名下,不允许重复的请求路径出现。路径参数作为通配符时,名称不具备唯一性,例如“/blogs/{blog_id}”和“/blogs/{xxxx}”,会被视作相同路径。
        参数协议 用于传输请求的协议,支持HTTP和HTTPS协议。
        HTTP属于基础的网络传输协议,无状态、无连接、简单、快速、灵活、使用明文传输,在使用上较为便捷,但是安全性欠佳。
        HTTPS是在HTTP协议上进行了SSL或TLS加密校验的协议,能够有效验证身份以及保护数据完整性。相对的,访问HTTPS的API,需要配置相关的SSL证书或跳过SSL校验,否则将无法访问。
        请求方式 HTTP请求方式,表示请求什么类型的操作,包含GET、POST等,遵循resultful风格。
        GET:请求服务器返回指定资源,推荐使用GET请求。
        POST:请求服务器新增资源或执行特殊操作,仅在注册API时使用。POST请求当前不支持body体,而是直接透传。
        描述 对API进行简要描述。
        标签 对API设置标签。用于标记当前API的属性,创建后可以通过标签快速检索定位API。单个API最多可设置20个标签。
        审核人 拥有API的审核权限。 单击“新建”,进入“审核中心>审核人管理”页面,新建审核人。
        安全认证 API认证方式:
        APP认证:表示由API网关服务负责接口请求的安全认证,安全级别最高。
        IAM认证:表示借助IAM服务进行安全认证,安全级别中等。
        无认证:属于无防护的模式,无需认证即可访问,安全级别低,不推荐使用。
        服务目录可见性 发布后,所选范围内的用户均可以在服务目录中看到此API。
        当前工作空间可见
        当前项目可见
        当前租户可见
        访问日志 勾选,则此API的查询结果将会产生记录并被保留7天,可以在“运营管理>访问日志”处通过选择“请求日期”的方式查看对应日期的日志。
        最低保留期限 API解绑前预留的最低期限。0表示不设限制。 API进行停用/下线/取消授权时,会通知已授权用户,并为用户预留至少X小时,直到所有授权用户均完成解除或处理,或者到达截止时间,API才会停用/下线/取消授权。
        入参定义 配置API请求中的参数,包含资源路径中的动态参数,请求URI中的查询参数和Header参数。 添加入参定义时,如果参数设定为必填,则API在访问时,必须传入指定参数;如果非必填,则在API访问时,未传入的参数,会使用默认值进行代替。 参数大小限制如下:
        query+path,url最大32KB
        header,最大128KB
        body, 最大128KB
        以配置资源路径中的动态参数为例进行说明,例如资源路径(请求Path)设置为: /v2/{project_id}/streams,资源路径中的{project_id}为动态参数,需要在此进行配置。 1. 单击“添加”,参数名配置为project_id。 2. 参数位置选择PATH。 3. 类型设置为STRING。 4. 选择性配置示例值和描述。
        配置 说明

        4.配置好API基本信息后,单击“下一步”,即可进入API取数逻辑页面。

        配置取数逻辑

        “取数方式”选择“脚本方式”:

        1.选择数据源、数据连接、数据库和队列,获取到需要配置的表。

        说明

        数据服务仅支持部分数据源,详情请参见图 DataArts Studio支持的数据源。您需提前在DataArts Studio管理中心中配置好数据源,按照脚本编辑提示要求输入SQL语句。

        2.编写API查询SQL。

        在脚本编辑页面,按照脚本编辑提示要求输入SQL语句。

        说明
        • SELECT查询的字段即为API返回参数,支持返回别名。

        • WHERE条件中的参数为API请求参数,参数格式为${参数名}。

        3.选择分页方式。

        默认分页是指在创建API时输入了SQL,数据服务会自动基于SQL外层包装分页逻辑。例如输入的SQL脚本为:

        SELECT name as Student_Name FROM tableofresults

        数据服务在处理调试或者调用时,将自动在用户SQL外层包装分页逻辑,从而变成以下脚本:

        SELECT * FROM (SELECT name as Student_Name FROM tableofresults) LIMIT {pageSize} OFFSET {offsetValue}

        其中pageNum、offsetValue为调试或者调用时传入参数的值。如果未定义pageNum参数的话,数据服务将默认给API设置一个pageNum参数;offsetValue是调试或者调用时传入参数pageSize的值计算得到,如果用户未定义pageSize参数的话,数据服务将默认给API设置一个pageSize参数。

        自定义分页是指用户在创建API时,数据服务将不对用户SQL进行处理,分页逻辑完全由用户定义。如果用户需要创建分页的API的话,则可以在写SQL时加入分页逻辑。例如:

        SELECT name as Student_Name FROM tableofresults LIMIT {pageSize} OFFSET {offsetValue}

        4.添加排序参数。

        在排序参数列表中,设置排序字段是否可选,排序方式和描述。单击image.png,将入参和排序参数添加为SQL语句的API请求参数。

        说明

        添加排序参数前,请确保SQL语句正确。

        5.编辑请求参数信息

        编写好API查询SQL后,单击“测试SQL”,在数据库字段页签内绑定HTTP入参。参见配置取数逻辑中的6配置pre_order_by参数。

        说明

        pre_order_by是非必填参数,当未配置pre_order_by参数值时,则选取非可选排序字段作为排序的依据。

        测试API

        完成API参数的配置并保存后,单击左下角的“开始测试”,可进入API测试环节。

        填写参数值,单击“开始测试”,即可在线发送API请求,在右侧可以看到API请求详情及返回内容。如果测试失败,请仔细查看错误提示并做相应的修改重新测试。 配置过程中需要注意正常返回示例的设置。

        完成API测试之后,单击“确定”,即成功生成了一个数据API。

        修改API

        生成API后,如果您需要修改API内容,可在“开发API > API目录”或“开发API > API管理”处选择对应API,点击“编辑”按钮进行修改API的相关操作。

        说明

        仅当API处于已创建、已驳回、已下线、已停用的情况下才能进行API修改。

        上一篇 :  配置模式生成API
        下一篇 :  注册API
        相关文档
        时间宏变量使用解析
        配置Cassandra连接
        HBase/CloudTable增量迁移
        导出导入作业
        提交版本并解锁
        购买
        建议与反馈
        以上内容是否对您有帮助?
        有 没有
        感谢您的反馈,您的支持是我们前进的动力!
        您的操作过于频繁,清稍后再试
        文档反馈

        建议您登录后反馈,可在建议与反馈里查看问题处理进度

        鼠标选中文档,精准反馈问题

        选中存在疑惑的内容,即可快速反馈问题,我们会跟进处理

        知道了

         文本反馈

        本页目录

        配置API基本信息
        配置取数逻辑
        测试API
        修改API
        搜索
          计算
          弹性云主机
          GPU云主机
          物理机
          镜像服务
          轻量型云主机
          弹性伸缩服务
          一体化计算加速平台·异构计算
          弹性高性能计算
          多活容灾服务
          CDN与边缘
          算力互联调度平台
          CDN加速
          边缘安全加速平台
          全站加速
          安全加速(文档停止维护)
          应用加速(文档停止维护)
          智能边缘云
          云电竞
          科研助手
          Serverless边缘容器
          边缘容器集群(ECK专有版)
          性能测试PTS
          边缘重保服务
          实时云渲染
          人工智能
          一站式智算服务平台
          天翼云息壤一体化智算服务平台
          智算一体机
          模型适配专家服务
          人脸识别
          内容审核
          印刷文字识别
          安全生产
          自然语言处理
          iBox边缘盒子
          企业应用
          云通信-短信
          一键登录(文档停止维护)
          管理工具
          统一身份认证(一类节点)
          统一身份认证(二类节点)
          企业项目管理
          甄选应用
          新域名服务
          天翼通达OA
          SSL证书
          智慧看店
          翼建站
          翼云快销
          云网安全运营中心
          安全邮箱
          天翼智慧工厂
          WPS云文档天翼云版
          智能商业平台
          翼企业服务
          电脑维护
          网管专家服务
          EMM手机管家
          中望CAD(央企)
          智能组网(东南区版)
          云网智慧管理平台
          翼云数据管理
          翼IT业务监控
          翼云素质教育平台
          翼微卡
          翼电子签
          翼安全邮箱
          新华融翼
          支持与服务
          专家技术服务
          基础服务
          备案管家
          网站备案
          备案指引
          客户支持计划
          服务等级目标
          存储
          云硬盘
          对象存储
          并行文件服务 HPFS
          海量文件服务 OceanFS
          弹性文件服务
          混合存储网关
          云备份
          云硬盘备份
          云主机备份
          云容灾
          云存储网关
          存储容灾服务
          云服务备份
          云空间
          容器与中间件
          Serverless容器引擎
          云容器引擎
          分布式容器云平台
          弹性容器实例
          容器镜像服务
          云容器引擎(旧版)
          函数工作流
          分布式消息服务RabbitMQ
          分布式消息服务RocketMQ
          分布式消息服务Kafka
          分布式消息服务MQTT
          微服务引擎
          微服务云应用平台
          应用编排服务
          应用服务网格
          应用性能监控
          云日志服务
          函数计算
          EasyCoding敏捷开发平台
          软件开发生产线CodeArts
          视频
          媒体存储
          极速直播
          视频直播
          云点播
          智能视图服务
          网络
          弹性IP
          对等连接
          NAT网关
          共享带宽
          虚拟私有云
          内网DNS
          弹性负载均衡
          VPC终端节点
          VPN连接
          天翼云SD-WAN
          天翼云SD-WAN(尊享版)
          云间高速(尊享版)
          云间高速(标准版)
          云专线
          云专线CDA
          云专线(福建)
          算力专网
          企业交换机
          数据库
          关系数据库MySQL版
          关系数据库PostgreSQL版
          云数据库GeminiDB
          云数据库GaussDB
          数据管理服务
          关系数据库SQL Server版
          云数据库TaurusDB
          分布式缓存服务Redis版
          分布式关系型数据库
          文档数据库服务
          数据库复制
          云数据库ClickHouse
          数据库专家服务
          分布式融合数据库HTAP
          数据传输服务DTS
          安全及管理
          Web应用防火墙
          服务器安全卫士
          Anti-DDoS流量清洗
          网页防篡改(原生版)
          DDoS高防IP
          微隔离防火墙
          渗透测试
          漏洞扫描
          数据加密
          终端杀毒
          域名无忧
          云解析
          云下一代防火墙
          数据库安全
          SSL VPN
          DDoS高防(边缘云版)
          企业主机安全
          Web应用防火墙(原生版)
          服务器安全卫士(原生版)
          Web应用防火墙(独享版)
          云审计
          云防火墙(原生版)
          态势感知(专业版)
          数据安全中心
          云防火墙
          云等保专区
          漏洞扫描(专业版)
          托管检测与响应服务(原生版)
          云堡垒机(原生版)
          日志审计(原生版)
          证书管理服务
          数据库审计
          容器安全卫士
          态势感知(专业版)(新版)
          云安全中心
          云密评专区
          安全体检
          密钥管理
          运维安全中心(云堡垒机)
          态势感知
          安全专区
          等保咨询
          Web应用防火墙(边缘云版)
          网站安全监测
          爬虫管理
          专属云与混合云
          专属云(计算独享型)
          专属云(存储独享型)
          专属云容器引擎
          专属云分布式消息服务Kafka
          专属云(关系型数据库MySQL)
          混合云一体机
          用户服务
          账号中心
          费用中心
          法律声明
          短信验证能力
          重点操作短信验证
          更多
          天翼云学堂
          天翼云APP
          合作伙伴认证
          云终端
          天翼云电脑(政企版)
          天翼云电脑(公众版)
          天翼云手机
          大数据
          数据仓库服务
          数据治理中心 DataArts Studio
          数据湖探索
          翼MapReduce
          云搜索服务
          大数据管理平台 DataWings
          迁移与管理
          应用运维管理
          云迁移工具RDA
          云监控服务
          应用性能管理
          主机迁移服务SMS
          API网关
          云迁移服务CMS
          创新能力专区
          存储资源盘活系统
          对象存储(经典版)I型
          ©2025 天翼云科技有限公司版权所有 增值电信业务经营许可证A2.B1.B2-20090001
          公司地址:北京市东城区青龙胡同甲1号、3号2幢2层205-32室
          备案 京公网安备11010802043424号 京ICP备 2021034386号
          ©2025天翼云科技有限公司版权所有
          京ICP备 2021034386号
          备案 京公网安备11010802043424号
          增值电信业务经营许可证A2.B1.B2-20090001
          用户协议 隐私政策 法律声明
          • 智能客服
            7*24小时不间断售后保障
          • 服务咨询
            400-810-9889
          • 建议与反馈
            天翼云与您共创优质云平台

          您对此文档页面满意吗?

          非常不满意 非常满意
          0 1 2 3 4 5 6 7 8 9 10
          操作失败,请您稍后再试