华为云用户手册

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-Auth-Token string True 软件云侧用户access-token值 请求参数 序号 名称 参数类型 是否必选 说明 1 limit int True 每页查询数 小于100 2 offset int True 偏移量 从0开始 3 startDate long false 开始订购时间 时间戳 4 endDate long false 结束订购时间 时间戳

消息样例 场景描述：软件云调用接口查询订购信息 URL：/rest/oma/softwareconsole/tenant/queryresource 请求头: { "X-Auth_Token":"0000000000srLl4pnoBc*************9DvgIB87KzYpxMdE9+vvzLZqYIw=" } 请求体： { "limit":"10", "offset":"0", "startDate":1679558854000, "endDate":1679558854001 } 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8" } 响应体： { "result": [{ "orderId": "251679538126441114", "opType": "newInstance", "remark": null, "skuName": "电销型座席", "modifyTime": 1679558854000, "orderAmount": "36000", "procutName": "包月", "vdnId": "131", "customerId": "20220727032236821699", "company": "ttttttttttttt", "id": "1638814724192780290", "manualStatus": "0", "cecTenantId": "202303232614", "amount": "1", "periodNumber": "2", "productId": "0GbV000000wG80TFeSlU", "autoStatus": "2", "customerName": "zhangsan", "cecExpireTime": 1684829253000, "cecTenantName": "Tenant07323220", "createSource": "GTS", "periodType": "month", "expireTime": 1684722289000, "createTime": 1679558853000, "skuCode": "d52b28fa-e0a7-a8f7-8356-0f0aea54b862" }], "count": 1, "returnCode": "0", "description": "success" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 id string 20 True 任务id 2 creatorId string 20 True 操作处理人id 3 status string 128 True 任务状态 dataType : SingleSelect 枚举值： Completed Pending Processing

消息样例 场景描述：修改任务状态 URL：https://域名/service/AICC__Case/1.0.0/openapi/task/status/update 请求头: { "Content-Type": "application/json"， "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： { "id": "ccqG0000014iXvGKONQO", "status": "Processing", "creatorId": "10gg00000148QvgpaLAm" } 响应头： { "connection": "keep-alive"， "Content-Length": "16"， "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： {"resCode": "0","resMsg": "成功"}

快速入门 当前工单系统已停止更新维护，请使用最新工单2.0系统。工单2.0操作文档可参考Case2.0操作指南。 通过2个任务，带您快速了解客户服务云的配置和功能。 客户服务云是面向未来数字化、智能化的客户服务云。 提供一站式客户服务解决方案，帮助企业快速建立自己的客户接触中心，让服务无处不在。 通过客户服务云，企业的客户可以从网站、移动终端、社交媒体等多种渠道接入人工服务获取最佳的服务体验。 为使您的体验更顺畅，请使用Chrome浏览器或Internet Explorer 11浏览和操作。 现在开始您的客户服务云体验之旅吧。 快速配置工单 处理您的第一张工单 父主题： Case操作指南（老版本）

操作步骤 添加领域。 参见添加实体添加两个实体：医生、科室。 图1 添加医生实体界面 图2 添加科室实体界面 添加挂号意图。 单击进入新创建的领域，单击“新增”，选择“一般意图”。 填写意图的名称，例如“挂号”。 在“上下文”页签，单击“输入上下文”后的“新增”，可以添加当前意图的上下文，此示例不添加上下文。 上下文指多轮对话时，机器人根据该值将多组语句当做同一轮次的对话处理。当需要使用指定的意图模板时，可通过上下文配置的字符串进行定位。 在“语料”页签，单击“新增”，添加语料。 分析客户可能回答，并将这些回答添加到语料中去，例如，客户可能回答我要挂一个明天下午16:00李医生的内科，则双击文本框输入“我要挂一个明天下午16:00李医生的内科”，然后鼠标左键选择“明天下午”，在弹出的菜单中选择“@system.date”，选择“16:00”，在弹出的菜单中选择“@system.time”。 如何标记槽位？ 在语料输入完毕后，按回车，即可实现槽位自动标记，但是有些语料比较特殊（比如本例），回车后自动标记的槽位并不符合我们的要求，因此需要手工标记。 语料您可以做如下添加： 在“槽位”页签，设置槽位的名称，是否必选以及当槽位信息缺失时系统给出的提问信息。 槽位的名称将是您在流程编排时使用的槽位变量名称的一部分。 由于时间、日期、科室、医生必须提供完整才能确认一次预约挂号的信息，这四个槽位本应该是必选的，因此此处需要配置成“必选”。 在“响应”页签，单击“新增”，配置本次意图匹配成功后返回的命令字。 响应是指当匹配到该意图时，需要反馈的文本或命令字信息。响应支持根据不同的条件表达式返回不同的文本或命令字。通常在需要匹配到的意图向客户返回某些提示信息时，可配置回复文本，当需要将响应匹配到的事件写入TOC.IntentCode变量，返回给调用方（例如对话流程）时，可配置回复命令字。、 单击“命令”文本框，设置其值为“finish”。 单击“命令”文本框或单击“新增回复”按钮，设置“回复类型”为“回复文本”，单击“请输入”文本框，设置其值为“你预定了{$date}的{$time}的{$doctor}的{$room}” 单击右下角的“保存”。 单击右上角“训练”，提示训练成功。 单击右上角“询问机器人”，对当前意图模板进行测试。 若您在添加意图时配置了上下文，询问机器人之前请在聊天界面的上下文选择框中输入已配置的上下文，否则可不选。 测试时请根据您的语料对机器人进行询问，查看机器人的返回，如果返回类似如下内容，表示匹配成功。

GaussDB 模式约束 模式兼容性： PostgreSQL 支持迁移到 GaussDB(O模式)或 GaussDB(PG模式)； GaussDB(O模式)中将空字符串存储为 NULL，执行SQL语句“ select '' is null;”结果为True，与 Oracle 数据库行为一致； GaussDB(PG模式)中空字符串与 NULL 不同，执行SQL语句“ select '' is not null;”结果为True，与 PostgreSQL 数据库行为一致。

PostgreSQL To GaussDB配置项使用说明 问题描述 配置建议 建议值 PostgreSQL数据库函数DDL支持并行特性配置（PARALLEL），GaussDB不支持该配置 建议配置“函数并行特性”解决该类问题。 选择“注释函数并行特性配置“。 PostgreSQL字符类型长度单位是字符，GaussDB PG兼容模式下字符类型长度单位是字符，其他兼容模式下字符类型长度单位是字节。 建议配置“字符数据类型转换”解决该类问题。 迁移到GaussDB PG兼容模式选择“不对字符数据类型长度进行转换”；迁移到GaussDB 其他兼容模式选择“转换字符数据类型char/varchar为nvarchar2。”。 父主题： 配置说明

UGO权限 默认情况下，管理员创建的 IAM 用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 UGO部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华南-广州）对应的项目（cn-south-1ap-southeast-3）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问UGO时，需要先切换至授权区域。 根据授权精确程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于华为云各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。 如表1和表2所示，包括了UGO的所有系统内置角色和策略。 表1 UGO系统内置角色支持 系统角色 描述 是否支持 Tenant Administrator 租户admin权限，可访问和操作除IAM以外所有云服务下的租户范围可访问资源。 是 Tenant Guest 租户只读权限，拥有除IAM以外租户范围内所有对象的查询类权限。 是 表2 UGO服务系统策略 策略名称 描述 是否支持 UGO FullAccess 数据库和应用迁移服务所有权限 必须支持 UGO ReadOnlyAccess 数据库和应用迁移服务只读权限 必须支持 UGO CommonOperations 数据库和应用迁移服务SQL语句转换权限 可选支持 表3列出来UGO服务常用操作与系统权限的授权关系，您可以参照该表选择合适的系统权限。 表3 常用操作与系统策略的关系 操作 UGO FullAccess UGO ReadOnlyAccess UGO CommonOperations 创建项目 √ x x 查询标签 √ √ x 查询配额 √ √ x 获取项目列表 √ √ x 删除项目 √ x x 启动迁移项目 √ x x 查询项目详情 √ √ x SQL语句转换 √ x √ 表4列出了UGO常用操作以及对应的授权项，您可以参照该表自定义配置权限策略。 表4 常用操作与对应的授权项 权限 授权项 归类 评估项目-获取评估项目列表 ugo:evaluationJob:list ReadOnly 迁移项目-获取迁移项目列表 ugo:migrationJob:list ReadOnly 查询标签 ugo:tag:getTags ReadOnly 添加、修改和删除标签 ugo:tag:operateTags ReadWrite 查询配额 ugo:jobs:getQuotas ReadOnly 公共-查询项目详情 ugo:jobs:getDetails ReadOnly 评估项目-测试源库连通性 ugo:evaluationJob:testConnection ReadWrite 评估项目-测试源库网络稳定性 ugo:evaluationJob:testNetworkConnection ReadWrite 评估项目-预检查 ugo:evaluationJob:preCheck ReadWrite 评估项目-创建评估项目 ugo:evaluationJob:create ReadWrite 评估项目-停止评估 ugo:evaluationJob:stopEvalProject ReadWrite 评估项目-恢复评估 ugo:evaluationJob:resumeEvalProject ReadWrite 评估项目-重新评估 ugo:evaluationJob:reanalyze ReadWrite 评估项目-差异化分析 ugo:evaluationJob:collectDiffAnalysis ReadWrite 评估项目-增量评估 ugo:evaluationJob:startDeltaEvaluation ReadWrite 评估项目-确认目标库类型 ugo:evaluationJob:updateEvalProject ReadWrite 评估项目-重新选择评估对象并评估 ugo:evaluationJob:analyzeType ReadWrite 评估项目-编辑SQL ugo:evaluationJob:saveSQL ReadWrite 评估项目-删除评估项目 ugo:evaluationJob:delete ReadWrite 迁移项目-测试目标库连通性 ugo:migrationJob:testConnection ReadWrite 迁移项目-创建迁移项目 ugo:migrationJob:create ReadWrite 迁移项目-转换计划-跳过转换/撤销跳过 ugo:migrationJob:skipObjects ReadWrite 迁移项目-转换计划-转换配置 ugo:migrationJob:updateConfig ReadWrite 迁移项目-转换计划-应用配置 ugo:migrationJob:updateCategory ReadWrite 迁移项目-转换计划-设置用户密码 ugo:migrationJob:setPassword ReadWrite 迁移项目-转换计划-表空间映射 ugo:migrationJob:updateTableSpaceMapping ReadWrite 迁移项目-语法转换-启动/恢复 ugo:migrationJob:startConvert ReadWrite 迁移项目-语法转换-暂停 ugo:migrationJob:stopConvert ReadWrite 迁移项目-对象校正-更新状态 ugo:migrationJob:updateFailedStatus ReadWrite 迁移项目-对象校正-跳过迁移/撤销跳过 ugo:migrationJob:skipVerification ReadWrite 迁移项目-对象校正-重新转换 ugo:migrationJob:reconvert ReadWrite 迁移项目-对象校正-批量更新-替换 ugo:migrationJob:updateBulk ReadWrite 迁移项目-对象校正-比较/忽略/保存对SQL的修改 ugo:migrationJob:updateSQL ReadWrite 迁移项目-迁移验证-启动 ugo:migrationJob:startVerify ReadWrite 迁移项目-迁移验证-停止 ugo:migrationJob:stopVerify ReadWrite 迁移项目-删除迁移项目 ugo:migrationJob:delete ReadWrite SQL转换 ugo:sqlStatement:convert ReadWrite

身份认证 用户访问文档数据库服务（Document Database Service，简称DDS）时支持对数据库用户进行身份验证，包含密码验证和IAM验证两种方式。 密码验证 您需要对数据库实例进行管理，使用数据管理服务（Data Admin Service）登录数据库时，需要对账号密码进行验证，验证成功后方可进行操作。 IAM验证 您可以使用 统一身份认证 服务（Identity and Access Management， IAM）进行精细的权限管理。该服务提供用户身份认证、权限分配、访问控制等功能，可以帮助您安全地控制华为云资源的访问。您创建的IAM用户，需要通过验证用户和密码才可以使用DDS资源。具体请参见创建IAM用户并登录。

访问控制 权限控制 购买实例之后，您可以使用IAM为企业中的员工设置不同的访问权限，以达到不同员工之间的权限隔离，通过IAM进行精细的权限管理。具体内容请参见权限管理。 VPC和子网 虚拟私有云（Virtual Private Cloud，VPC）为云数据库构建隔离的、用户自主配置和管理的虚拟网络环境，提升用户云上资源的安全性，简化用户的网络部署。您可以在VPC中定义安全组、VPN、IP地址段、带宽等网络特性，方便管理、配置内部网络，进行安全、快捷的网络变更。 子网提供与其他网络隔离的、可以独享的网络资源，以提高网络安全性。 具体内容请参见创建虚拟私有云和子网。 安全组 安全组是一个逻辑上的分组，为同一个虚拟私有云内具有相同安全保护需求并相互信任的弹性云服务器和DDS数据库实例提供访问策略。为了保障数据库的安全性和稳定性，在使用DDS数据库实例之前，您需要设置安全组，开通需访问数据库的IP地址和端口。 具体请参见设置安全组规则。

责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的 云安全 挑战和无孔不入的云安全威胁与攻击，华为云在遵从法律法规业界标准的基础上，以安全生态圈为护城河，依托华为独有的软硬件优势，构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任，如图1所示。 华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的 IaaS、PaaS 和 SaaS 类云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身，也包括运维运营安全，以及更广义的安全合规遵从。 租户：负责云服务内部的安全，安全地使用云。 华为云租户的安全责任在于对使用的 IaaS、PaaS 和 SaaS 类云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、 虚拟主机 和访客虚拟机的操作系统，虚拟防火墙、API 网关和高级安全服务，各项云服务，租户数据，以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思路与措施，包括云安全战略、责任共担模型、合规与隐私、安全组织与人员、基础设施安全、租户服务与租户安全、工程安全、运维运营安全、生态安全。 图1 华为云安全责任共担模型 父主题： 安全

部署建议 建议从以下维度考虑如何创建并使用文档数据库服务。 区域和可用区：区域和可用区决定了文档数据库实例所在的物理位置，文档数据库实例创建成功后，将无法更换区域。您可以根据用户地理位置、产品资源价格、容灾能力和网络时延等因素，选择区域和可用区。更多信息，请参见区域和可用区。 网络规划：创建文档数据库实例时，推荐使用系统部署的弹性云服务器（Elastic Cloud Server，简称E CS ）所使用的虚拟私有云（Virtual Private Network，简称VPC）和子网。 数据安全：文档数据库服务提供了全面的安全保障。您可以通过多可用区部署、审计日志、网络隔离、安全组、加密等多手段保障数据库的数据安全。

存储结构 图1 存储结构图 如上图所示，DDS的基本管理单元是实例，与关系型数据库不同，DDS实例由数据库、集合、文档三部分组成。 DDS完全兼容MongoDB协议，所以在一些术语、数据结构、基本语法上同MongoDB是一致的。如下表格提供了MongoDB和关系型数据库中一些常见术语的映射关系，便于您理解和更好的使用DDS。 表1 术语解释 MongoDB中的术语 说明 关系型数据库中对应的术语 数据库（Database） 一个DDS实例中可以建立多个数据库，一个数据库中可以建立多个集合。 数据库（Database） 集合（Collection） 集合就是MongoDB文档组，一个集合可以包含多个文档。 表（Table） 文档（Document） 文档是一组键值(key-value)对(即BSON)，是MongoDB中最基本的单元。 行（Row）

文档数据库服务与自建数据库的对比优势 与自建数据库相比，文档数据库服务DDS具有高可用、高可靠、高安全、低成本等优势。 表1 对比优势 对比项 文档数据库服务 自建数据库 服务可用性 99.95% 自行保障，自行搭建主从复制，部署高可用环境等。 数据持久性 99.99999999% 自行保障，自行搭建主从复制，自建RAID等。 系统安全性 防DDoS攻击，及时自动修复各种数据库安全漏洞。 支持审计日志。 需要购买昂贵的硬件设备和软件服务，自行检测和修复安全漏洞等。 需要购买额外审计系统。 数据库备份 支持自动备份，根据业务运行周期设置自动备份策略。 支持随时手动备份数据，手动备份支持物理备份，备份效率提升3倍。 备份文件自动上传到 对象存储服务 （Object Storage Service，简称OBS）保存。 自行搭建设置和后期维护。 开源版本仅支持逻辑备份，备份效率低。 监控告警 已对接 云监控服务 （Cloud Eye），监控可视化，可在Cloud Eye上查看一段时间内的监控指标，以及设置阈值告警。 自行编写监控脚本和告警脚本，保存监控数据和绘制图表。 主机托管 无主机托管费用，即买即用。 自行购买3台服务器设备，托管费用昂贵。 维护成本 无额外运维成本，支持秒级性能监控和设置阈值告警、事件告警。 需要投入大量人力成本，招聘专业的DBA进行维护。 部署扩容 快速部署，灵活应用，支持弹性扩容，一键规格变更。 需要购买和原设备匹配的硬件，需托管机房的配合，需部署设备，整体周期较长。 日志转储 支持保留1个月的慢日志和错误日志。 自行转储日志文件，自行导出和查询日志信息。 高可用监控 具备高可用能力，支持秒级Switchover和Failover。 自行部署高可用监控，手工命令行执行主备切换，可能会有数据丢失。

不支持同步的DDL 在创建的同步库中，支持同步表及数据，不支持同步数据库，表空间，索引，外键，函数，存储过程，触发器，视图，分区（删除），主键（增加/删除/修改），事务，用户，角色，权限，事件等对象的操作。 表1和表2提供了不支持同步的索引和分区表相关的操作。这些不支持同步的操作不会影响在HTAP节点上查询和分析数据。 建表语句不能包含CHECK，表选项等。 在数据同步过程中，表3中的操作会导致HTAP中数据和GaussDB(for MySQL) 中数据不一致，应尽量避免使用。 表1 不支持同步的索引相关操作 DDL名称 SQL样例 添加索引 ALTER TABLE tbl_name ADD INDEX name; 重命名索引 ALTER TABLE tbl_name RENAME INDEX old_index_name TO new_index_name; 删除索引 DROP INDEX name ON table; 增加全文索引 CREATE FULLTEXT INDEX name ON table(column); 增加空间索引 ALTER TABLE geom ADD SPATIAL INDEX(g); 修改索引类型 ALTER TABLE tbl_name DROP INDEX i1, ADD INDEX i1(key_part,...) USING BTREE; 添加索引约束 ALTER TABLE tbl_name ADD CONSTRAINT UNIQUE USING BTREE (column); ALTER TABLE tbl_name ADD CONSTRAINT UNIQUE USING HASH(column); 表2 不支持同步的分区表相关操作 DDL名称 SQL样例 分析表分区 ALTER TABLE {db}.tp ANALYZE PARTITION p0; 检查表分区 ALTER TABLE {db}.tp CHECK PARTITION p0; 优化表分区 ALTER TABLE {db}.tp OPTIMIZE PARTITION p0; 重建表分区 ALTER TABLE {db}.tp REBUILD PARTITION p0; 修复表分区 ALTER TABLE {db}.tp REPAIR PARTITION p0; 创建数据库 CREATE DATABASE ddl_test_2; 修改行格式 ALTER TABLE tbl_name ROW_FORMAT = row_format; 设置持久表统计信息 ALTER TABLE tbl_name STATS_PERSISTENT=0, STATS_SAMPLE_PAGES=20,STATS_AUTO_RECALC=1, ALGORITHM=INPLACE, LOCK=NONE; 设置表的字符集 ALTER TABLE tbl_name CHARACTER SET = charset_name; 转换表的字符集 ALTER TABLE tbl_name CONVERT TO CHARACTER SET charset_name; 优化表 OPTIMIZE TABLE tbl_name; 使用“强制”选项重建表 ALTER TABLE tbl_name FORCE; 执行空重建 ALTER TABLE tbl_name ENGINE=InnoDB; 重命名表空间 ALTER TABLESPACE tablespace_name RENAME TO new_tablespace_name; 增加表分区 ALTER TABLE {db}.tp ADD PARTITION (PARTITION p3 VALUES LESS THAN (2006) ); 指定排序规则 ALTER TABLE tbl_name DEFAULT CHARACTER SET = utf8 COLLATE = utf8_general_ci; 表3 导致数据不一致的DDL操作说明 DDL名称 SQL样例 删除主键 ALTER TABLE tbl_name DROP PRIMARY KEY; 增加主键 ALTER TABLE {db}.t1 ADD PRIMARY KEY (id); 增加删除主键 ALTER TABLE tbl_name DROP PRIMARY KEY, ADD PRIMARY KEY (column); 主键允许为NULL ALTER TABLE tbl_name MODIFY COLUMN key_column_name data_type; 修改主键类型 ALTER TABLE tbl_name MODIFY COLUMN key_column_name data_type not null; 增加外键 ALTER TABLE tbl1 ADD CONSTRAINT fk_name FOREIGN KEY index (col1)REFEREN CES tbl2(col2) referential_actions; 删除外键 ALTER TABLE tbl DROP FOREIGN KEY fk_name; 增加列 说明： 支持一般的列增加，但不支持缺省值为如下取值的场景： 双引号 包含HTAP中不存在的函数，字符串，标志符 ALTER TABLE tbl_name ADD COLUMN column_name column_definition c VARCHAR(10) DEFAULT (CONCAT('1', '2')); 设置列的缺省值 说明： 支持缺省值的设置，但不支持缺省值为如下取值的场景： 双引号 包含HTAP中不存在的函数，字符串，标志符 ALTER TABLE tbl_name ALTER COLUMN col SET DEFAULT literal; 修改列不允许为NULL ALTER TABLE tbl_name MODIFY COLUMN column_name data_type NOT NULL; 同时修改列名和类型 ALTER TABLE t1 CHANGE b b1 VARCHAR(100); 创建无主键的表 ALTER TABLE t1 ADD COLUMN (c2 INT GENERATED ALWAYS AS (c1 + 1)STORED); 增加存储型衍生列 ALTER TABLE {db}.t1 ADD COLUMN (st2 INT GENERATED ALWAYS AS (c2 + 2)STORED), ALGORITHM=COPY; 增加虚拟型衍生列 ALTER TABLE t1 ADD COLUMN (c2 INT GENERATED ALWAYS AS (c1 + 1)VIRTUAL); 删除表分区 ALTER TABLE {db}.tp DROP PARTITION p4; 丢弃表分区 ALTER TABLE {db}.tp DISCARD PARTITION p2 TABLESPACE; 导入表分区 ALTER TABLE {db}.tp IMPORT PARTITION p2 TABLESPACE; 截断表分区 ALTER TABLE {db}.tp TRUNCATE PARTITION p2; 截断分区表 TRUNCATE {db}.tp; 联合表分区 ALTER TABLE {db}.tp_hash COALESCE PARTITION 2; 重新组织表分区 ALTER TABLE {db}.tp REORGANIZE PARTITION p0,p1,p2,p3 INTO ( ... ); 交换表分区 ALTER TABLE {db}.tp EXCHANGE PARTITION p0 WITH TABLE {db}.tp2; 删除表分区 ALTER TABLE {db}.tp REMOVE PARTITIONING; 使用REPLACE子句 CREATE OR REPLACE TABLE; 父主题： 数据同步

响应示例 状态码： 200 Request succeeded! null 状态码： 400 Bad Request { "error_code" : "CC.00000000", "error_msg" : "网络繁忙，请稍后再试" } 状态码： 401 Unauthorized { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }

URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity 否 String 缺陷等级，0致命，1严重，2一般，3提示 offset 否 Integer 分页索引，偏移量 最小值：0 缺省值：0 limit 否 Integer 每页显示的数量 最小值：1 最大值：1000 缺省值：100

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 info Array of RuleListItem objects 规则信息 total Integer 总数 表4 RuleListItem 参数 参数类型 描述 rule_set String 规则集规范分类 rule_id String 规则id rule_language String 规则所属语言 rule_name String 规则名称 rule_severity String 规则问题级别 rule_tages String 规则标签 right_example String 正确示例 error_example String 错误示例 revise_opinion String 修改建议 rule_desc String 规则描述 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 Content-Type 是 String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型 描述 defect_id 是 String 问题id,多个时英文逗号分隔 defect_status 是 String 状态2：已忽略 1：已解决 0：未解决

响应示例 状态码： 200 Request succeeded! null 状态码： 400 Bad Request { "error_code" : "CC.00000000", "error_msg" : "网络繁忙，请稍后再试" } 状态码： 401 Unauthorized { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }

响应示例 状态码： 200 Request succeeded! null 状态码： 400 Bad Request { "error_code" : "CC.00000000", "error_msg" : "网络繁忙，请稍后再试" } 状态码： 401 Unauthorized { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }

请求示例 任务配置检查参：检查参数的语言类型为csharp，状态为on POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/config-parameters { "check_id" : 11, "ruleset_id" : "b113bxxxxxxxx5738bee86ecxxxxxxxx", "language" : "csharp", "status" : "on", "task_check_settings" : [ { "cfg_key" : "csharpCompileTool", "status" : "on", "cfg_value" : "msbuild" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 Content-Type 是 String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型 描述 check_id 是 Integer 检查工具ID 最小长度：1 最大长度：11 ruleset_id 是 String 规则集ID 最小长度：1 最大长度：64 language 是 String 规则集语言 最小长度：1 最大长度：128 status 是 String off：关闭，on：开启 最小长度：1 最大长度：3 task_check_settings 是 Array of TaskCheckSettingsItem objects 检查参数信息 表4 TaskCheckSettingsItem 参数 是否必选 参数类型 描述 cfg_key 是 String 检查参数对应的key值 最小长度：1 最大长度：50 status 是 String 参数状态 最小长度：1 最大长度：3 cfg_value 否 String 检查参数值 最小长度：1 最大长度：1000

响应示例 状态码： 200 Request succeeded! null 状态码： 400 Bad Request { "error_code" : "CC.00000000", "error_msg" : "网络繁忙，请稍后再试" } 状态码： 401 Unauthorized { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }

响应示例 状态码： 200 Request succeeded! { "task_id" : "435b58ecf7f54c45907c1384d01c94a6", "task_name" : "CSharp_02201119", "creator_id" : "ecadebb5041146cc96f9780f3d905e20", "git_url" : "git@****_02201119.git", "git_branch" : "master", "last_check_time" : "2020-02-20 11:37:46", "code_line_total" : 20, "code_line" : 156, "code_quality" : 147.4, "issue_count" : 3, "risk_coefficient" : 23, "duplication_ratio" : "0.0%", "complexity_count" : 0, "duplicated_lines" : 0, "comment_lines" : 0, "comment_ratio" : "0", "duplicated_blocks" : 0, "last_exec_time" : "2 分 28 秒", "check_type" : "source", "created_at" : "2020-02-20 11:21:11", "cyclomatic_complexity_per_method" : "84.0", "cyclomatic_complexity_per_file" : "112.0", "critical_count" : 2, "major_count" : 1, "minor_count" : 1, "suggestion_count" : 1, "is_access" : 0, "trigger_type" : 1, "file_duplication_ratio" : "33.3%", "new_count" : 0, "solve_count" : 0, "duplicated_files" : 0, "new_critical_count" : "0", "new_major_count" : "0", "new_minor_count" : "0", "new_suggestion_count" : "0" } 状态码： 400 Bad Request { "error_code" : "CC.00000000", "error_msg" : "网络繁忙，请稍后再试" } 状态码： 401 Unauthorized { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 task_id String 任务id task_name String 任务名字 creator_id String 创建者id git_url String 代码仓地址 git_branch String 代码仓分支,如果是MR模式，为源分支 last_check_time String 上一次检查时间 code_line_total Integer 代码总行数 code_line Integer 代码有效行数 code_quality Number 代码质量 issue_count Integer 问题数 risk_coefficient Number 危险系数 duplication_ratio String 重复比例 complexity_count Integer 复杂度 duplicated_lines Integer 重复行数 comment_lines Integer 注释行数 comment_ratio String 注释比例 duplicated_blocks Integer 重复块 last_exec_time String 上次执行时间 check_type String 检查类型 created_at String 创建时间 cyclomatic_complexity_per_method String 代码平均复杂度 cyclomatic_complexity_per_file String 代码平均复杂度(文件) critical_count String 致命问题数 major_count String 严重问题数 minor_count String 一般问题数 suggestion_count String 提示问题数 is_access String 门禁质量是否通过 trigger_type String 任务触发方式 file_duplication_ratio String 文件重复率 new_count Integer 新增问题数 solve_count Integer 已解决问题数 duplicated_files Integer 重复文件数目 new_critical_count String 新增致命问题数 new_major_count String 新增严重问题数 new_minor_count String 新增一般问题数 new_suggestion_count String 新增提示问题数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 exec_id String 执行id 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 Request succeeded! { "exec_id" : "d163535d0*******81d6a7654443e" } 状态码： 400 Bad Request { "error_code" : "CC.00000000", "error_msg" : "网络繁忙，请稍后再试" } 状态码： 401 Unauthorized { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 Content-Type 是 String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型 描述 username 否 String 该任务对应临时仓库有权限的用户名 access_token 否 String 该任务对应临时仓库有权限的用户token git_url 否 String 该任务对应的临时仓库地址 git_branch 否 String 该任务对应的临时仓库分支