接口功能介绍 本接口用于查询回调模板列表。 接口约束 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI GET /v2/callbackTemplate 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 TemplateName 否 String 根据TemplateName查询。 回调模板 SortBy 否 String 选择按一个字段排序，默认为CreatedTime，按照创建时间排序。取值：TemplateName(模板名称)，CreatedTime(创建时间)。 CreatedTime SortDirection 否 String 排序方式，默认升序。取值：asc(升序)，desc(降序)。 asc PageNum 否 Integer 第几个分页，默认为1。 1 PageSize 否 Integer 分页大小，默认为20，取值范围为1～1000。 20 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 PageNum Integer 第几个分页。 1 PageSize Integer 分页大小。 10 TotalPage Integer 分页总数。 1 TotalNum Integer 模板总数。 10 CallbackTemplates Array of Objects 模板列表。 CallbackTemplate RequestId String 请求ID。 362d4e78556b47129182d0881fade86b 表 CallbackTemplate 参数 参数类型 说明 示例 下级对象 TemplateId String 模板ID。 739943519892963328 TemplateName String 模板名称。 test Description String 模板描述。 描述 CallbackKey String 回调KEY。 xxx DeviceStatusNotifyUrl String 设备状态回调URL。 < StreamStatusNotifyUrl String 流状态回调URL。 < RecordNotifyUrl String 录制回调URL。 < AiEventNotifyUrl String AI回调URL。 < CreatedTime String 创建时间。 1691992586 UpdatedTime String 更新时间。 1691992586

添加域名组 1. 登录管理控制台。 2. 在左侧导航栏中，单击左上方的，选择“安全 > 云防火墙”，进入云防火墙的总览页面。 3. （可选）当前账号下仅存在单个防火墙实例时，自动进入防火墙详情页面，存在多个防火墙实例时，单击防火墙列表“操作”列的“查看”，进入防火墙详情页面。 4. 在左侧导航栏中，选择“访问控制 > 对象组管理”，进入“对象组管理”界面。 5. （可选）如果添加网络域名组，则选择“网络域名组”页签。 6. 切换至“域名组”页签，单击“添加域名组”，弹出“添加域名组”，填写参数如下所示。 参数名称 参数说明 域名组类型 应用型/网络型 域名组名称 自定义域名组名称。 描述 （可选）设置该域名组的备注信息。 域名 输入域名，规则如下： 支持多级别单域名（例如，一级域名example.com，二级域名www.example.com等）和泛域名（例如，.example.com）。 多个域名以英文逗号、英文分号、换行符、空格分隔。 说明 输入的域名请勿重复。 添加域名组中域名 1. 登录管理控制台。 2. 在左侧导航栏中，单击左上方的，选择“安全> 云防火墙”，进入云防火墙的总览页面。 3. （可选）当前账号下仅存在单个防火墙实例时，自动进入防火墙详情页面，存在多个防火墙实例时，单击防火墙列表“操作”列的“查看”，进入防火墙详情页面。 4. 在左侧导航栏中，选择“访问控制> 对象组管理”，进入“对象组管理”界面。 5. 切换至“域名组”页签，单击添加的域名组名称。弹出“域名组”弹窗。 6. 单击“添加域名”，弹出“添加域名”对话框，填写域名信息。 单击添加可添加多个域名。 7. 确认无误后，单击“确认”，完成添加。

本章节主要介绍在DRDS控制台查看操作日志的步骤。 操作步骤 1. 在天翼云官网首页的顶部菜单栏，选择【产品 > 数据库 > 关系型数据库 > 分布式关系型数据库】，进入分布式关系型数据库产品页面。然后单击【管理控制台】，进入【概览】页面。 2. 在左侧导航栏，选择【DRDS > 操作日志】，进入操作日志列表页面。然后在顶部菜单栏，选择区域和项目。 3. 在操作日志列表页面，可以查看到用户在控制台执行的各项操作，包括来源、用户名、操作分类、操作类型、操作对象名称、状态、操作对象ID以及操作时间。 4. 在列表页，可对操作分类、操作类型、操作对象、操作内容、用户名以及操作时间进行筛选查询。其中，所支持的操作分类包括：DBPROXY（DRDS实例）、DBPROXYGROUP（DRDS实例分组）、RDS，操作对象包括各个分类下的实例。 对于各操作分类，所支持查看的操作类型如下表所示： 操作分类 操作类型 :: DBPROXY 新增关联RDS DBPROXY 删除关联RDS DBPROXY 启动参数设置 DBPROXY 执行ddl语句 DBPROXY ddl审计设置 DBPROXY 创建库表 DBPROXY 删除库表 DBPROXY 分片规则设置 DBPROXY 删除用户 DBPROXYGROUP 分组属性设置 DBPROXYGROUP 新增/修改黑/白名单 DBPROXYGROUP 删除黑/白名单 DBPROXYGROUP 关联RDS属性设置 DBPROXYGROUP 新增分组DML审计 DBPROXYGROUP 更新分组DML审计 DBPROXYGROUP 删除分组DML审计 DBPROXYGROUP 新建用户分组 DBPROXYGROUP 修改用户分组 RDS 删除RDS集群 RDS 新增RDS集群 RDS 删除节点 RDS 新增节点 RDS 修改节点 说明 上述表格记录了所支持查看的操作类型。不在表格中记录的操作类型，操作日志列表将不会展示。 操作日志发布之前的历史任务也会进行展示。

支持多种数据库工具 DWS 提供了以下几款自研工具，用户可以在DWS 管理控制台下载相关的工具包。 gsql工具 它是一款运行在Linux操作系统的命令行SQL客户端工具，用于连接DWS 集群中的数据库，并对数据库进行操作和维护。 Data Studio工具 它是一款运行在Windows操作系统上的图形界面SQL客户端工具，用于连接DWS 集群中的数据库、管理数据库和数据库对象，编辑、运行、调试SQL脚本，查看执行计划等。 GDS工具 它是DWS 提供的数据服务工具，通过和外表机制的配合，实现数据的高速导入导出。 GDS工具包需要安装在数据源文件所在的服务器上，数据源文件所在的服务器称为数据服务器，也称为GDS服务器。 DSC SQL语法迁移工具 DSC（Database Schema Convertor）是一款运行在Linux或Windows操作系统上的命令行工具，致力于向客户提供简单、快速、可靠的应用程序SQL脚本迁移服务，通过内置的语法迁移逻辑解析源数据库应用程序SQL脚本，并迁移为适用于DWS 数据库的应用程序SQL脚本。 DSC支持迁移Teradata、Oracle、Netezza、MySQL和DB2数据库的SQL脚本。 gsdump和gsdumpall gsdump支持导出单个数据库或其内的对象，而gsdumpall支持导出集群中所有数据库或各库的公共全局对象。 通过导入工具将导出的元数据信息导入至需要的数据库，可以完成数据库信息的迁移。 gsrestore 在数据库迁移场景下，支持使用gsrestore工具将事先使用gsdump工具导出的文件格式，重新导入DWS集群，实现表定义、数据库对象定义等元数据的导入。

请求代码示例 使用前请替换具体的${APPKEY}和${MODELID}值 plaintext curl location ' header 'Authorization: Bearer ${APPKEY}' header 'ContentType: application/json' data '{ "model": "${MODELID}", "query": "人工智能的发展趋势", "documents": [ "人工智能正在快速发展。", "机器学习是AI的核心技术。", "大语言模型改变了AI领域。", "自然语言是AI领域的里程碑" ], "topn": 2, "returndocuments": true }' 返回值说明 请求成功返回响应参数 名称 类型 描述 示例值 下级对象 code Int 接口状态码，返回状态，返回 0 表示成功 0 id String 请求标识 endpointcommon11684 results Array 模型返回的结果 results created Int 回答的创建时间，由模型侧返回 1719904068 model String 模型名称 BgeRerankLarge 表results 名称 类型 描述 示例值 下级对象 index Int 在原文档中对应索引 0 relevancescore Float 分数 0.992 document Object 文档内容，当returndocuments为true时，无此字段 document 表document 名称 类型 描述 示例值 下级对象 text String 目标文档 人工智能正在快速发展

接口功能介绍 创建target 接口约束 无 URI POST /v4/gwlb/createtarget 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 targetGroupID 是 String 后端服务组 ID tgxxx description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:"{},./;'[]·！@ ￥%……&（） —— +{}《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc instanceID 是 String 实例 ID xxxxx instanceType 是 String 支持 VM / BM VM weight 是 Integer 权重，支持1到256 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 接口业务数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 targetID String 后端服务ID targetxxxx

修改伸缩组最小云主机数 接口功能介绍 修改伸缩组最小云主机数 接口约束 无 URI POST /v4/scaling/group/updateinstanceminnum 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 443 minCount 是 Integer 最小云主机数，取值范围：[0,50] 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 groupID Integer 伸缩组ID 82 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 424, "minCount": 2 }

设置云主机移出规则 接口功能介绍 设置云主机移出规则 接口约束 无 URI POST /v4/scaling/group/updateinstancemoveoutstrategy 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 443 moveOutStrategy 是 Integer 实例移出策略。取值范围：1：较早创建的配置较早创建的云主机。2：较晚创建的配置较晚创建的云主机。3：较早创建的云主机。4：较晚创建的云主机。 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 groupID Integer 伸缩组ID 82

接口功能介绍 删除 接口约束 无 URI POST /v4/elb/deleterule 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b ID 否 String 转发规则ID, 该字段后续废弃 xxx policyID 否 String 转发规则ID, 推荐使用该字段, 当同时使用 ID 和 policyID 时，优先使用 policyID xxxx 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 返回结果 见下表 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ID String 转发规则 ID xxxx

接口功能介绍 应用删除 接口约束 输入参数名称类长度不超过64位，描述类长度不超过128位 URI POST /v4/sdwan/app/delete 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 appIDList 是 Array of Strings 应用id列表 ，值类型为string 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码('800为成功，900为失败) ，默认值:800 800 errorCode String 业务细分码，为product.module.code三段式码 message String 失败时的错误描述，一般为英文描述 description String 失败时的错误描述，一般为中文描述 returnObj Array of Objects 返回参数 returnObj error String 业务细分码，为product.module.code三段式码 表 returnObj 参数 参数类型 说明 示例 下级对象 operationID String 操作id 2667c06e4a0f11edb0e4005056898fe0 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "appIds": [ "3157c06e4a0f11edb0e4005056898fe0" ] } 响应示例 { "statusCode": 800, "returnObj": [ { "operationID": "2667c06e4a0f11edb0e4005056898fe0" } ], "errorCode": "", "error": "", "message": "", "description": "" }

接口功能介绍 本接口用于查询目录信息。 接口约束 查询目录前确保存在该目录。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI GET /v2/dirs/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DirId 是 String 目录ID。 897098424844288 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ParentDirId String 上级目录ID。 1 DirId String 目录ID。 693323900457467904 DirName String 目录名称。 openapidir DirType String 目录类别。取值：common(普通)，virual(虚拟)。 common DirCode Integer 目录编码。 0087 Description String 目录描述。 描述 CreatedTime String 目录创建时间。 1679641940225 UpdatedTime String 目录更新时间。 1680513927459 RequestId String 请求ID。 8041c7552510454f924211a3540ea3e6

开启一台轻量型云主机 接口功能介绍 该接口提供用户开启一台轻量型云主机功能。 接口约束 轻量云主机需要处于关机状态 URI POST /v4/ecs/lite/start 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 81f7728662dd11ec810800155d307d5b instanceID 是 String 云主机ID adc614e0e838d73f0618a6d51d09070a 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码(800为成功，900为失败) 800 errorCode String 业务细分码，为product.module.code三段式码，详见错误码说明 Openapi.PatternCheck.NotValid message String 失败时的错误描述，一般为英文描述 SUCCESS description String 失败时的错误描述，一般为中文描述 成功 returnObj Object 成功时返回的数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 jobID String 开机任务ID osffe1fe3c36be469da5ea593662bb40b4

重启一台轻量型云主机 接口功能介绍 该接口提供用户重启一台轻量型云主机功能。 接口约束 轻量云主机需要处于开机状态 URI POST /v4/ecs/lite/reboot 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 81f7728662dd11ec810800155d307d5b instanceID 是 String 云主机ID adc614e0e838d73f0618a6d51d09070a 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码(800为成功，900为失败) 800 errorCode String 业务细分码，为product.module.code三段式码，详见错误码说明 Openapi.PatternCheck.NotValid message String 失败时的错误描述，一般为英文描述 SUCCESS description String 失败时的错误描述，一般为中文描述 成功 returnObj Object 成功时返回的数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 jobID String 重启任务ID osffe1fe3c36be469da5ea593662bb40b4

关闭一台轻量型云主机 接口功能介绍 该接口提供用户关闭一台轻量型云主机功能。 接口约束 轻量型云主机需要处于开机状态 URI POST /v4/ecs/lite/stop 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 81f7728662dd11ec810800155d307d5b instanceID 是 String 云主机ID adc614e0e838d73f0618a6d51d09070a 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码(800为成功，900为失败) 800 errorCode String 业务细分码，为product.module.code三段式码，详见错误码说明 Openapi.PatternCheck.NotValid message String 失败时的错误描述，一般为英文描述 SUCCESS description String 失败时的错误描述，一般为中文描述 成功 returnObj Object 成功时返回的数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 jobID String 关机任务ID osffe1fe3c36be469da5ea593662bb40b4

一键告警 一键告警：产品禁用 接口功能介绍 此接口用于禁用一个产品的一键告警规则。 接口约束 无。 URI POST /v4/monitor/alertonekey/disableservice 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b service 是 String 本参数表示产品名称。取值范围：ecs：云主机。evs：云硬盘。...详见“[一键告警：产品列表]”接口返回。 ecs alarmType 是 String 本参数表示告警类型。 取值范围：series：时序指标。event：事件。 根据以上范围取值。 series 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

外部告警 外部告警：发送通知 接口功能介绍 调用此接口可发送自定义消息。 接口约束 无。 URI POST /v4/monitor/sendmessage 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 method 是 Array of Strings 发送方式 本参数表示发送方式，取值范围：1.email：邮箱2.sms：短信 token 是 String token 1411668ec8c13f57472576d5d1603226 content 是 String 发送内容 这里的内容是测试 subject 否 String 邮件主题 邮件主题测试 webhookURL 否 Array of Strings webhook推送url [' 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

外部告警 外部告警：获取告警联系人组token 接口功能介绍 调用此接口可获取告警联系人组token。 接口约束 无。 URI GET /v4/monitor/gettoken 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 contactGroupID 是 String 告警联系人组ID cf21ea17e31d5f47bf106c489a86f67d 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 token String token 1411668ec8c13f57472576d5d1603226 请求示例 请求url /v4/monitor/gettoken?contactGroupIDcf21ea17e31d5f47bf106c489a86f67d 请求头header 无 请求体body 无 响应示例 json { "statusCode":800, "returnObj":{ "token":"1411668ec8c13f57472576d5d1603226" }, "errorCode":"", "message":"Success", "msgDesc":"成功" }

告警联系人/组 告警联系人组：删除 接口功能介绍 调用此接口可删除告警联系人组。 接口约束 告警联系人存在。 URI POST /v4/monitor/deletecontactgroup 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 contactGroupID 是 String 告警联系人组ID a6fb570f22995bde989cdf0819c687d0 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 请求示例 请求url /v4/monitor/deletecontactgroup 请求头header 无 请求体body json { "contactGroupID": "fe7f0cdc469255168d3ab06355482090" } 响应示例 json { "statusCode":800, "returnObj":{ "success":true }, "errorCode":"", "message":"Success", "msgDesc":"成功" }

告警联系人/组 告警联系人：删除 接口功能介绍 调用此接口可删除告警联系人。 接口约束 告警联系人存在。 URI POST /v4/monitor/deletecontact 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 contactID 是 String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 请求示例 请求url /v4/monitor/deletecontact 请求头header 无 请求体body json { "contactID": "a6fb570f22995bde989cdf0819c687d0" } 响应示例 json { "statusCode":800, "returnObj":{ "success":true }, "errorCode":"", "message":"Success", "msgDesc":"成功" }

告警联系人/组 告警联系人：批量删除 接口功能介绍 调用此接口可批量删除多个创建告警联系人。 接口约束 告警联系人存在。 URI POST /v4/monitor/deletecontacts 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 contactIDList 是 Array of Strings 告警联系人ID列表 ['a6fb570f22995bde989cdf0819c687d0','b27dbeb41d5c5e008b475930b60d7621'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 请求示例 请求url /v4/monitor/deletecontacts 请求头header 无 请求体body json { "contactIDList": [ "248848b7b1bb598ca195084ccc7187ba", "b27dbeb41d5c5e008b475930b60d7621" ] }

接口功能介绍 获取非对称密钥公钥 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/getPublicKey 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id 2ab1a98370724bbca5826387f05ae0d8 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 获取非对称公钥成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 publicKey String 非对称密钥公钥 BEGIN PUBLIC KEYnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs5Yu9AEgATN2/e3nUz1KnEy6ng8MSPutcse2/VECG/NUF9C6D4IsJ64ShzY3dcn34WYzTOe916eMJFxyrNrSwnHtc4UOR5AvaoRrfpgu2uq+i70/ZXrWL+pGb1hgZV8cWheIHMxwrR3IiQlM5qN7EFn9BdyWtyBfUGsp0Bn1VqlPc5G0x0a9xU2z9YtP994yDenNVIoIQ6Cov1lIEuwXAb2n7boC41ePXwD0JWt41sP+rgCmpjBx00puIG+IlnoReEgI1ZGYmK98GgA/XzmNjZiDnyvXJZAcM33Ue85+PkR5iHTtSEbi4QAoqpJabprUzz3Fin2j1dRrcacxGb7p31A9cnJQIDAQABnEND PUBLIC KEYn

接口功能介绍 本接口用于查询直播实时在线流 使用说明 单个用户一分钟限制调用10000次，并发不超过100； 数据延迟时间为5min。 接口详情 请求方式：post 请求路径：/live/statistics/querystreamrealtimeflow 请求参数 参数 是否必填 参数类型 说明 示例 下级对象 domain 是 list 加速域名列表 [“ctyun.cn”,“ctyun.cn1”] appname 否 list 发布点列表 [“app1”,“app2”] 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 code 是 int 状态码 100000 message 是 string 描述信息 success totalNum 否 int 总数量 10 result 否 list 返回结果列表 resultsingle 表resultsingle： 参数 是否必填 参数类型 说明 示例 下级对象 Domain 否 string 域名 ctyun.cn2 App 否 string 发布点 app1 Stream 否 string 流名称 stream1 PushTime 否 string 推流开始时间 20201201T18:00:00.000+0800 ClientIp 否 string 主播推流端IP 2.2.2.2 CdnIp 否 string cdn推流节点IP 1.1.1.1 Time 否 string 最新时间 20201201T18:00:00.000+0800

创建json 类型字段表 teledb create table tjson(id int,fjson json); CREATE TABLE 插入数据 teledb insert into tjson values(1,'{"col1":1,"col2":"teledb"}'); INSERT 0 1 teledb insert into tjson values(2,'{"col1":1,"col2":"teledb","col3":"pgxz"}'); INSERT 0 1 teledb select from tjson; id fjson + 1 {"col1":1,"col2":"teledb"} 2 {"col1":1,"col2":"teledb","col3":"pgxz"} (2 rows) 通过键获得json对象域 teledb select fjson >'col2' as col2 ,fjson > 'col3' as col3 from tjson; col2 col3 + "teledb" "teledb" "pgxz" (2 rows) 以文本形式获取对象值 teledb select fjson >>'col2' as col2 ,fjson >> 'col3' as col3 from tjson; col2 col3 + teledb teledb pgxz (2 rows) teledb select fjson >>'col2' as col2 ,fjson >> 'col3' as col3 from tjson where fjson >> 'col3' is not null; col2 col3 + teledb pgxz (1 row)

本页介绍天翼云TeleDB数据库实例运行快照。 操作步骤 1. 以用户名和密码登录分布式数据库TeleDB控制台，在左侧导航树单击实例监控 ，选择实例运行快照 页签。 2. 快照设置 1. 单击快照设置 ，弹出实例运行快照策略设置 对话框。 2. 在实例运行快照策略设置 对话框中，打开运行快照开启状态，输入快照开启时间和快照间隔时间，单击确定 完成设置。 3. 手动快照 单击手动快照 可立即执行快照。 4. 查询快照列表 可通过设置起始时间和结束时间，单击查询筛选已产生的快照列表。 5. 查看快照详情 单击对应快照记录的详情，可查看该快照的详细信息。 具体内容包括： 数据库状态：节点名称、IP、端口、角色、日志同步状态、运行状态。 数据库核心配置：synchronouscommit、maxpoolsize、autovaccum、maxconnection、workmem、walkeepsegments、vacuumdelta、sharedbuffers的参数值。 数据库连接分析：包括CN和DN的连接情况，如avgconn、avgconnactive、avgconnidle、avgconnlock等。 DataNode节点请求量统计：统计DN节点的增删改查请求量。 数据库检查点：节点的检查点情况，如checkpointstimed、checkpointsreq等。 存储情况分节点统计：节点的存储情况，如totalsize、totaltups。 慢查询TOP 50：慢查询的TOP 50情况。 错误日志情况：包括错误信息、级别。 buffer命中率分析：包括平均、最大和最小情况。 锁分析（最多展示等待时间最长50条）。 节点CPU/内存利用率概况：节点CPU/内存利用率。 死锁详情：最多展示最近的50条。 回滚详情：最多展示最近的50条。 二阶段残留事务详情：二阶段残留事务详细信息。 6. 快照对比 1. 单击对应快照记录的快照对比，弹出快照对比对话框。 2. 在快照对比对话框，选择要对比的快照，单击确定可查看快照对比信息。

本页介绍天翼云TeleDB数据库实例运行快照。 操作步骤 1. 以用户名和密码登录分布式数据库TeleDB控制台，在左侧导航树单击实例监控 ，选择实例运行快照 页签。 2. 快照设置 1. 单击快照设置 ，弹出实例运行快照策略设置 对话框。 2. 在实例运行快照策略设置 对话框中，打开运行快照开启状态，输入快照开启时间和快照间隔时间，单击确定 完成设置。 3. 手动快照 单击手动快照可立即执行快照。 4. 查询快照列表 可通过设置起始时间和结束时间，单击查询筛选已产生的快照列表。 5. 查看快照详情 单击对应快照记录的详情，可查看该快照的详细信息。 具体内容包括： 数据库状态：节点名称、IP、端口、角色、日志同步状态、运行状态。 数据库核心配置：synchronouscommit、maxpoolsize、autovaccum、maxconnection、workmem、walkeepsegments、vacuumdelta、sharedbuffers的参数值。 数据库连接分析：包括CN和DN的连接情况，如avgconn、avgconnactive、avgconnidle、avgconnlock等。 DataNode节点请求量统计：统计DN节点的增删改查请求量。 数据库检查点：节点的检查点情况，如checkpointstimed、checkpointsreq等。 存储情况分节点统计：节点的存储情况，如totalsize、totaltups。 慢查询TOP 50：慢查询的TOP 50情况。 错误日志情况：包括错误信息、级别。 buffer命中率分析：包括平均、最大和最小情况。 锁分析：最多展示等待时间最长50条。 节点CPU/内存利用率概况：节点CPU/内存利用率统计。 死锁详情：最多展示最近的50条。 回滚详情：最多展示最近的50条。 二阶段残留事务详情：二阶段残留事务详细信息。 6. 快照对比 1. 单击对应快照记录的快照对比，弹出快照对比 对话框。 2. 在快照对比对话框，选择要对比的快照，单击确定 可查看快照对比信息。

autovacuumworkmem (integer) 指定每个自动清理工作者进程能使用的最大内存量。其默认值为1，表示转而使用 maintenanceworkmem的值。当运行在其他上下文环境中时，这个设置对VACUUM的行为没有影响。 maxstackdepth (integer) 指定服务器的执行堆栈的最大安全深度。这个参数的理想设置是由内核强制的实际栈尺寸限制（ulimit s所设置的或者本地等价物），减去大约一兆字节的安全边缘。需要这个安全边缘是因为在服务器中并非所有例程都检查栈深度，只是在关键的可能递规的例程（例如表达式计算）中才进行检查。默认设置是两兆字节（2MB），这个值相对比较小并且不可能导致崩溃。但是，这个值可能太小了，以至于无法执行复杂的函数。只有超级用户可以修改这个设置。把maxstackdepth参数设置得高于实际的内核限制将意味着一个失控的递归函数可能会导致一个独立的后端进程崩溃。 在TeleDB能够检测内核限制的平台上，服务器将不允许把这个参数设置为一个不安全的值。不过，并非所有平台都能提供该信息，所以我们还是建议你在选择值时要小心。 dynamicsharedmemorytype (enum) 指定服务器应该使用的动态共享内存实现。可能的值是posix（用于使用 shmopen分配的 POSIX 共享内存）、sysv （用于通过shmget分配的 System V 共享内存）、 windows（用于 Windows 共享内存）、mmap （使用存储在数据目录中的内存映射文件模拟共享内存）以及none（禁用 这个特性）。并非所有平台上都支持所有值，平台上第一个支持的选项就是其默认值。 在任何平台上mmap选项都不是默认值，通常不鼓励使用它，因为操作系统会 反复地把修改过的页面写回到磁盘上，从而增加了系统的I/O负载。不过当 pgdynshmem目录被存储在一个 RAM 盘时或者没有其他共享内存功能可用时， 它还是有用的。

参数描述 参数描述 类型 xzossymlinktarget 参数解释： 软链接指向的目标文件。 String xamzversionid 参数解释： 指定对象的版本id。 String

参数描述 参数描述 类型 xzossymlinktarget 参数解释： 软链接指向的目标文件。 String xamzversionid 参数解释： 指定对象的版本id。 String

本章节主要介绍集群扩容。 扩容集群 用户需要更多的计算资源或存储资源以满足业务需要时，可以在管理控制台对已有集群，通过增加节点进行扩容操作。 说明 如果当前集群是包年/包月计费模式，那么新增节点也是按照包年包月模式进行计费。 标准数仓集群扩容时使用与当前集群相同的存储规格。 如果子网IP数量不足，允许执行跨子网扩容操作。 如果您是因集群存储容量不足而扩容集群，建议您在扩容前先执行VACUUM清理和回收存储空间，DWS 数据仓库中保存的数据在删除后，可能没有释放占用的磁盘空间形成脏数据，导致磁盘浪费。如果执行VACUUM后，已使用存储容量仍然占用过高，您再进行扩容。VACUUM的语法请参见《数据仓库服务SQL语法参考》中的“VACUUM”章节。 扩容对系统的影响 扩容前，需退出创建了临时表的客户端连接，因为在扩容过程中及扩容成功之前创建的临时表将会失效，操作临时表也会失败。但是扩容后创建的临时表不受影响。 在执行“扩容”操作后，集群会进行一次自动快照，快照创建成功后进行集群扩容。 正在扩容的集群将禁用重启集群、扩容集群、创建快照、重置数据库管理员密码和删除集群的功能。 离线扩容过程中，集群会自动重启，因此集群会有一段时间变为“不可用”状态，重启成功后集群变回“可用”状态。然后在扩容结束阶段，系统会将集群中用户数据在全部节点重新动态分布。

本章节主要介绍如何创建天翼云物理机服务器。 操作场景 若您需要将您的应用服务部署在物理机服务器上，首先需要创建物理机服务器。 前提条件 在创建物理机服务器前，您已经完成准备工作。 操作步骤 1. 登录管理控制台。 2. 选择“计算 > 物理机服务”。进入物理机服务器页面。 3. 单击“申请物理机”，开始申请物理机。 4. 选择“区域”。不同区域的云服务产品之间内网互不相通。建议您选择最靠近您业务的区域，这样可以减少网络时延、提高访问速度。需要注意：资源创建成功后不能更换区域。 5. 选择“可用区”。可用区指在同一区域下，电力、网络隔离的物理区域，可用区之间内网互通，不同可用区之间物理隔离。 如果您需要提高应用的高可用性，建议您将物理机服务器创建在不同的可用区。 如果您需要较低的网络时延，建议您将物理机服务器创建在相同的可用区。 6. 选择“规格”。包括规格名称、CPU、内存、本地磁盘和扩展配置。当您选择规格列表中的一个规格后，列表下方会展示该规格的名称、用途等信息，以便您根据业务场景进行选择。其中，扩展配置描述了所选机型的网卡信息。例如：2 x 210GE表示1块双网口的10GE网卡接入VPC网络，1块双网口的10GE扩展网卡支持物理机服务器间的高速互联。 说明 规格中的CPU、内存、本地磁盘等配置为固定值，不可更改。 不同规格的物理机服务器带宽能力不同，请您根据实际业务慎重选择。 某些规格的物理机服务器支持快速发放能力，选择后，界面会提供“系统盘”参数（在“磁盘”配置项中展示），物理机服务器操作系统直接安装在云硬盘，实现快速发放。 7. 选择“镜像”。 公共镜像 常见的标准操作系统镜像，所有用户可见，包括操作系统以及预装的公共应用（SDI卡驱动、bmsnetworkconfig网络配置程序、Cloudinit初始化工具等）。请根据您的实际需要自助配置应用环境或相关软件。 私有镜像 用户基于外部镜像文件或物理机服务器创建的个人镜像，仅用户自己可见。包含操作系统、预装的公共应用以及用户的私有应用。选择私有镜像创建物理机服务器，可以节省您重复配置物理机服务器的时间。 共享镜像 您将接受公有云其他用户共享的私有镜像，作为自己的镜像进行使用。 8. 选择“许可类型”。 在云平台上使用操作系统或软件的许可证类型。如果您选择的镜像为免费的，则系统不会展示该参数。如果您选择的镜像为计费镜像，此时系统会展示该参数。 使用平台许可证 使用云平台提供的许可证，申请许可证需要支付一定的费用。 使用自带许可证（BYOL） 使用用户已有操作系统的许可证，无需重新申请。 9. 设置“磁盘”。 根据磁盘使用的存储资源是否独享，磁盘划分为“云硬盘”、“专属存储”。其中，专属存储是为您提供的独享存储资源。 如果您在专属存储服务页面申请了存储池，可以选择“专属存储”页签，在已申请的存储池中创建磁盘。 如果未申请独享的存储池，请选择“云硬盘”页签，创建的磁盘使用公共存储资源。 说明 使用专属存储资源创建磁盘时，待创建磁盘的磁盘类型需和申请的存储池资源类型保持一致，如都是“高IO”类型。 磁盘包括系统盘和数据盘。您可以为物理机服务器添加多块数据盘，系统盘大小可以根据需要自定义。 系统盘 如果选择支持快速发放的规格，界面会提供系统盘配置项，可以根据需要设置磁盘类型和大小。 数据盘 您可以为物理机服务器添加多块数据盘，并设置数据盘的共享功能。 1. 物理机服务器仅支持SCSI磁盘模式。 2. 共享盘：勾选后，数据盘为共享云硬盘。该共享盘可以同时挂载给多台物理机服务器使用。 3. 设置网络信息，包括“虚拟私有云”、“网卡”、“安全组”等信息。 第一次使用云服务时，系统将自动为您创建一个默认的虚拟私有云，包括安全组、网卡。其中，默认虚拟私有云支持的地址范围为192.168.1.0/24，子网网关为192.168.1.1，并为子网开启DHCP功能。 表 网络参数说明 参数 解释 :: 虚拟私有云 您可以选择使用已有的虚拟私有云，或者单击“新建虚拟私有云”创建新的虚拟私有云。 网卡 包括主网卡和扩展网卡。您可以添加一张扩展网卡，并指定网卡（包括主网卡）的IP地址。 须知 主网卡用于系统的默认路由，不允许删除。 如果您选择自动分配IP地址，请不要在物理机服务器发放完成后修改私有IP地址，避免和其他物理机服务器IP冲突。 为网卡分配固定IP地址后，不能批量创建物理机服务器。 高速网卡 物理机服务器之间的高速互联网络接口，为物理机服务器提供更高的带宽。 同一台物理机服务器的多张高速网卡不能选择同一个高速网络。 安全组 安全组用来实现安全组内和安全组间物理机服务器的访问控制，加强物理机服务器的安全保护。用户可以在安全组中定义各种访问规则，当物理机服务器加入该安全组后，即受到这些访问规则的保护。 创建物理机服务器时，仅支持选择一个安全组。但是物理机服务器创建成功后，可以为物理机服务器关联多个安全组，配置方法请参见更改安全组。 说明 物理机服务器初始化需要确保安全组出方向规则至少满足如下要求： 协议：TCP 端口范围：80 远端地址：169.254.0.0/16 如果您使用的是默认安全组出方向规则，则已经包括了如上要求，可以正常初始化。默认安全组出方向规则为： 协议：Any 端口范围：Any 远端地址：0.0.0.0/16 弹性公网IP 弹性公网IP是指将公网IP地址和路由网络中关联的物理机服务器绑定，以实现虚拟私有云内的物理机服务器通过固定的公网IP地址对外提供访问服务。 您可以根据实际情况选择以下三种方式： 不使用：物理机服务器不能与外部网络互通，仅可以在私有网络中部署业务或构建集群。 自动分配：自动为物理机服务器分配独享带宽的弹性公网IP，带宽值由您设定。 使用已有：为物理机服务器分配已有弹性公网IP。 说明 选择已有弹性公网IP后，不能批量创建物理机服务器 规格 弹性公网IP选择“自动分配”时，需配置该参数。 全动态BGP：可根据设定的寻路协议第一时间自动优化网络结构，以保持客户使用的网络持续稳定、高效。 静态BGP：网络结构发生变化时，运营商无法实时自动调整网络设置以保障用户体验。 计费方式 弹性公网IP选择“自动分配”时，需配置该参数。 按带宽计费：指定带宽上限，按使用时间计费，与使用的流量无关。 按流量计费：按照实际使用的流量来计费。 带宽 弹性公网IP选择“自动分配”时，需配置该参数。 带宽大小，单位Mbit/s。 11. 设置物理机服务器登录方式。 “密钥对”方式创建的物理机服务器安全性更高，建议选择“密钥对”方式。如果您习惯使用“密码”方式，请增强密码的复杂度，如表所示，保证密码符合要求，防止被恶意攻击。 密钥对 指使用密钥对作为登录物理机服务器的鉴权方式。您可以选择使用已有的密钥，或者单击“新建密钥对”创建新的密钥。 说明 如果选择使用已有的密钥，请确保您已在本地获取该文件，否则，将影响您正常登录物理机服务器。 密码 指使用设置初始密码方式作为物理机服务器的鉴权方式，此时，您可以通过用户名密码方式登录物理机服务器。 Linux操作系统时为root用户的初始密码，Windows操作系统时为Administrator用户的初始密码。密码复杂度需满足表要求。 参数 规则 样例 ::: 密码 密码长度范围为8到26位。 密码至少包含以下4种字符中的3种： 大写字母 小写字母 数字 特殊字符，包括!@$%^+[]{}:,./? 密码不能包含用户名或用户名的逆序。 Windows系统的物理机服务器，不能包含用户名中超过两个连续字符的部分。 Test12$@ 12.（可选）高级配置。 如需使用“高级配置”中的功能，请单击“现在配置”。否则，请单击“暂不配置”。 用户数据注入：主要用于创建物理机服务器时向物理机服务器注入用户数据。配置用户数据注入后，物理机服务器首次启动时会自行注入数据信息。 只有选择“密钥对”登录方式才显示此配置项。用户数据注入的详细操作请参见用户数据注入。 委托 委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为物理机服务器提供访问云服务的临时凭证。 如果您在IAM上创建了委托，可以通过单击下拉列表选择委托名称，获取相应权限。目前，使用委托的场景为主机监控，更多信息请参见安装配置Agent。 13. 设置“物理机服务器名称”。 名称可自定义，但需符合命名规则：只能由中文字符、英文字母、数字及“”、“”、“.”组成。 一次创建多台物理机服务器，系统会自动按序增加后缀。例如：输入bms，服务器名称为bms0001，bms0002，……。再次创建多台服务器时，命名从上次最大值连续增加，例如：输入bms，已有服务器bms0010，新创服务器名称为bms0011、bms0012、……，命名达到9999时，从0001开始。 14. 设置您创建的物理机服务器数量，最多为24台。 设置完成后，您可以通过单击“价格计算器”，查询当前配置的费用。 说明 当配额充足时，一次最多可以创建24台物理机服务器；若配额不足24台，一次最多可创建数量为配额余量。 在设置网络信息时，若您选择自定义网卡或高速网卡的IP地址，或者选择已有弹性公网IP，则一次只能创建一台物理机服务器。 15. 单击“立即申请”。 16. 在确认规格页面，单击“提交”。 大约需要30分钟，物理机服务器的状态会变为“运行中”。选择支持快速发放的规格，大约只需5分钟即可获得一台物理机服务器。 说明 您可以随时查看物理机服务器的创建状态，具体操作请参见查看创建状态。

参数名 说明 源站类型 可选择IP或域名/媒体存储源站 源站 即源站地址，支持IP或域名。 层级 支持主或备。 权重 即回该源站的权重值。 指定源站回源HOST 回源HOST决定了回源请求访问到源站的哪个站点。当不同源站使用不同回源HOST时，需通过“指定源站回源HOST”进行设定。 操作 可删除源站配置。

项目 描述 语法 value, flags DICT:get(keyname) 作用 在全局字典ctyun.dict.DICT中设置一个键值对。获取指定key对应的value，value的数据类型与存储时的原始数据类型一致，但如果key不存在或过期就返回nil。 入参 keyname：要获取内容的键值。 返回值 value: key对应的value。 flags: 用来获取是否对用户做了标识，一般在set时都会加入标识，如果没有，则默认为0。