名称 位置 类型 必选 说明 prodInstId body Long 是 实例id machineId body Long 是 机器资源唯一标识 storePath body String 是 存储位置 retain body Integer 是 备份保留份数，0表示全部清除，最大保留份数为7，即取值范围07 autoBackup body Integer 是 自动备份开关，0表示关闭，1表示打开 weekdays body List 是 自动备份的日期列表 autoBackupTime body String 是 自动备份时间

配置取数逻辑 “取数方式”选择“配置方式”： 1.选择数据源、数据连接、数据库和数据表，获取到需要配置的表。 说明 数据服务仅支持部分数据源，详情请参见 DataArts Studio支持的数据源。您需提前在DataArts Studio管理中心中配置好数据源，数据表支持表名搜索。 2.配置参数字段 选择好数据表之后，单击“参数设置”后的“添加”，添加参数页面自动列出这个表的所有字段，分别勾选需要设置为请求参数、返回参数和排序参数的字段，分别添加到请求参数、返回参数和排序参数列表当中。 添加参数 3.编辑请求参数信息 请求参数主要分为三部分，绑定参数、绑定字段、操作符。在请求参数列表中，需要设置绑定参数和操作符。 绑定参数对外开放，是用户访问API时，直接使用的参数。 绑定字段对外不可见，是API调用时，实际访问的内容。 操作符则是用户访问时，对参数的的处理方式。当前支持的操作符及含义如下： 支持的操作符 操作符 描述 检查两个操作数的值是否相等，如果相等则条件为真。 <> 检查两个操作数的值是否相等，如果不相等则条件为真。 > 检查左操作数的值是否大于右操作数的值，如果是则条件为真。 > 检查左操作数的值是否大于等于右操作数的值，如果是则条件为真。 < 检查左操作数的值是否小于右操作数的值，如果是则条件为真。 < 检查左操作数的值是否小于等于右操作数的值，如果是则条件为真。 %like% %like%表示忽略前后缀，进行字符匹配。 %like %like表示忽略前缀，进行字符匹配。 like% like%表示忽略后缀，进行字符匹配。 in in运算符用于把某个值与一系列指定列表的值进行比较。 not in in运算符的对立面，用于把某个值与不在一系列指定列表的值进行比较。 4.编辑返回参数信息 在返回参数列表中，设置参数的名称、参数类型、示例值和描述。 返回参数主要分为三部分，参数名、绑定字段、参数类型。参数名对外开放，是API返回时，最终展示给用户的参数名称；绑定字段对外不可见，是API调用时，实际返回的内容；参数类型则是API调用时，数据的呈现格式，分为数值型和字符型两类。 5.编辑排序参数信息 在排序参数列表中，设置排序字段是否可选，排序方式和描述。 排序参数主要分为四部分，参数名、字段名称、是否可选以及排序方式。参数名对外开放，是API返回时，最终展示给用户的参数名称；字段名称对外不可见，是API调用时，实际访问的内容；是否可选决定了当前排序条件是否允许移除，勾选则表示可以不使用此参数；排序方式分为升序、降序以及自定义，表示了当前参数允许使用的排序形式。 通过排序参数列表中的操作列的向上、向下和删除按钮，可调整排序参数的顺序或者删除某排序参数。 6.单击“下一步”，设置preorderby的值为所有排序参数的描述，以“英文分号”进行分隔。 以如下样例数据为例进行说明： 排序字段对应的参数描述 排序字段 对应的排序参数描述 id a:asc 其中，a是参数名，asc代表升序。 name b:asc b b:desc 其中，b是参数名，因为排序方式是自定义，所以有如上三种参数描述。 age c:desc 其中，c是参数名，desc代表降序。 依据上表，分析得出各个字段对应的排序参数描述，则preorderby的设置方式有如下几种情况，包含所有排序参数的描述。 配置preorderby preorderby 对应的后端order by语句 备注 a:asc;b;c:desc order by id ASC, name, age DESC b;c:desc order by name, age DESC 因a是可选排序字段，所以可以不填。 b:asc;c:desc order by name ASC; age DESC b排序方式是自定义，排序时可选择升序。 b:desc;c:desc order by name DESC; age DESC b排序方式是自定义，排序时可选择降序。 配置排序参数值 说明 preorderby是非必填参数，当未配置preorderby参数值时，则选取非可选排序字段作为排序的依据。 当配置preorderby参数值时，配置类API需严格按照排序参数顺序进行设置。例如 a:asc;b;c:desc ，可行。当设置为b;a:asc;c:desc，则报错。

本页介绍天翼云TeleDB数据库语句行为相关参数。 searchpath (string) 这个变量指定当一个对象（表、数据类型、函数等）被用一个无模式限定的简单名称引用时，用于进行搜索该对象的模式顺序。当在不同模式中有同名对象时，将使用第一个在搜索路径中被找到的对象。一个不属于搜索路径中任何一个模式的对象只能通过用限定名（带点号）指定包含它的模式来引用。searchpath的值必需是一个逗号分隔的模式名列表。任何不是一个已有模式的名称，或者是一个用户不具有USAGE权限的模式，将被安静地忽略。如果列表项之一是特殊名user，则具有SESSIONUSER返回的名字的模式将取代它（如果有这样一个模式并且该用户有该模式的USAGE权限；如果没有，user会被忽略）。系统目录模式pgcatalog总是被搜索，不管它是否在搜索路径中被提及。如果它在路径中被提及，那么它将被按照路径指定的顺序搜索。如果pgcatalog不在路径中，则它将在任何路径项之前 被搜索。同样，当前会话的临时表模式pgtempnnn也总是被搜索（如果存在）。它可以在路径中通过使用别名pgtemp显式列出。如果在路径中没有列出，那么会首先对它进行搜索（甚至是在pgcatalog之前）。然而，临时模式只被用来搜索关系（表、视图、序列等）和数据类型名。它从不用于搜索函数或操作符名。当对象创建时没有指定一个特定目标模式，它们将被放置在searchpath中第一个合法模式中。如果搜索路径为空将报告一个错误。这个参数的缺省值是"$user", public。这种设置支持一个数据库（其中没有用户拥有私有模式，并且所有人共享使用public）、每个用户私有模式及其组合的共享使用。其它效果可以通过全局或者针对每个用户修改默认搜索路径设置获得。搜索路径的当前有效值可以通过SQL函数currentschemas检查。它和检查searchpath的值不太一样，因为currentschemas显示出现在searchpath中的项如何被解析。

服务内容 服务描述 交付物 现状调研 业务现状、业务架构、客户目标调研 健康检查 检查业务网络架构、弹性计算架构、存储架构、数据库架构、中间件架构、安全架构的健康情况 优化建议 依据健康检查结果，给出优化建议 优化方案 技术支持 在交付期内，为优化方案落地提供技术支持

本节介绍了通过脚本批量更新一键式重置密码插件(Windows系统)的操作场景、前提条件、约束与限制、操作步骤等内容。 操作场景 当您需要对多台Windows系统的云主机批量更新一键式重置密码插件时，可参考本文档操作。 前提条件 登录已准备好的执行机，执行机需满足的条件请参见下文约束与限制。 需要提前准备待批量安装插件的云主机的IP地址、Administrator用户的密码信息。 执行机应该与待更新机器在同一VPC下。 在执行完步骤7之后可以解绑eip。 约束与限制 需要选取一台操作系统为CentOS 8.2（公共镜像）且已绑定弹性公网IP的云主机作为执行机，且与待批量安装插件的弹性云主机之间网络需要互通。 说明 若已配置yum内部源，可不需要绑定弹性公网IP。 操作步骤 1.执行以下命令，安装批量脚本运行所需要的依赖。 yum install epelrelease y yum install ansible y skipbroken 执行ansible version命令检查ansible是否安装成功 说明 如果因为yum源配置问题导致无法安装ansible，可以使用如下命令安装ansible： yum install python3 python3pip pip3 install upgrade pip pip3 install ansible python3.6 m pip install bcrypt3.2.0 paramiko3.3.1 cryptography3.3.0 pywinrm PyYAML Jinja2 httplib2 six 若出现如下图所示报错信息，请执行以下操作。 执行以下命令，安装依赖： dnf install python3devel 然后再次执行以下命令： python3.6 m pip install bcrypt3.2.0 paramiko3.3.1 cryptography3.3.0 pywinrm PyYAML Jinja2 httplib2 six 图 报错信息 2.请参考获取并校验一键式重置密码插件完整性（Windows），下载对应的一键式重置密码插件CloudResetPwdAgent.zip并完成完整性校验。 安装一键式重置密码插件对插件的具体放置目录无特殊要求，请您自定义。 3.执行以下命令，将对应OS架构的Windows版本的安装包下载到root目录下： 32位操作系统，x86架构： wget 'nocheckcertificate' 64位操作系统，x86架构： wget 'nocheckcertificate' 64位操作系统，ARM架构： wget 'nocheckcertificate' 4.执行以下命令，将批量操作脚本下载到root目录下。 curl URL > ~/batchupdatelog4jversionforwindows.py 其中，URL为批量操作的执行脚本。 选择脚本下载地址： 5.执行以下命令，将更新插件脚本下载到root目录下。 curl URL > ~/updatelog4jversionforresetpwdagentwindows.bat 其中，URL为更新插件脚本的下载地址。 脚本下载地址： 6.检查如下文件是否在root目录下。 batchupdatelog4jversionforwindows.py updatelog4jversionforresetpwdagentwindows.bat CloudResetPwdAgent.zip 7z.exe 7.执行以下命令，新建并编辑hostlist.txt，按i进入编辑模式。 vi hostlist.txt 将需要自动安装驱动的云主机的相关信息填写到hostlist.txt文件中。 填写Administrator用户的IP和密码，请严格按照每行“IP,用户密码”的格式填写，中间以英文逗号隔开。 示例： 192.168.1.10,'' 192.168.1.11,'' 8.执行以下命令，添加ansible配置文件。 mkdir p /etc/ansible touch /etc/ansible/ansible.cfg 运行批量执行操作脚本“batchupdatelog4jversionforwindows.py”。 python3.6 batchupdatelog4jversionforwindows.py 图 运行脚本 9.执行如下命令，在“/root/logs/execorigin.log”的最后一行查看运行结果日志。 vim /root/logs/execorigin.log 若如下图所示，则表示运行成功。 图 运行成功

全局索引是一组非分片键和分片键的映射关系，通过非分片键查询到分片键，直接计算出数据所在的分片节点，从而提升非分片键查询（select语句）时的效率，避免广播查询。本文对分布式关系数据库DRDS全局索引功能进行说明。 核心特性 全局索引的核心特性说明如下： 增量索引追加 解析binlog数据，提取非分片键和分片键的映射关系。 支持全量索引重建 通过JDBC从数据库中获取全量数据。 以单索引单分片为最小任务单元分配重建任务。 索引存储 索引数据以keyvalue方式存储在分布式缓存中。 索引配置 索引项相关的配置与DRDS实例共用，配置修改实时同步。 库表信息变更自动同步更新。 索引延时 正常情况下，索引与数据库延时在秒级以内。 注意事项 DRDS实例版本不同全局索引的管理入口可能存在差异，具体版本说明如下，请以控制台实际情况为准： V5.1.20.0.13及以后版本：Giserver与DBProxy合并部署，不再区分DBProxy和Giserver两种实例，即购买DRDS实例时，将自动为该实例部署Giserver与DBProxy，且两者之间底层服务与进程互相隔离、故障互相隔离，更具安全性和性价比。 说明 您可以在控制台的左侧导航栏选择DRDS > 实例管理 ，进入实例列表页面，再单击目标DRDS实例操作 列的管理 ，进入实例基本信息 页面，然后单击目录树的全局索引，管理您的GiServer。 V5.1.20.0.13以前的版本：存在DBProxy和Giserver两种实例，存量GiServer实例不影响使用。 说明 您可以在控制台的左侧导航栏选择DRDS > 全局索引，进入全局索引管理页面，管理您的GiSever实例。

状态 描述信息 创建中 创建开发机的配置信息 已创建 开发机任务已提交 运行中 开发机已创建完成并正常运行，需等到“访问”按钮可点击后能远程访问 停止 开发机已停止，停止实例后未保存到持久化存储中的数据将丢失

本节介绍了删除警报的相关内容。 操作场景 使用存储过程删除警报。 前提条件 成功连接RDS for SQL Server实例。通过SQL Server客户端连接目标实例。 操作步骤 行以下命令，删除警报。 EXEC [msdb].[dbo].[rdsdeletealert] @name'name'; 表 参数说明 参数 说明 'name' 警报的名称。 取值的数据类型是sysname，无默认值。 执行成功后，系统将会如下提示： plaintext Commands completed successfully. 示例 EXEC [msdb].[dbo].[rdsdeletealert] @name'test'; 回显如下所示：

参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 String 接口状态码，返回状态，返回 0 表示成功，返回错误代码参考下面的错误代码列表 0 message 是 String 如果statusCode 为 0，返回 success；如果statusCode 非 0，返回 error success returnObj 是 Object 返回的人脸检测结果对象 returnObj

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 alarmRuleIDList Array of Strings 告警规则ID ['83bd75379e065a45a3b5f4b13a7e81ea'] 枚举参数 无 请求示例 请求url /v4/monitor/createeventalarmrule 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "name": "ctyunrule", "desc": "描述", "resources": [ { "resource": [ { "name": "uuid", "value": "7dd744ea5a0261d3e62738f82f5fd3e1" }, { "name": "instancename", "value": "ecmaf97" } ] } ], "conditions": [ { "eventName": "migrationeventstart", "value": "15", "period": "1h" } ] }

接口功能介绍 删除密钥别名 接口约束 请保证账户余额大于0 URI POST /v1/keyName/deleteAlias 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 aliasName 是 String 密钥别名 ECS 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 用戶删除别名成功 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "200000001852" } 请求体body { "aliasName": "tdesdtali1adddddadcccdsasdas" } 响应示例 { "statusCode": "200", "message": "刪除别名成功" } 状态码 请参考 状态码 错误码 请参考 错误码

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 taskID String 数据导出任务ID TASKtacd8b6b4610b97d202306301808 枚举参数 无 请求示例 请求url /v4/monitor/taskcenter/createtask 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "task": { "name": "数据导出任务A", "description": "用于导出云主机7月份历史数据", "service": "ecs", "dimension": "ecs", "dimensions":[ { "name":"uuid", "value":[ "000f03221f4d8cc8bb2e1c30fb751aa5" ] } ], "itemNameList": ["cpuutil","memutil"], "aggregateType": ["avg"], "startTime": 1692812541, "endTime": 1692842541, "period": 3600, "reportTemplate": 0 } }

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数，参考returnObj对象结构 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 templateID String 告警模板ID 312b56b43e4311ed8ef2005056898fe0 请求示例 POST /v4/monitor/createalramtemplate 请求体body json { "content":{ "name":"xsZSu", "ser":"ecs", "dim":"ecs", "desc":"test", "rules":[ { "metric":"cpuutil", "fun":"avg", "value":"100", "operator":"eq", "for":120, "period":"5m", "level":3 }, { "metric":"cpuutil", "fun":"avg", "value":"70", "operator":"eq", "for":120, "period":"5m", "level":2 } ] } } 响应示例 json { "statusCode":800, "returnObj":{ "templateID":"312b56b43e4311ed8ef2005056898fe0" }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数，参考returnObj对象结构 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 templateID String 告警模板ID 312b56b43e4311ed8ef2005056898fe0 请求示例 POST /v4/monitor/updatealramtemplate 请求体body json { "templateID":"312b56b43e4311ed8ef2005056898fe0", "content":{ "name":"xsZSu", "ser":"ecs", "dim":"ecs", "desc":"test", "rules":[ { "metric":"cpuutil", "fun":"avg", "value":"100", "operator":"eq", "for":120, "period":"5m", "level":3 }, { "metric":"cpuutil", "fun":"avg", "value":"60", "operator":"eq", "for":120, "period":"5m", "level":1 } ] } } 响应示例 json { "statusCode":800, "returnObj":{ "templateID":"312b56b43e4311ed8ef2005056898fe0" }, "errorCode":"", "message":"Success", "msgDesc":"成功" }

接口功能介绍 调用此接口可查看探测节点的配置详情。 接口约束 资源池ID，探测节点名称不能为空。 URI GET /v4/monitor/describeprobepoint 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID name String 是 NeiMeng 探测节点名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 mongoID String 数据库ID 635a4a3869bdc841ab0495dd ID String 探测节点唯一ID 1 name String 探测节点名称 NeiMeng hermesRegion String region名称 neimengaz03 position String 探测节点区域 内蒙 status Boolean 探测节点是否可用 true

接口功能介绍 调用此接口可修改告警联系人配置。 接口约束 告警联系人ID存在，告警联系人名称不可重复，可包含字母、中文、数字，230个字符。 URI POST /v4/monitor/updatecontacts 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 contactID String 是 a6fb570f22995bde989cdf0819c687d0 告警联系人ID name String 是 moCEN 用户名 phone String 否 13309310049 手机号 email String 否 123323@qq.com 邮箱 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 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 参数 参数类型 说明 示例 下级对象 alarmBlacklistID String 告警黑名单ID "46d7bc837ac45238a9342076d0b9f9f0" 请求示例 请求url /v4/monitor/createalarmblacklist 请求头header 无 请求体body json { "name": "测试黑名单725", "desc": "testdesc", "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "devices": ["xxxaadasd", "asdasdasgfasd"], "metrics": ["cpuutil", "memutil"], "startTime": 1687337384, "endTime": 1687338884, "contactGroupList": ["234bee0616f65b0aadb8c0903d480a58"] } 响应示例 json { "statusCode": 800, "returnObj": { "alarmBlacklistID": "5a592d2f48695667a088b9d54336c166" }, "errorCode": "", "message": "Success", "msgDesc":"成功" }

响应参数 参数 参数类型 说明 示例 下级对象 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/updatealarmblacklist 请求头header 无 请求体body json { "blacklistID": "46d7bc837ac45238a9342076d0b9f9f0", "name": "测试黑名单725", "desc": "testdesc", "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "devices": ["xxxaadasd", "asdasdasgfasd"], "metrics": ["cpuutil", "memutil"], "startTime": 1687337384, "endTime": 1687338884, "contactGroupList": ["234bee0616f65b0aadb8c0903d480a58"] } 响应示例 json { "statusCode": 800, "returnObj": { "success":true }, "errorCode": "", "message": "Success", "msgDesc":"成功" }

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否更新成功 true 请求示例 请求url /v4/monitor/monitorboard/updateview 请求头header 无 请求体body json { "regionID": "1234567890", "viewID": "58631437d4897105d9ac9bc044d7b6ab", "view": { "name": "视图1", "service": "ecs", "dimension": "ecs", "viewType": "timeSeries", "itemNameList": [ "cpuutil" ], "compares": [ ], "resources": [ { "resource": [ { "key": "uuid", "value": "3280eb61b0c434135bb2a2b0d79a6870" } ] } ] } } 响应示例 json { "statusCode": 800, "returnObj": { "success": true }, "errorCode": "", "message": "Success", "msgDesc": "成功", "description": "成功" }

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 alarmRuleID String 告警规则ID '83bd75379e065a45a3b5f4b13a7e81ea' 请求示例 请求url /v4/monitor/createcustomeventalarmrule 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "name": "自定义告警规则测试", "desc": "test", "repeatTimes": 0, "silenceTime": 300, "recoverNotify": 0, "notifyType": ["email"], "contactGroupList": ["000f03221f4d8cc8bb2e1c30fb751ccc"], "notifyWeekdays": [0, 1, 2, 3, 4, 5, 6], "notifyStart": "00:00:00", "notifyEnd": "23:59:59", "webhookUrl": [" "customEventID": "Event63cb8954325480a320230707180", "value": "3", "period": "5m" }

接口功能介绍 删除Ukey证书 接口约束 无 URI POST /v1/manageCertificate/deleteCertificateForUk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "certificateId": "4b8e0a87cfb5457da6e62eb6303f579d" } 响应示例 plaintext { "statusCode": 200, "message": "uk证书删除成功", "returnObj": { } } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 删除标签接口 接口约束 无 URI POST /v1/lebalControl/deleteLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 labelId 是 String 标签标识 123123 key 是 String key值 123 value 是 String value值 123 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "labelId" : "123123", "key": "123", "value":"123" } 响应示例 plaintext { "statusCode": 200, "message": "删除标签成功", "returnObj": null } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 修改标签接口 接口约束 无 URI POST /v1/lebalControl/updateLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 labelId 是 String 标签标识 123123 key 是 String key值 123 value 是 String value值 123 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "labelId": "123123", "key": "123", "value":"123" } 响应示例 plaintext { "statusCode": 200, "message": "标签修改成功", "returnObj": null } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 删除一个应用接入点 接口约束 无 URI POST /v1/applicationAccessPointManage/deleteApplicationAccessPoint 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 应用接入点id 8c9107b652304f3384338a4c2a568454 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "applicationId": "8c9107b652304f3384338a4c2a568454" } 响应示例 plaintext { "statusCode": 200, "message": "删除vpce成功" } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 关闭接入点的权限控制 接口约束 无 URI POST /v1/applicationAccessPointManage/closePolicyCheck 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "applicationId": "b2160c2c9c704ca9b8080d186c97280d" } 响应示例 plaintext { "statusCode": 200, "message": "关闭接入点权限控制成功", } 状态码 请参考状态码章节 错误码 请参考错误码章节

指标名称 指标说明 数据盘使用量 该指标用于统计测量对象的节点的数据磁盘使用值，该值为实时值。 数据盘使用率 该指标用于统计测量对象的节点的数据磁盘使用率，该值为实时值。 xlog大小 该指标用于统计CN和DN数据目录下xlog大小，该值为实时值。

本节主要介绍步骤四：对比同步项 对比实时同步项可以清晰反馈出源数据库和目标数据库的数据是否存在差异。为了尽可能减少业务的影响和业务中断时间，实时同步场景提供了对象级对比和数据级对比功能，帮助您确定合适的业务割接时机。 对象级对比：支持对数据库、索引、表、视图、表的排序规则等对象进行对比。 数据级对比：支持对表的行数和内容进行对比。 说明 全量同步中的任务无法进行数据级对比。 如果单独对目标库进行数据修改操作，有可能数据检验不准确。 前提条件 已登录数据库复制服务控制台。 操作步骤 1、在“实时同步管理”界面，选中指定同步任务，单击任务名称，进入“基本信息”页签。 2、单击“同步对比”页签，进入“同步对比”信息页面。 3、对比同步项。 创建对象级对比：选择“对象级对比”页签，单击“开始对比”后稍等一段时间再单击，观察源数据库和目标数据库的各个对比项结果是否一致。若需要查看结果详情，可单击指定对比项操作列的“详情”按钮。 图 同步对象对比 创建数据级对比：选择“数据级对比”页签，单击“创建对比任务”，选择“对比类型”、“对比方式”、“对比时间”和“对象选择”，单击“是”提交对比任务。 图 创建数据对比任务 对比类型：分为行数对比和内容对比。 行数对比：用于对比源和目标端的表的行数是否相等。 说明 任务进入增量阶段后，用户可以创建行对比任务。 Oracle>GaussDB(for openGauss)同步任务，当全量任务结束的时候会自动触发行对比任务。 内容对比：用于对比源和目标端的表的数据是否一致。 说明 任务进入增量阶段后，用户可以创建内容对比任务。全量同步完成后，源库数据不能发生变更，否则内容对比结果会不一致。 由于内容对比功能目前只支持带有单字段主键或单字段唯一索引的表，不支持内容对比的表可以使用行数对比功能。所以数据级对比功能需要结合业务场景，选用行数对比或者内容对比。 对比方式：分为静态对比和动态对比两种。 静态对比：对源数据库和目标数据库进行一次全量内容对比，内容对比完成后对比任务结束，适用于无数据变化的非业务时间。 动态对比：先对源数据库和目标数据库进行一次全量内容对比，对比任务完成后进入增量对比阶段，实时比对源数据库和目标数据库的增量数据，适用于有数据变化的业务时间。 说明 目前仅MySQL引擎支持对比方式选择。 对比时间：可设置为“立即启动”和“稍后启动”。由于同步具有轻微的时差，在数据持续操作过程中进行对比任务，可能会出现符合实际情况的少量数据不一致对比结果，推荐结合对比定时功能，选择在业务低峰期进行对比，得到更为具有参考性的对比结果。 对象选择：可根据具体的业务场景选择需要进行对比的对象。 4、对比任务提交成功后，返回“数据级对比”页签，单击刷新列表，可以查看到所选对比类型的对比结果。 图 同步数据对比 由于内容对比功能目前只支持带有单字段主键或单字段唯一索引的表，不支持内容对比的表可以使用行数对比功能。所以数据级对比功能需要结合业务场景，选用行数对比或者内容对比。 若需要查看行数对比或者内容对比详情，可单击指定对比类型操作列的“查看对比报表”，页面将跳转至新的窗口，可观察对比结果的详细情况。 图 数据级对比详情 说明 已取消的对比任务也支持查看对比报表。

接口功能介绍 添加接入点的终端节点白名单 接口约束 无 URI POST /v1/userEndpointControl/addEndpointWhitelist 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id bac519a74a774c78850780e1eda40c78 endpointId 是 String 终端节点id endpointwlp72qh2bd ips 是 Array of Strings ip白名单集合 ["1.1.1.1"] enableWhitelist 是 Boolean 是否开启 true 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 requestId String 请求ID 1d6d65ac761d4276ad0f1b94ef2ea29d 枚举参数 无

接口功能介绍 启用租户ak 接口约束 无 URI POST /v1/userAkControl/enableUserAk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 userAk 是 String 租户ak 02baad12e63c471c85400df031e18520 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "userAk": "02baad12e63c471c85400df031e18520" } 响应示例 plaintext { "statusCode": 200, "message": "启用用户ak成功" } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 删除租户ak 接口约束 无 URI POST /v1/userAkControl/deleteUserAk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 userAk 是 String 租户ak 02baad12e63c471c85400df031e18520 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "userAk": "02baad12e63c471c85400df031e18520" } 响应示例 plaintext { "statusCode": 200, "message": "删除用户ak成功" } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 禁用租户ak 接口约束 无 URI POST /v1/userAkControl/disableUserAk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 userAk 是 String 租户ak 02baad12e63c471c85400df031e18520 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "userAk": "02baad12e63c471c85400df031e18520" } 响应示例 plaintext { "statusCode": 200, "message": "禁用用户ak成功" } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 新增子账号 接口约束 无 URI POST /v3/subManager/create 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 orgOid 是 String 部门ID email 是 String 邮箱地址 userAccount 是 String 子账号登录账号。 1.长度至少为6位，最多24位; 2.仅支持字母、数字和字符.。 password 是 String 用户账号密码。激活方式为管理员激活时，必填。字符数限制：[8,26]。 必须至少包含大小写英文字母、数字和特殊符号三类字符，特殊字符集合：~!@ $%^&()+{[]} ;:,.'?/<>。 密码不能包含与账号相关的信息，不建议包含账号完整字符串、大小写变为或形似变换的字符串。 密码不能使用3个及以上键盘连续相邻字符，如123，Qwe等。 注意：如果传入password参数，建议您使用HTTPS协议发送请求，避免密码泄露。 remark 否 String 子账号备注信息 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj