华为云用户手册

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 参数解释 错误码 error CommonResponseErrorOfAPITest object 参数解释 统一错误返回 reason String 参数解释 失败原因 result BasicAwRes object 参数解释 结果 status String 参数解释 状态 costTimeResult String 参数解释 提交耗时 表4 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 参数解释 接口调用失败错误码 reason String 参数解释 接口调用失败原因 表5 BasicAwRes 参数 参数类型 描述 aw_code String 参数解释 关键字代码, hascode字段为1时有效 aw_description String 参数解释 关键字描述 aw_mark Integer 参数解释 关键字标记 aw_operationid String 参数解释 关键字操作编号 aw_tags String 参数解释 关键字tags aw_type Integer 参数解释 关键字类型 aw_uniqueid String 参数解释 关键字来源 by_order Integer 参数解释 关键字顺序 create_time String 参数解释 关键字创建时间 create_time_stamp Long 参数解释 关键字创建时间戳 create_time_string String 参数解释 关键字创建时间戳（字符串格式） create_user String 参数解释 关键字创建者 create_user_id String 参数解释 关键字创建者ID delete_time String 参数解释 关键字删除时间 delete_user String 参数解释 关键字删除者 description String 参数解释 关键字描述 dft_check_point_list Array of objects 参数解释 默认检查点列表 dft_custom_header Array of objects 参数解释 默认请求头参数对象 dft_retry_interval String 参数解释 重试间隔时间 (ms) ，为空表示不等待 dft_retry_times String 参数解释 重试次数 dft_variable_list Array of objects 参数解释 默认变量信息列表 extra_info Object 参数解释 补充信息 group_name String 参数解释 分组名 has_code Integer 参数解释 是否存在代码， 0-不存在代；1-存在代码 id String 参数解释 关键字编号 import_package Array of strings 参数解释 导入的包名 interface_label String 参数解释 接口的x-extend字段说明 is_favorite Integer 参数解释 是否收藏 method String 参数解释 关键字方法名 name String 参数解释 关键字名 nameView String 参数解释 在页面上显示的名字 origin_project String 参数解释 源工程信息 param_type_and_dft_value Array of objects 参数解释 参数类型和参数默认值 project_id String 参数解释 工程编号 protocol_type String 参数解释 协议类型 public_aw_lib Object 参数解释 公共关键字信息 public_aw_lib_id String 参数解释 公共关键字id region String 参数解释 region信息 return_type String 参数解释 返回值类型 root_id String 参数解释 根节点编号 source String 参数解释 关键字依赖的类源 special_type Integer 参数解释 特殊关键字类型 tmssCaseNumber String 参数解释 关键字编号（来自测试管理服务） tmss_case_id String 参数解释 测试用例id update_time String 参数解释 关键字更新时间 update_time_stamp Long 参数解释 关键字更新时间戳 update_time_string String 参数解释 关键字更新时间戳（字符串格式） update_user String 参数解释 关键字更新者 warningMsg String 参数解释 警告信息 yamlName String 参数解释 yaml名称 状态码：401 Unauthorized 状态码：403 Forbidden 状态码：404 Not Found

响应参数 状态码：204 No Content 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

请求示例 批量更新测试用例结果 post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/testcases/result { "execute_list" : [ { "description" : "这是一条备注信息", "duration" : 10, "end_time" : 16659743037899, "execute_id" : "efdb403066474ab08836b9eeaaa23bca", "result_id" : "0", "testcase_id" : "b66aab5469cc4ab39b0dda8e644a42a4" } ], "service_id" : 13 }

URI POST /v1/projects/{project_id}/testcases/result 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 execute_list 是 Array of UpdateTestCaseResultBean objects 测试用例状态信息，数组长度小于等于50 service_id 是 Integer 参数解释: 测试用例类型ID，指定指定对应类型的测试用例ID 约束限制: 需要与execute_list中提供的用例的执行方式一致 取值范围: 大于0整数 默认取值: 不涉及 表4 UpdateTestCaseResultBean 参数 是否必选 参数类型 描述 description 否 String 参数解释: 用于记录该次结果执行的备注信息 约束限制: 不涉及 取值范围: 长度小于2000字符 默认取值: 不涉及 duration 否 Long 参数解释: 执行用例持续时长ms 约束限制: 更新状态时该字段必传 取值范围: 大于0整数，单位ms 默认取值: 不涉及 end_time 是 Long 参数解释: 用例结束执行的时间戳 约束限制: 在执行结束时该字段必传 取值范围: 符合时间戳格式 默认取值: 不涉及 execute_id 是 String 参数解释: 注册服务执行id 约束限制: 该值不允许重复 取值范围: 长度为1-32位字符（字母或数字） 默认取值: 不涉及 result_id 是 String 参数解释: 测试用例结果 约束限制: 不涉及 取值范围: 0-成功，1-失败，5-执行中，6-停止 默认取值: 不涉及 testcase_id 是 String 参数解释: 用例uri，测试用例唯一标识，测试用例详情页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&case_id={case_id}&detail=base中case_id变量的值 约束限制: 不涉及 取值范围: 长度11-34位字符（字母和数字） 默认取值: 不涉及

响应示例 状态码：200 OK { "assigned_user" : { "id" : "ID", "name" : "名称" }, "execute_count" : 4, "extend_info" : { "author" : { "id" : "1111", "name" : "名称", "time" : "2000-01-01 00:00:00" }, "defect_list" : [ { "id" : "ID", "name" : "名称" } ], "description" : "描述信息", "domain" : { "id" : "ID", "name" : "名称" }, "fixed_version" : { "id" : "ID", "name" : "名称" }, "issue" : { "id" : "ID", "name" : "名称" }, "label_list" : [ { "id" : "ID", "name" : "名称" } ], "module" : { "id" : "ID", "name" : "名称" }, "preparation" : "前置条件", "steps" : [ { "expect_result" : "[\"\\u003cp\\u003e预期结果1\\u003c/p\\u003e\",\"\\u003cp\\u003e预期结果2\\u003c/p\\u003e\"]", "test_step" : "[\"\\u003cp\\u003e步骤描述1\\u003c/p\\u003e\",\"\\u003cp\\u003e步骤描述2\\u003c/p\\u003e\"]" } ], "test_version_id" : "97b82412f1", "updator" : { "id" : "1111", "name" : "名称", "time" : "2000-01-01 00:00:00" } }, "name" : "某个测试用例", "project_id" : "2394921", "rank_id" : "2", "result_id" : "0", "service_id" : 13, "status_id" : "1", "testcase_id" : "97b82412f1ca4628803b918c27ed09de", "testcase_number" : "1234" }

请求示例 更新自定义测试服务类型用例 put https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/testcases/1234 { "extend_info" : { "assigned_id" : "b66aab5469cc416hestdda8e644a42a4", "defect_id_list" : [ { "issueId" : "018fd45b181c4f6aa94afac9f769d625", "title" : "缺陷1" }, { "issueId" : "018fd45b181c4f6aa94afac9f769d625", "title" : "缺陷2" }, { "issueId" : "018fd45b181c4f6aa94afac9f769d625", "title" : "缺陷3" } ], "description" : "这是一条描述信息", "fix_version_id" : "1234", "issue_id" : "b66aab5469cc4ab39b0dda8e644a42a4", "label_list" : [ "标签1" ], "module_id" : "b66aab5469cc4ab39b0dda8e644a42a4", "preparation" : "需要满足的前置条件", "status_id" : "0", "steps" : [ { "expect_result" : "[\"\\u003cp\\u003e预期结果1\\u003c/p\\u003e\",\"\\u003cp\\u003e预期结果2\\u003c/p\\u003e\"]", "test_step" : "[\"\\u003cp\\u003e步骤描述1\\u003c/p\\u003e\",\"\\u003cp\\u003e步骤描述2\\u003c/p\\u003e\"]" } ], "test_version_id" : "1.1.0.1" }, "name" : "testcase", "rank_id" : "2", "service_id" : 13, "testcase_number" : "1234" }

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 assigned_user AssignedUserInfo object 参数解释: 处理者信息 取值范围: 不涉及 execute_count Integer 参数解释: 测试用例执行次数 取值范围: 不涉及 extend_info ExtendInfo object 参数解释: 测试用例扩展信息 取值范围: 不涉及 name String 参数解释: 测试用例名称 取值范围: 不涉及 project_id String 参数解释: 软开云项目唯一标识 取值范围: 不涉及 rank_id String 参数解释: 测试用例等级 取值范围: 0|1|2|3|4 result_id String 参数解释: 测试用例执行结果 取值范围: 不涉及 service_id Integer 参数解释: 注册测试类型服务接口返回的服务id 取值范围: 不涉及 status_id String 参数解释: 测试用例状态 取值范围: 不涉及 testcase_id String 参数解释: 用例uri,测试用例唯一标识 取值范围: 11-34位字符（字母和数字） testcase_number String 参数解释: 测试用例编号 取值范围: 不涉及 表7 ExtendInfo 参数 参数类型 描述 author ExtendAuthorInfo object 参数解释: 创建者信息 取值范围: 不涉及 defect_list Array of AssignedUserInfo objects 参数解释: 缺陷信息 取值范围: 不涉及 description String 参数解释: 描述信息 取值范围: 不涉及 domain AssignedUserInfo object 参数解释: 租户信息 取值范围: 不涉及 fixed_version AssignedUserInfo object 参数解释: 迭代信息 取值范围: 不涉及 issue AssignedUserInfo object 参数解释: 需求信息 取值范围: 不涉及 label_list Array of AssignedUserInfo objects 参数解释: 标签信息 取值范围: 不涉及 module AssignedUserInfo object 参数解释: 模块信息 取值范围: 不涉及 preparation String 参数解释: 前置条件 取值范围: 不涉及 steps Array of ExternalServiceCaseStep objects 参数解释: 测试步骤 取值范围: 数组长度小于10 test_version_id String 参数解释: 测试版本号 取值范围: 不涉及 updator ExtendAuthorInfo object 参数解释: 更新者信息 取值范围: 不涉及 表8 AssignedUserInfo 参数 参数类型 描述 id String 参数解释: id信息 取值范围: 不涉及 name String 参数解释: 名称信息 取值范围: 不涉及 表9 ExternalServiceCaseStep 参数 参数类型 描述 expect_result String 参数解释: 测试用例预期结果信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 test_step String 参数解释: 测试步骤描述信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 表10 ExtendAuthorInfo 参数 参数类型 描述 id String 参数解释: id信息 取值范围: 不涉及 name String 参数解释: 名称信息 取值范围: 不涉及 time String 参数解释: 时间信息 取值范围: 不涉及 状态码：400 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及

URI PUT /v1/projects/{project_id}/testcases/{testcase_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 32位字符（字母和数字） 默认取值: 不涉及 testcase_id 是 String 参数解释: 用例uri,测试用例唯一标识,长度11-34位字符（字母和数字）。 约束限制: 不涉及 取值范围: 长度11-34位字符（字母和数字） 默认取值: 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制: 不涉及 取值范围: 字符串长度不少于1，不超过100000 默认取值不涉及: 表3 请求Body参数 参数 是否必选 参数类型 描述 extend_info 否 ExternalServiceBizCase object 测试用例其他扩展信息 name 是 String 参数解释: 页面上显示的用例名称，长度为[3-128]位字符 约束限制: 不涉及 取值范围: 3-128位字符 默认取值: 不涉及 rank_id 否 String 参数解释: 测试用例等级，可选值为[0,1,2,3,4]，不填时默认为2 约束限制: 不涉及 取值范围: 0|1|2|3|4 默认取值: 2 service_id 是 Integer 参数解释: 注册测试类型服务接口返回的服务id，取值范围为10-9999 约束限制: 不涉及 取值范围: 10-9999 默认取值: 不涉及 testcase_number 否 String 参数解释: 用例编号，不填该值时会自动生成，长度为[3-128]位字符 约束限制: 不涉及 取值范围: 3-128位字符 默认取值: 不涉及 表4 ExternalServiceBizCase 参数 是否必选 参数类型 描述 assigned_id 否 String 参数解释: 处理者id信息，长度0-32位 约束限制: 不涉及 取值范围: 0-32位字符 默认取值: 不涉及 defect_id_list 否 Array of strings 参数解释: 缺陷id信息，数组长度小于50个 约束限制: 不涉及 取值范围: 数组长度小于50 默认取值: 不涉及 description 否 String 参数解释: 测试用例描述信息，长度为[0-500]位字符 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 fix_version_id 否 String 参数解释: 迭代号，长度为[0-32]位字符 约束限制: 不涉及 取值范围: 0-32位字符 默认取值: 不涉及 issue_id 否 String 参数解释: 用例关联的需求id信息，长度为[0-32]位字符 约束限制: 不涉及 取值范围: 0-32位字符 默认取值: 不涉及 label_list 否 Array of strings 参数解释: 标签名称列表，数组长度小于25 约束限制: 不涉及 取值范围: 数组长度小于25 默认取值: 不涉及 module_id 否 String 参数解释: 模块号，长度为[0-32]位字符 约束限制: 不涉及 取值范围: 0-32位字符 默认取值: 不涉及 preparation 否 String 参数解释: 执行该测试用例时需要满足的前置条件，长度为[0-500]位字符 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 status_id 否 String 参数解释: 测试用例状态信息，（0-新建，5-设计中，6-测试中，7-完成） 约束限制: 不涉及 取值范围: 0-新建，5-设计中，6-测试中，7-完成 默认取值: 不涉及 steps 否 Array of ExternalServiceCaseStep objects 参数解释: 测试步骤，数组长度小于10 约束限制: 不涉及 取值范围: 数组长度小于10 默认取值: 不涉及 test_version_id 否 String 测试版本号，长度为[1-64]位字符 表5 ExternalServiceCaseStep 参数 是否必选 参数类型 描述 expect_result 否 String 参数解释: 测试用例预期结果信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及 test_step 否 String 参数解释: 测试步骤描述信息 约束限制: 不涉及 取值范围: 0-500位字符 默认取值: 不涉及

请求示例 质量报告看板统计 post https://{{endpoint}}/testreport/v4/testhub/projects/875ab809ae454c808b8565bd8695692d/data-dashboard/overview { "plan_id" : "vx785d2300op22kb6c", "branch_id" : "v9050000uop22kb6", "module_id" : "889109272257798144,-2", "fixed_version_id" : "884537509955936256,884770598208577537,-2" }

响应示例 状态码：200 OK { "defect" : { "total" : 3, "not_solved" : 3, "severity_number_list" : [ { "name" : "提示", "value" : 3 } ] }, "case_pass_rate" : { "pass_rate" : "99.5%", "result_number_list" : [ { "name" : "成功", "value" : 3000 }, { "name" : "未执行", "value" : 15 } ] }, "project_type" : "ipd", "issue_cover_rate" : { "summary" : { "testing" : 0, "finished" : 0, "not_tested" : 17, "total_number" : 17, "cover_rate" : "0.0%" } } }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 defect DefectVo object 缺陷统计信息 case_pass_rate CasePassRateVo object 用例通过率信息 case_completion_rate CaseCompletionRateVo object 用例通过率信息 project_type String 参数解释: 项目类型 取值范围: 不涉及 issue_cover_rate IssueCoverRateVo object 参数解释: 需求覆盖率信息 取值范围: 不涉及 表5 DefectVo 参数 参数类型 描述 total Integer 参数解释: 缺陷数 取值范围: 不涉及 not_solved Integer 参数解释: 未关闭缺陷数 取值范围: 不涉及 severity_number_list Array of NameAndValueVo objects 参数解释: 组装缺陷每种重要程度的名称和对应的数目 取值范围: 不涉及 表6 CasePassRateVo 参数 参数类型 描述 pass_rate String 参数解释: 用例通过率 取值范围: 0%-100% result_number_list Array of NameAndValueVo objects 参数解释: 用户自定义结果对应的用例数目 取值范围: 不涉及 表7 CaseCompletionRateVo 参数 参数类型 描述 total Integer 参数解释: 总用例数 取值范围: 不涉及 completion_rate String 参数解释: 用例完成率 取值范围: 0%-100% status_number_list Array of NameAndValueVo objects 参数解释: 用户自定义状态对应的用例数目 取值范围: 不涉及 表8 NameAndValueVo 参数 参数类型 描述 name String 参数解释: 名称 取值范围: 不涉及 value Integer 参数解释: 值 取值范围: 不涉及 表9 IssueCoverRateVo 参数 参数类型 描述 epic CoverRateVo object 参数解释: epic类型需求覆盖率, 仅scrum项目返回 取值范围: 不涉及 feature CoverRateVo object 参数解释: feature类型需求覆盖率, 仅scrum项目返回 取值范围: 不涉及 story CoverRateVo object 参数解释: story类型需求覆盖率, 仅scrum项目返回 取值范围: 不涉及 summary CoverRateVo object 参数解释: summary类型需求覆盖率, 仅scrum项目返回 取值范围: 不涉及 表10 CoverRateVo 参数 参数类型 描述 testing Integer 统计测试中的需求 finished Integer 统计已完成的需求 not_tested Integer 统计未测试的需求 total_number Integer 计算需求总数 cover_rate String 需求覆盖率 状态码：400 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：401 表12 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：404 表13 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 不涉及 error_msg String 参数解释 接口调用失败错误信息 取值范围 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 plan_id 否 String 参数解释: 测试计划id 约束限制: plan_id和branch_id不能同时为空，优先取plan_id 取值范围: 不涉及 默认取值: 不涉及 branch_id 否 String 参数解释: 分支id 约束限制: plan_id和branch_id不能同时为空，优先取plan_id 取值范围: 不涉及 默认取值: 不涉及 module_id 否 String 参数解释: 模块ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 fixed_version_id 否 String 参数解释: 筛选迭代ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及

HStore表的优势 HStore表采用附加delta表的形式，可以实现高效的存储与更新平衡，具体表现在以下几个方面： 批量数据处理： 批量插入数据直接写入CU 保持与传统列存一致的压缩效率 增量数据处理： 更新的列数据和小批量插入先序列化压缩 通过后台定期MERGE操作整合到主表CU 存储效率： 最大程度降低磁盘占用空间 保持列存格式的高压缩率特性 性能表现： 支持高并发更新操作入库 提供卓越的查询响应速度 适用场景 需要实时数据入库和实时查询 要求具备传统TP事务处理能力 高并发更新与查询并重的混合负载

使用建议 参数设置 为确保HStore表的查询性能与存储效率，推荐参数设置： 1 2 3 4 autovacuum_max_workers_hstore=3 # 专用于HStore的MERGE线程数 autovacuum_max_workers=6 # 系统总autovacuum线程数 autovacuum=true # 启用自动清理 enable_col_index_vacuum=on # 启用列索引清理 入库建议（推荐使用HStore_opt表） 更新操作： 避免直接使用UPDATE，改用UPSERT方式。 无并发冲突时开启enable_hstore_nonconflict_upsert_optimization参数。 有并发冲突时关闭上述参数，系统会自动选择最优路径。 删除操作： 确保执行计划走索引扫描。 采用JDBC batch方式入库效率最佳。 批量入库： 单次入库量超过100W/DN且数据无重复时，考虑使用MERGE INTO。 常规场景推荐使用UPSERT。 点查建议（推荐使用HStore_opt表） 在等值过滤条件使用最多且distinct值分布相对均匀的一个列上创建二级分区（distinct值的分布过于倾斜或者个数太少的列不要创建二级分区）； 除了二级分区之外的等值过滤列，如果过滤条件涉及的列在查询中基本固定，使用cbtree索引，创建索引的列数不要超过5列； 除了二级分区之外的等值过滤列，如果过滤条件涉及的列在不同查询中变化，使用gin索引，创建索引的列数不要超过5列； 所有涉及等值过滤的字符串列，都可以建表时指定bitmap索引，不限列数，后续不可修改； 时间范围过滤的列，指定为分区列； 点查返回数据量超过10W/dn的场景，索引扫描很可能不如非索引扫描，建议使用guc参数enable_seqscan对比测试下性能，灵活选择。 索引相关 索引会占用额外存储空间 对性能提升有要求时创建索引 需要执行UPSERT操作时使用索引 有唯一性或接近唯一的点查需求使用索引。 MERGE相关 入库速度控制： 入库速度不得超过MERGE处理能力 通过控制入库并发防止Delta表膨胀 空间复用问题： Delta表空间复用受oldestXmin影响 长时间运行的事务可能导致空间复用延迟和膨胀

列存表存储机制 在 GaussDB (DWS)中，列存表以压缩单元（CU）为最小存储单位，每列默认以60000行当做一个CU进行存储。由于CU采用追加写模式，更新和删除操作不会修改原有CU。CU一旦生成，其数据便不可更改，无论插入1条还是60,000条数据，都会生成一个新的完整CU。 因此使用过程中会产生如下问题： 删除操作：仅在字典中将旧数据标记为作废，并未释放空间。 更新操作：标记旧数据删除后，将新记录写入新的CU。 空间问题：频繁更新/删除会导致表空间膨胀和大量存储空间无法有效利用。

自动分区创建规则 自动创建新分区 分区自动管理每隔period的时间就会自动创建分区，每次创建一个或多个时间范围为period的新分区，以推进最大的分区边界时间，保证其大于nowTime+30*period。由于每次创建分区时，都动态地为未来时间创建了预留分区，所以只要有一次自动创建新分区成功，就可以保证在未来30个period的时间之内，都不会出现实时数据因为没有对应分区而导入失败的情况。 图1 自动创建分区示意图 自动删除过期分区 边界时间早于nowTime-ttl的分区被认为是过期分区。分区自动管理每隔period的时间就会遍历检测所有分区，并删除其中的过期分区，如果所有的分区都是过期分区，则保留一个分区，并TRUNCATE该表。

约束限制 在使用分区管理功能时，需要满足如下约束： 不支持在小型机、加速集群、单机集群上使用。 支持在8.1.3及以上集群版本中使用。 仅支持行存范围分区表、列存范围分区表、时序表以及冷热表。 分区键必须保持唯一性，其支持的数据类型包括TIMESTAMP、TIMESTAMPTZ、DATE，以及在9.1.0.200版本中新增的INT、BIGINT、VARCHAR和TEXT类型。 不支持存在maxvalue分区。 (nowTime - boundaryTime) / period需要小于分区个数上限，其中nowTime为当前时间，boundaryTime为现有分区中最早的分区边界时间。 period、ttl取值范围为1hour ~ 100years。另外，在兼容Teradata或MySQL的数据库中，分区键类型为date时，period不能小于1day。 表级参数ttl不支持单独存在，必须要提前或同时设置period，并且要大于或等于period。 集群在线扩容期间，自动增加分区会失败，但是由于每次增分区时，都预留了足够的分区，所以不影响使用。 time_format选项不支持SET修改。当period被RESET时（表示已经关闭自动分区，会报出提示），此时可以RESET此选项。

步骤二：准备GaussDB(DWS)的样例数据 连接到GaussDB(DWS)的默认数据库gaussdb，创建一个名为dws_test的数据库。 1 CREATE DATABASE dws_test; 重新连接到新创建的数据库dws_test，创建名为dws_data的SCHEMA，同时在该SCHEMA下创建名为rpg_order的表，并插入4条数据。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 CREATE SCHEMA dws_data; CREATE TABLE dws_data.dws_order ( order_id VARCHAR, order_channel VARCHAR, order_time VARCHAR, cust_code VARCHAR, pay_amount DOUBLE PRECISION, real_pay DOUBLE PRECISION ) DISTRIBUTE BY HASH (order_id); INSERT INTO dws_data.dws_order VALUES ('202306270001', 'webShop', '2023-06-27 10:00:00', 'CUST1', 1000, 1000); INSERT INTO dws_data.dws_order VALUES ('202306270002', 'webShop', '2023-06-27 11:00:00', 'CUST2', 5000, 5000); INSERT INTO dws_data.dws_order VALUES ('202307100003', 'webShop', '2023-07-10 13:00:00', 'CUST1', 3000, 3000); INSERT INTO dws_data.dws_order VALUES ('202307200004', 'webShop', '2023-07-20 14:00:00', 'CUST2', 4000, 4000); 查询表数据，验证数据是否插入。 1 SELECT * FROM dws_data.dws_order; 创建使用Power BI的数据库用户，密码需自定义。 1 CREATE USER dws_thiru PASSWORD '{password}'; 授权该用户可访问对应Schema和表的权限。 1 2 GRANT USAGE ON SCHEMA dws_data TO dws_thiru; GRANT SELECT ON dws_data.dws_order TO dws_thiru;

步骤四：添加DWS的连接信息到Power BI的网关列表中 基于 数据仓库 安全角度考虑，GaussDB(DWS)不能直接暴露到公网上，因此Power BI无法一直与GaussDB(DWS)建立连接以实时刷新已发布的报表数据。此时，需参见以下步骤将DWS连接信息添加到Power BI的网关列表中。 访问链接，登录在线Power BI，输入电子邮件和密码，单击“提交”。 在Power BI在线页面，单击左侧“Workspaces”，单击已保存报表的工作区。 图18 选中工作区 单击需要设置的报表右上角的，单击“Settings”。 图19 设置报表 将“Use an On-premises or VNet data gateway”开关打开，并单击“Actions”下面的，在弹出的下拉信息中，单击“Add to gateway”。 图20 添加到网关 填写DWS的连接信息，如表1所示。 表1 添加网关信息 参数 描述 示例 Connection name 连接名称。 用户自定义 Server DWS的连接地址和端口。 192.168.0.196:8000 Database 待连接的DWS数据库名称。 dws_test Authentication method 鉴权方式。 Basic Username 数据库用户名称。 dws_thiru Password 数据库用户密码。 前面用户自定义的密码 Encrypted connection 是否加密连接。 Not encrypted Privacy level 隐私级别。 Organizational 图21 添加网关信息 核对参数无误，单击“Create”。上方新创建的连接信息将出现在网关列表中。 图22 添加网关成功 选择新创的连接名“pbogw_dws_cn1”，单击“Apply”。 网关映射成功。已完成报表与DWS的数据对接。 图23 网关映射成功

查询数据库大小 查询数据库的大小。 1 select datname,pg_size_pretty(pg_database_size(datname)) from pg_database; 示例： 1 2 3 4 5 6 7 select datname,pg_size_pretty(pg_database_size(datname)) from pg_database; datname | pg_size_pretty -----------+---------------- template1 | 61 MB template0 | 61 MB postgres | 320 MB (3 rows)

查询指定SCHEMA下的表大小及表对应索引的大小 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 SELECT t.tablename, indexname, c.reltuples AS num_rows, pg_size_pretty(pg_relation_size(quote_ident(t.tablename)::text)) AS table_size, pg_size_pretty(pg_relation_size(quote_ident(indexrelname)::text)) AS index_size, CASE WHEN indisunique THEN 'Y' ELSE 'N' END AS UNIQUE, idx_scan AS number_of_scans, idx_tup_read AS tuples_read, idx_tup_fetch AS tuples_fetched FROM pg_tables t LEFT OUTER JOIN pg_class c ON t.tablename=c.relname LEFT OUTER JOIN ( SELECT c.relname AS ctablename, ipg.relname AS indexname, x.indnatts AS number_of_columns, idx_scan, idx_tup_read, idx_tup_fetch, indexrelname, indisunique FROM pg_index x JOIN pg_class c ON c.oid = x.indrelid JOIN pg_class ipg ON ipg.oid = x.indexrelid JOIN pg_stat_all_indexes psai ON x.indexrelid = psai.indexrelid ) AS foo ON t.tablename = foo.ctablename WHERE t.schemaname='public' ORDER BY 1,2;

查询数据库 使用gsql的\l元命令查看数据库系统的数据库列表。 1 2 3 4 5 6 7 8 9 10 \l List of databases Name | Owner | Encoding | Collate | Ctype | Access privileges -----------+-------+-----------+---------+-------+------------------- gaussdb | Ruby | SQL_ASCII | C | C | template0 | Ruby | SQL_ASCII | C | C | =c/Ruby + | | | | | Ruby=CTc/Ruby template1 | Ruby | SQL_ASCII | C | C | =c/Ruby + | | | | | Ruby=CTc/Ruby (3 rows) 如果用户在数据库安装的时候没有指定LC_COLLATE、LC_CTYPE参数，则LC_COLLATE、LC_CTYPE参数的默认值为C。 如果用户在创建数据库时没有指定LC_COLLATE、LC_CTYPE参数，则默认使用模板数据库的排序顺序及字符分类。 详细内容可参见CREATE DATABASE参数说明。 通过系统表pg_database查询数据库列表。 1 2 3 4 5 6 7 SELECT datname FROM pg_database; datname ----------- template1 template0 gaussdb (3 rows)

查询表分布键 使用PG_GET_TABLEDEF函数查询某个表（例如表名为customer_t1）的分布键，回显信息中的“HASH(c_last_name)”表示该表分布方式为HASH，且分布键为c_last_name。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 SELECT * FROM PG_GET_TABLEDEF('customer_t1'); pg_get_tabledef ----------------------------------------------------------------------------------- SET search_path = tpchobs; + CREATE TABLE customer_t1 ( + c_customer_sk integer, + c_customer_id character(5), + c_first_name character(6), + c_last_name character(8) + ) + WITH (orientation=column, compression=middle, colversion=2.0, enable_delta=false)+ DISTRIBUTE BY HASH(c_last_name) + TO GROUP group_version1; (1 row) 批量查询多个表的分布方式和分布键，使用以下SQL语句。语句末尾的dbadmin替换为实际的表owner，以下示例为查询dbadmin创建的所有表的分布方式和分布键。 下图回显的distribute_type表示分布方式，例如HASH；distributekey表示分布键，例如ca_address_sk。 1 2 3 4 5 6 7 8 9 10 11 12 13 SELECT pg_catalog.pg_get_userbyid(pc.relowner) AS tableowner, pn.nspname AS schemaname, pc.relname AS tablename, CASE pxc.pclocatortype WHEN 'N' THEN 'ROUND ROBIN' WHEN 'R' THEN 'REPLICATION' WHEN 'H' THEN 'HASH' WHEN 'M' THEN 'MODULO' END AS distribute_type, pc.relkind, getdistributekey(pxc.pcrelid) AS distributekey, pc.reloptions FROM pgxc_class pxc, pg_class pc,pg_namespace pn WHERE pxc.pcrelid = pc.oid AND pn.oid=pc.relnamespace AND tableowner='dbadmin';

快速查询全库中所有表占用空间大小 8.1.3及以上集群版本在大集群大数据量（表数量大于1000）场景下，如果进行全库表查询，建议优先使用pgxc_wlm_table_distribution_skewness视图，该视图可以查到全库内的各表空间使用情况以及数据倾斜分布情况。其中，total_size和avg_size的单位为字节（bytes）。 1 2 3 4 5 6 7 SELECT *, pg_size_pretty(total_size) as tableSize FROM pgxc_wlm_table_distribution_skewness ORDER BY total_size desc; schema_name | table_name | total_size | avg_size | max_percent | min_percent | skew_percent | tablesize --------------------+---------------------------------------------------+------------+-----------+-------------+-------------+--------------+----------- public | history_tbs_test_row_1 | 804347904 | 134057984 | 18.02 | 15.63 | 7.53 | 767 MB public | history_tbs_test_row_3 | 402096128 | 67016021 | 18.30 | 15.60 | 8.90 | 383 MB public | history_tbs_test_row_2 | 401743872 | 66957312 | 18.01 | 15.01 | 7.47 | 383 MB public | i_history_tbs_test_1 | 325263360 | 54210560 | 17.90 | 15.50 | 6.90 | 310 MB 查询结果显示history_tbs_test_row_1表占用空间最大，且数据有一定的倾斜。 视图pgxc_wlm_table_distribution_skewness需要打开GUC参数use_workload_manager和enable_perm_space才能进行查询，在低版本查询全库时建议使用table_distribution()函数，如果仅查询某一张表的大小，推荐使用table_distribution(schemaname text, tablename text)函数。 8.2.1及以上集群版本中，GaussDB(DWS)已支持pgxc_wlm_table_distribution_skewness视图，可直接查询。 在8.1.3集群版本中，可使用如下定义创建视图后再进行查询： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 CREATE OR REPLACE VIEW pgxc_wlm_table_distribution_skewness AS WITH skew AS ( SELECT schemaname, tablename, pg_catalog.sum(dnsize) AS totalsize, pg_catalog.avg(dnsize) AS avgsize, pg_catalog.max(dnsize) AS maxsize, pg_catalog.min(dnsize) AS minsize, (maxsize - avgsize) * 100 AS skewsize FROM pg_catalog.gs_table_distribution() GROUP BY schemaname, tablename ) SELECT schemaname AS schema_name, tablename AS table_name, totalsize AS total_size, avgsize::numeric(1000) AS avg_size, ( CASE WHEN totalsize = 0 THEN 0.00 ELSE (maxsize * 100 / totalsize)::numeric(5, 2) END ) AS max_percent, ( CASE WHEN totalsize = 0 THEN 0.00 ELSE (minsize * 100 / totalsize)::numeric(5, 2) END ) AS min_percent, ( CASE WHEN totalsize = 0 THEN 0.00 ELSE (skewsize / maxsize)::numeric(5, 2) END ) AS skew_percent FROM skew;

步骤一：准备OBS数据 下载数据样例文件。 登录OBS控制台，单击桶列表中已创建好的dws-demo01桶名称。 左侧选择“对象”，单击“新建文件夹”，命名为obs-dws。 进入到obs-dws的文件夹下，单击“上传对象”，将1下载的样例文件上传到obs-dws文件夹下。 获取OBS的Endpoint。 回到obs-dwst桶名的主页面，左侧选择“概览”。 在“ 域名 信息”中记录Endpoint，例如obs.cn-north-4.myhuaweicloud.com。

步骤二：创建OBS的外部服务器和外表 外部服务器（Foreign server）是数据仓库/数据库系统中用于定义和管理对外部数据源（其他数据库、文件系统等）的逻辑连接对象。它的主要作用是支持异构分布式数据的联邦访问，是实现数据整合、实时分析和数据虚拟化的重要工具。 创建OBS外部Server，通过在Server中指定OBS的Endpoint，AK、SK，才可以基于外部Server访问OBS桶数据。 连接数据库后，执行以下SQL语句创建外部服务器。 其中ADDRESS填写5获取地址，AC CES S_KEY、 SECRET_ACCESS_KEY分别填写准备工作中获取账户的AK和SK。 1 2 3 4 5 6 7 CREATE SERVER obs_server FOREIGN DATA WRAPPER DFS_FDW OPTIONS ( ADDRESS 'obs.aaaaa.bbbbb.com', ACCESS_KEY 'xxxxxxxxx', SECRET_ACCESS_KEY 'yyyyyyyyyyyyy', TYPE 'OBS' ); 执行以下SQL，创建名为dws_data的Schema。 1 CREATE SCHEMA dws_data; 切换到新创的Schema下，创建外表。 注意，foldername '/obs-demo01/obs-dws/'请替换为数据文件实际存放的OBS路径，且确保OBS桶与DWS集群在同一个区域下，本例为obs-demo01桶名下的obs-dws文件夹。 SERVER obs_server为1创建的外部服务器实际的名称，本例为obs_server。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 CREATE FOREIGN TABLE dws_data.obs_pq_order ( order_idVARCHAR(14)PRIMARY KEY NOT ENFORCED, order_channel VARCHAR(32), order_timeTIMESTAMP, cust_codeVARCHAR(6), pay_amountDOUBLE PRECISION, real_payDOUBLE PRECISION ) SERVER obs_server OPTIONS ( foldername '/obs-demo01/obs-dws/', format 'parquet', encoding 'utf8' ) READ ONLY DISTRIBUTE BY roundrobin;

步骤四：将GaussDB(DWS)某张表的数据导出到OBS桶 创建一张新的本地表。 1 2 3 4 5 6 7 CREATE TABLE dws_data.dws_order ( order_idVARCHAR(14)PRIMARY KEY, order_channel VARCHAR(32), order_timeTIMESTAMP, cust_codeVARCHAR(6), pay_amountDOUBLE PRECISION, real_payDOUBLE PRECISION ); 插入三条数据。 1 2 3 4 INSERT INTO dws_data.dws_order VALUES ('20230627000001', 'webShop', TIMESTAMP '2023-06-27 10:00:00', 'CUST1', 1000, 1000) , ('20230627000002', 'webShop', TIMESTAMP '2023-06-27 11:00:00', 'CUST2', 5000, 5000) , ('20240309000003', 'webShop', TIMESTAMP '2024-03-09 13:00:00', 'CUST1', 2000, 2000); 创一张外表，用于导出数据到OBS桶。 其中foldername '/obs-demo01/obs-dws/'请替换为实际需要导出的OBS桶路径。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 CREATE FOREIGN TABLE dws_data.obs_orc_order ( order_idVARCHAR(14)PRIMARY KEY NOT ENFORCED, order_channel VARCHAR(32), order_timeTIMESTAMP, cust_codeVARCHAR(6), pay_amountDOUBLE PRECISION, real_payDOUBLE PRECISION ) SERVER obs_server OPTIONS ( foldername '/obs-demo01/obs-dws/', format 'ORC', encoding 'utf8' ) WRITE ONLY DISTRIBUTE BY roundrobin; 执行以下语句，将本地表数据写入OBS外表。 1 2 3 INSERT INTO dws_data.obs_orc_order ( order_id, order_channel, order_time, cust_code, pay_amount, real_pay ) SELECT order_id, order_channel, order_time, cust_code, pay_amount, real_pay FROM dws_data.dws_order; 查询外表，数据写入成功。 1 SELECT * FROM dws_data.obs_orc_order; 成功写入后，您可以登录OBS控制台，查看OBS桶对应路径下是否有数据文件存在。 同时可以验证下，是否允许同一张外表下额外插入数据。 1 2 3 INSERT INTO dws_data.obs_orc_order ( order_id, order_channel, order_time, cust_code, pay_amount, real_pay ) SELECT order_id, order_channel, order_time, cust_code, pay_amount, real_pay FROM dws_data.dws_order; 结果会报错：“the file path specified in the foreign table is not empty”，但如果删除外表中指定的OBS文件路径下的数据文件后，可以重新插入数据。 执行以下语句，验证下是否允许更新和删除外表数据。 1 2 UPDATE dws_data.obs_orc_order SET pay_amount = 3000, real_pay = 3000 WHERE order_id = '20240309000003'; DELETE FROM dws_data.obs_orc_order WHERE order_id = '20240309000003'; 从显示结果看，不支持更新和删除外表数据。

如何群发短信？ 准备群发短信相关数据： 已创建短信应用，并获取APP_Key、APP_Secret和APP接入地址。 （仅国内短信）已申请短信签名，获取签名通道号。 已申请短信模板，并获取模板ID。 您可以使用如下三种方式群发短信： 调用发送短信API，向单个或多个用户发送相同内容的短信。 调用发送分批短信API，向多个用户发送不同内容的短信。 通过群发助手提交发送任务。 群发助手暂不支持发送验证码类短信。 父主题： 短信发送相关