华为云用户手册

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 caption String 数据集语义化名称。 最小长度：0 最大长度：128 domain_id String 租户ID。 最小长度：0 最大长度：128 ds_id String 数据源ID。 最小长度：0 最大长度：128 ds_type String 数据源类型。 最小长度：0 最大长度：128 id String 数据集ID。 最小长度：0 最大长度：128 logical_schema 表4 object 数据集逻辑schema。 physical_schema 表13 object 数据集物理schema。 project_id String 项目ID 最小长度：0 最大长度：128 version String 数据集版本：默认为2.0，1.0|2.0。 最小长度：0 最大长度：128 workspace_id String 项目ID（DataArts Insight侧概念）。 最小长度：0 最大长度：128 create_date Long 创建时间戳。 最小值：0 最大值：9223372036854775807 create_user String 创建者ID。 最小长度：0 最大长度：128 create_user_name String 创建者名称。 最小长度：0 最大长度：128 update_date Long 更新时间戳。 最小值：0 最大值：9223372036854775807 update_user String 更新者ID。 最小长度：0 最大长度：128 update_user_name String 更新者名称。 最小长度：0 最大长度：128 resource_code String 数据集资源标识 最小长度：0 最大长度：64 表4 LogicalSchema 参数 参数类型 描述 field_schema 表5 object 字段schema。 relations Array of 表10 objects 物理表关系。 数组长度：0-2147483647 variables Array of 表12 objects SQL变量列表。 数组长度：0-2147483647 表5 DatasetFieldSchemaVO 参数 参数类型 描述 dimensions Array of 表6 objects 维度。 数组长度：0-2147483647 measures Array of 表9 objects 度量。 数组长度：0-2147483647 表6 DimensionVo 参数 参数类型 描述 caption String 维度语义化名。 最小长度：0 最大长度：128 cube_id String 维度所属物理表ID。 最小长度：0 最大长度：128 description String 维度描述。 最小长度：0 最大长度：1000 id String 维度ID。 最小长度：0 最大长度：128 hierarchies Array of 表7 objects 维度层级。 数组长度：0-2147483647 表7 Hierarchy 参数 参数类型 描述 caption String 层级结构语义化名。 最小长度：0 最大长度：128 levels Array of 表8 objects 层级结构level。 数组长度：0-2147483647 表8 LevelVO 参数 参数类型 描述 caption String 语义化名。 最小长度：0 最大长度：128 column_formula String level表达式。 最小长度：0 最大长度：128 data_type String 字段类型：STRING|DATE|DATETIME。 枚举值： STRING|DATE|DATETIME expansion_type Integer 扩展字段类型：0-普通扩展字段；1-聚合扩展字段。 最小值：0 最大值：1 id String ID 最小长度：0 最大长度：128 is_expansion Integer 是否为扩展字段：0-不是；1-是。 枚举值： 0 1 level_type String level类型。 最小长度：0 最大长度：128 origin_column_name String 原始字段名称。 最小长度：0 最大长度：128 origin_column_type String 原始字段类型。 最小长度：0 最大长度：128 origin_data_type String 转换前的数据类型：STRING|DATE|DATETIME。 最小长度：0 最大长度：128 枚举值： STRING|DATE|DATETIME 表9 MeasureVo 参数 参数类型 描述 caption String 度量语义化名。 最小长度：0 最大长度：128 column_formula String 度量字段表达式。 最小长度：0 最大长度：1000 cube_id String 字段所属物理表id。 最小长度：0 最大长度：128 data_type String 数据类型：STRING|NUMBER|DATE|DATETIME。 最小长度：0 最大长度：128 枚举值： STRING|NUMBER|DATE|DATETIME expansion_type Integer 扩展字段类型：0-普通扩展字段；1-聚合扩展字段。 最小值：0 最大值：1 id String 度量ID。 最小长度：0 最大长度：128 is_expansion Integer 是否为扩展字段：0-不是；1-是。 最小值：0 最大值：1 origin_column_name String 原始字段名称。 最小长度：0 最大长度：128 origin_column_type String 原始字段类型。 最小长度：0 最大长度：128 origin_data_type String 转换前的数据类型：STRING|NUMBER|DATE|DATETIME。 最小长度：0 最大长度：128 枚举值： STRING|NUMBER|DATE|DATETIME 表10 DatasetRelationVO 参数 参数类型 描述 join_type String 关联类型：left join|right join|inner join。 最小长度：0 最大长度：128 joins Array of 表11 objects 关联键。 数组长度：0-2147483647 relation String 关系类型：one-to-one|one-to-many|many-to-one。 最小长度：0 最大长度：128 source String 源表ID。 最小长度：0 最大长度：128 target String 目标表ID。 最小长度：0 最大长度：128 表11 DatasetJoinVO 参数 参数类型 描述 condition String 关系，equal-to。 最小长度：0 最大长度：128 source_key String 源字段ID。 最小长度：0 最大长度：128 source_type String 源字段类型：dimension|measure。 最小长度：0 最大长度：64 target_key String 目标字段ID。 最小长度：0 最大长度：128 target_type String 目标字段类型：dimension|measure。 最小长度：0 最大长度：64 表12 SqlVariable 参数 参数类型 描述 default_values Array of objects 变量默认值。 数组长度：0-3000 format String 变量格式，针对日期时间类型变量有效。 最小长度：0 最大长度：128 name String 变量名称 最小长度：0 最大长度：128 type String 变量类型：STRING|NUMBER|DATE|DATETIME|TIMESTAMP。 枚举值： STRING|NUMBER|DATE|DATETIME|TIMESTAMP use_scope String 变量作用域，dataset|global。 最小长度：0 最大长度：128 表13 PhysicalSchema 参数 参数类型 描述 tables Array of 表14 objects 物理表信息。 数组长度：0-2147483647 表14 DatasetTableVO 参数 参数类型 描述 id String 表ID。 最小长度：0 最大长度：64 database_name String 数据库。 最小长度：0 最大长度：128 schema_name String schema名称。 最小长度：0 最大长度：128 table_name String 表名 最小长度：0 最大长度：128 table_type String 数据集类型。 最小长度：0 最大长度：128 sql_text String 查询SQL。 最小长度：0 最大长度：5000 is_fact_table Boolean 是否为端点表

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192

响应示例 导入任务详情。 { "id" : "2406a337-xxxx-a5b2-b01a61d2043b", "name" : "string", "domain_id" : "ad9e2f08-xxxx-87eb-1f9619b6c313", "project_id" : "string", "workspace_id" : "12913c92-xxxx-b8fd-a72af3945b61", "import_param" : "", "obs_bucket" : "test", "obs_object_key" : "test.zip", "import_detail" : "导入成功【 导出资源清单 】 数据源: 1 ;【 导入参数清单 】: 目标工作空间: 示例工作空间 ; 是否替换: false ;是否携带权限信息：false", "status" : 1, "error_msg" : "string", "import_type" : "import|crossSpaceImport", "create_user" : "string", "create_user_name" : "string", "create_date" : 9223372036854776000, "update_date" : 9223372036854776000 }

请求示例 POST https://{endpoint}/v1/{project_id}/datasets/save { "id" : "string", "caption" : "id", "status" : "string", "description" : "string", "ds_id" : "string", "ds_name" : "string", "ds_type" : "string", "table_type" : "table|sql", "resource_code" : "string", "physical_schema" : { "tables" : [ { "database_name" : "db_test", "is_fact_table" : false, "schema_name" : "public", "sql_text" : "SELECT * FROM FACT_GDP", "table_name" : "t_test", "table_type" : "table" } ] }, "logical_schema" : { "field_schema" : { "columns" : [ { "caption" : "age", "origin_column_name" : "age", "schema_name" : "public", "table_name" : "modern_bi_0xxxx1c590b14d9xxxx35227166f7f02" } ] }, "variables" : [ { "default_values" : [ "aaa", "bbb" ], "format" : "yyyy-MM-dd", "name" : "limit", "type" : "STRING", "use_scope" : "dataset" } ], "relations" : [ { "source_database_name" : "string", "source_schema" : "string", "source_table_name" : "string", "target_database_name" : "string", "target_schema" : "string", "target_table_name" : "string", "join_type" : "string", "relation" : "string", "joins" : [ { "condition" : "equal-to", "source_key" : "city", "target_key" : "city" } ] } ] } }

响应参数 状态码： 200 表12 响应Body参数 参数 参数类型 描述 caption String 数据集语义化名称。 最小长度：0 最大长度：128 domain_id String 租户ID。 最小长度：0 最大长度：128 ds_id String 数据源ID。 最小长度：0 最大长度：128 ds_type String 数据源类型。 最小长度：0 最大长度：128 id String 数据集ID。 最小长度：0 最大长度：128 logical_schema 表13 object 数据集逻辑schema。 physical_schema 表22 object 数据集物理schema。 project_id String 项目ID。 最小长度：0 最大长度：128 version String 数据集版本：默认为2.0，1.0|2.0。 最小长度：0 最大长度：128 workspace_id String 项目ID（DataArts Insight侧概念）。 最小长度：0 最大长度：128 create_date Long 创建时间戳。 最小值：0 最大值：9223372036854775807 create_user String 创建者ID。 最小长度：0 最大长度：128 create_user_name String 创建者名称。 最小长度：0 最大长度：128 update_date Long 更新时间戳。 最小值：0 最大值：9223372036854775807 update_user String 更新者ID。 最小长度：0 最大长度：128 update_user_name String 更新者名称。 最小长度：0 最大长度：128 resource_code String 数据集资源标识。 最小长度：0 最大长度：64 表13 LogicalSchema 参数 参数类型 描述 field_schema 表14 object 字段schema。 relations Array of 表19 objects 物理表关系。 数组长度：0-2147483647 variables Array of 表21 objects SQL变量列表。 数组长度：0-2147483647 表14 DatasetFieldSchemaVO 参数 参数类型 描述 dimensions Array of 表15 objects 维度 数组长度：0-2147483647 measures Array of 表18 objects 度量 数组长度：0-2147483647 表15 DimensionVo 参数 参数类型 描述 caption String 维度语义化名。 最小长度：0 最大长度：128 cube_id String 维度所属物理表ID。 最小长度：0 最大长度：128 description String 维度描述。 最小长度：0 最大长度：1000 id String 维度ID。 最小长度：0 最大长度：128 hierarchies Array of 表16 objects 维度层级。 数组长度：0-2147483647 表16 Hierarchy 参数 参数类型 描述 caption String 层级结构语义化名。 最小长度：0 最大长度：128 levels Array of 表17 objects 层级结构level。 数组长度：0-2147483647 表17 LevelVO 参数 参数类型 描述 caption String 语义化名。 最小长度：0 最大长度：128 column_formula String level表达式。 最小长度：0 最大长度：128 data_type String 字段类型，STRING|DATE|DATETIME。 枚举值： STRING|DATE|DATETIME expansion_type Integer 扩展字段类型：0-普通扩展字段；1-聚合扩展字段。 最小值：0 最大值：1 id String ID 最小长度：0 最大长度：128 is_expansion Integer 是否为扩展字段：0-不是、1-是。 枚举值： 0 1 level_type String level类型。 最小长度：0 最大长度：128 origin_column_name String 原始字段名称。 最小长度：0 最大长度：128 origin_column_type String 原始字段类型。 最小长度：0 最大长度：128 origin_data_type String 转换前的数据类型，STRING|DATE|DATETIME。 最小长度：0 最大长度：128 枚举值： STRING|DATE|DATETIME 表18 MeasureVo 参数 参数类型 描述 caption String 度量语义化名。 最小长度：0 最大长度：128 column_formula String 度量字段表达式。 最小长度：0 最大长度：1000 cube_id String 字段所属物理表id 最小长度：0 最大长度：128 data_type String 数据类型，STRING|NUMBER|DATE|DATETIME。 最小长度：0 最大长度：128 枚举值： STRING|NUMBER|DATE|DATETIME expansion_type Integer 扩展字段类型，0-普通扩展字段 1-聚合扩展字段。 最小值：0 最大值：1 id String 度量ID。 最小长度：0 最大长度：128 is_expansion Integer 是否为扩展字段：0-不是，1-是。 最小值：0 最大值：1 origin_column_name String 原始字段名称。 最小长度：0 最大长度：128 origin_column_type String 原始字段类型。 最小长度：0 最大长度：128 origin_data_type String 转换前的数据类型，STRING|NUMBER|DATE|DATETIME。 最小长度：0 最大长度：128 枚举值： STRING|NUMBER|DATE|DATETIME 表19 DatasetRelationVO 参数 参数类型 描述 join_type String 关联类型，left join|right join|inner join。 最小长度：0 最大长度：128 joins Array of 表20 objects 关联键。 数组长度：0-2147483647 relation String 关系类型，one-to-one|one-to-many|many-to-one。 最小长度：0 最大长度：128 source String 源表ID。 最小长度：0 最大长度：128 target String 目标表ID。 最小长度：0 最大长度：128 表20 DatasetJoinVO 参数 参数类型 描述 condition String 关系，equal-to。 最小长度：0 最大长度：128 source_key String 源字段id。 最小长度：0 最大长度：128 source_type String 源字段类型：dimension|measure。 最小长度：0 最大长度：64 target_key String 目标字段ID。 最小长度：0 最大长度：128 target_type String 目标字段类型：dimension|measure。 最小长度：0 最大长度：64 表21 SqlVariable 参数 参数类型 描述 default_values Array of objects 变量默认值。 数组长度：0-3000 format String 变量格式，针对日期时间类型变量有效。 最小长度：0 最大长度：128 name String 变量名称。 最小长度：0 最大长度：128 type String 变量类型，STRING|NUMBER|DATE|DATETIME|TIMESTAMP。 枚举值： STRING|NUMBER|DATE|DATETIME|TIMESTAMP use_scope String 变量作用域，dataset|global。 最小长度：0 最大长度：128 表22 PhysicalSchema 参数 参数类型 描述 tables Array of 表23 objects 物理表信息。 数组长度：0-2147483647 表23 DatasetTableVO 参数 参数类型 描述 id String 表ID。 最小长度：0 最大长度：64 database_name String 数据库。 最小长度：0 最大长度：128 schema_name String schema名称。 最小长度：0 最大长度：128 table_name String 表名。 最小长度：0 最大长度：128 table_type String 数据集类型。 最小长度：0 最大长度：128 sql_text String 查询SQL。 最小长度：0 最大长度：5000 is_fact_table Boolean 是否为端点表。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：128 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 数据集ID。 最小长度：0 最大长度：128 caption 是 String 数据集语义化名称。 最小长度：0 最大长度：128 status 否 String 数据集状态：0，1。 最小长度：0 最大长度：128 description 否 String 数据集描述。 最小长度：0 最大长度：1000 ds_id 是 String 数据源ID。 最小长度：0 最大长度：128 ds_name 否 String 数据源名称。 最小长度：0 最大长度：128 ds_type 否 String 数据源类型。 最小长度：0 最大长度：128 table_type 是 String 数据集类型： table：不含自定义SQL表的数据集。 sql：含自定义SQL表的数据集。 最小长度：0 最大长度：128 resource_code 否 String 数据集资源标识。 最小长度：0 最大长度：64 physical_schema 是 表4 object 数据集物理schema。 logical_schema 是 表6 object 数据集逻辑schema。 表4 PhysicalOpenApiSchema 参数 是否必选 参数类型 描述 tables 是 Array of 表5 objects 物理表信息。 数组长度：0-2147483647 表5 DatasetTableOpenApiVO 参数 是否必选 参数类型 描述 database_name 是 String 数据库。 最小长度：0 最大长度：128 is_fact_table 是 Boolean 是否为端点表。 schema_name 否 String 模式。 最小长度：0 最大长度：128 sql_text 否 String 查询SQL。 最小长度：0 最大长度：128 table_name 是 String 表名。 最小长度：0 最大长度：128 table_type 是 String 表类型： table：物理表。 sql：自定义SQL表。 最小长度：0 最大长度：128 表6 LogicalSchemaOpenApiVO 参数 是否必选 参数类型 描述 filed_schema 否 表7 object 字段选择信息。 variables 否 Array of 表9 objects SQL变量列表。 数组长度：0-2147483647 relations 否 Array of 表10 objects 物理表关系 数组长度：0-2147483647 表7 DatasetFieldSchemaOpenApiVO 参数 是否必选 参数类型 描述 columns 否 Array of 表8 objects 字段选择列表和字段名称赋值。 数组长度：0-10000 表8 ColumnOpenApiVO 参数 是否必选 参数类型 描述 caption 是 String 字段名称。 最小长度：0 最大长度：512 origin_column_name 是 String 字段物理名称，即表中名称。 最小长度：0 最大长度：64 schema_name 否 String 字段所属schema。 最小长度：0 最大长度：64 table_name 是 String 字段所属名 最小长度：0 最大长度：64 表9 SqlVariable 参数 是否必选 参数类型 描述 default_values 否 Array of objects 变量默认值。 数组长度：0-3000 format 否 String 变量格式，针对日期时间类型变量有效。 最小长度：0 最大长度：128 name 是 String 变量名称 最小长度：0 最大长度：128 type 是 String 变量类型：STRING|NUMBER|DATE|DATETIME|TIMESTAMP 枚举值： STRING|NUMBER|DATE|DATETIME|TIMESTAMP use_scope 是 String 变量作用域，dataset|global。 最小长度：0 最大长度：128 表10 DatasetRelationOpenApiVO 参数 是否必选 参数类型 描述 source_database_name 是 String 源表所属数据库名称。 最小长度：0 最大长度：128 source_schema 否 String 源表所属schema名称。 最小长度：0 最大长度：64 source_table_name 是 String 源表名称。 最小长度：0 最大长度：64 target_database_name 是 String 目标表所属数据库名称。 最小长度：0 最大长度：128 target_schema 否 String 目标表所属schema名称。 最小长度：0 最大长度：64 target_table_name 是 String 目标表名称。 最小长度：0 最大长度：64 join_type 是 String 关联类型。 最小长度：0 最大长度：128 relation 是 String 关系类型。 最小长度：0 最大长度：128 joins 是 Array of 表11 objects 关联键 数组长度：0-2147483647 表11 DatasetJoinOpenApiVO 参数 是否必选 参数类型 描述 condition 是 String 关联关系，默认equal-to。 最小长度：0 最大长度：128 source_key 是 String 源表字段。 最小长度：0 最大长度：128 target_key 是 String 目标表字段。 最小长度：0 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。 X-Auth-Token 是 String 用户Token。 Content-Type 是 String 固定值，指定请求体类型和字符集。 表3 请求Body参数 参数 是否必选 参数类型 描述 service_type 是 String 服务类型。 obs_endpoint 是 String OBS终端节点。 obs_bucket_name 是 String OBS桶名。 max_storage_days 是 Integer 导出文件在OBS的最大存储时间。 obs_path_prefix 是 String OBS前缀路径。

请求示例 POST https://{endpoint}/v1/{project_id}/exports/config { "service_type" : "obs", "obs_endpoint" : "obs.xxx.com", "obs_bucket_name" : "xxxxx", "max_storage_days" : 1, "obs_path_prefix" : "/dataArts-insight" }

URI GET /v1/{project_id}/tags/head 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 用户类型（用户或用户组）。 offset 否 Integer 返回条目的起始offset，默认值0。 limit 是 Integer 返回列表数量。

响应示例 状态码：200 查询数据集和目录列表成功。 { "count" : 216, "page_data" : [ { "id" : "4df79d49-444c-xxxxx-28f9cfeac554", "name" : "保存数据集", "type" : "table", "permission_list" : [ "edit", "use" ], "workspace_id" : "e77ff0dxxxxxxx1b59fac2cc12faa146f", "project_id" : "34ba64e53a02xxxxxxx75669a8cc17bd", "create_user" : "558def45cexxxxxxxxa20e463e017", "create_user_name" : "xxxxxxxxx", "create_date" : 1704533906073, "update_user" : "558def4xxxxxxxxx648a20e463e017", "update_user_name" : "xxxxxxxx", "update_date" : 1704533906073, "description" : null, "ds_id" : "ff8080818xxxxxxf101886aab31a900e1", "ds_type" : "DWS", "ds_name" : "dws04_public", "routing_strategy" : "Direct", "resource_code" : "xxx" } ] }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 数据数量。 最小值：0 最大值：2147483647 page_data Array of 表5 objects 数据 数组长度：0-2147483647 表5 DatasetListVO 参数 参数类型 描述 create_date Long 创建时间。 最小值：0 最大值：9223372036854774807 create_user String 创建人ID。 最小长度：0 最大长度：128 create_user_name String 创建人姓名。 最小长度：0 最大长度：128 description String 描述。 最小长度：0 最大长度：1024 id String ID 最小长度：0 最大长度：128 name String 名称。 最小长度：0 最大长度：128 permission_list Array of strings 当前用户拥有的协同授权权限点。 edit，export，use，read。 最小长度：0 最大长度：128 数组长度：0-10000 project_id String 项目ID。 最小长度：0 最大长度：128 type String 类型：datasource，dataset，dashboard，screen。 最小长度：0 最大长度：128 update_date Long 修改时间。 最小值：0 最大值：9223372036854774807 update_user String 修改人ID。 最小长度：0 最大长度：128 update_user_name String 修改人姓名。 最小长度：0 最大长度：128 workspace_id String 工作空间ID。 最小长度：0 最大长度：128 ds_name String 绑定的数据源名称。 最小长度：0 最大长度：255 ds_type String 绑定的数据源类型：MYSQL、POSTGRESQL、DWS、OPENGAUSS、 DLI 、CLICKHOUSE、API、DORIS 最小长度：0 最大长度：64 枚举值： MYSQL POSTGRESQL DWS OPENGAUSS DLI CLICKHOUSE API DORIS ds_id String 绑定的数据源ID。 最小长度：0 最大长度：64 routing_strategy String 查询数据时的路由策略。Direct：直连；Accelerator：内存引擎。 最小长度：0 最大长度：32 resource_code String 数据集资源标识。 最小长度：0 最大长度：64

URI GET /v1/{project_id}/datasets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 最小长度：0 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 数据集名称。 最小长度：0 最大长度：128 sort_dir 否 String 是否降序。 最小长度：0 最大长度：128 sort_key 否 String 排序字段。 最小长度：0 最大长度：128 limit 否 Integer 返回条目数。不传该参数时，默认查询前10条信息。取值范围：[0,1000] 默认值：10。 最小值：0 最大值：1000 offset 否 Integer 返回条目的起始offset。取值范围：[0,1000] 默认值：0。 最小值：0 最大值：1000

URI DELETE /v1/{project_id}/datasets/{dataset_id}/permissions/{permission_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 dataset_id 是 String 数据集ID。 permission_id 是 String permission_id。

请求示例 POST https://{endpoint}/v1/{project_id}/datasets/{dataset_id}/permissions { " dataset_permissions " : [ { "id" : "xxxxfdff-xxxx-43cb-8f52-e15e35axxxxx", "name" : "COLUMN", "dataset_id" : "1e27d682-xxxx-4589-ad8e-673f02d395f4", "is_open" : true, "permission_type" : "COLUMN", "rule_type" : "MASK", "rule_scope" : "ALL", "project_id" : "xxxx6703a500xxxx2fb3c00f9fxxxxxx", "workspace_Id" : "xxxx6703a50xxxxx2fb3c00f9fxxxxxx", "rule_user" : { "users" : [ ], "user_groups" : [ ] }, "rule_content" : { "last" : 1, "first" : 1, "mask_type" : "RETAIN_FIRST_N_LAST_M", "column_ids" : [ "xxxxx9d6-6dae-xxxx-bd51-36fc0exxxxxx.amount" ], "special_words" : [ "xxx" ] }, "display_fields" : { "user_map" : { }, "group_map" : { }, "field_map" : { "xxxxx9d6-6dae-4126-xxxx-36fc0exxxxxx.amount" : "amount" } } }, { "id" : "xxxxxa33-dace-xxxx-8ddf-c6dfa48xxxxx", "name" : "USER_TAG", "dataset_id" : "xxxx4d13-c2a3-xxxx-b657-829addaxxxxx", "is_open" : true, "permission_type" : "ROW", "rule_type" : "BY_TAG", "rule_scope" : "ALL", "rule_user" : { "users" : [ ], "user_groups" : [ ] }, "rule_content" : { "condition_node" : null, "logic_operator" : "AND", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "xxxx3355-4ffa-xxxx-9b5d-0bd85668xxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxx6722-b74c-xxxx-9630-43ca65xxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null }, { "condition_node" : { "value" : { "values" : [ "xxxxx355-4ffa-4340-9b5d-0bd856xxxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxxx722-b74c-4752-xxxx-43ca65dxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null } ] }, "display_fields" : null }, { "id" : "xxxxxb04-ef3d-4ebc-a9ee-c651f5xxxxxx", "name" : "测试", "dataset_id" : "xxxxxd13-c2a3-426f-xxxx-xxxxxdaba20e", "is_open" : true, "permission_type" : "ROW", "rule_type" : "BY_CONDITION", "rule_scope" : "SPECIFIED", "rule_user" : { "users" : [ "xxxxx57ed1b9453xxxxx43de304xxxxx", "xxxxx987b3dcxxxxb68b8dff1e7xxxxx", "xxxxxac55eeb4950aabc86513080f9ba" ], "user_groups" : [ ] }, "rule_content" : { "condition_node" : null, "logic_operator" : "AND", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "123" ], "value_type" : "CONDITION" }, "column_id" : "xxxx6722-b74c-xxxx-9630-43ca65dxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "CONTAIN" }, "logic_operator" : null }, { "condition_node" : null, "logic_operator" : "OR", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "qwe" ], "value_type" : "CONDITION" }, "column_id" : "xxxxx722-b74c-xxxx-9630-43ca65dxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "CONTAIN" }, "logic_operator" : null } ] } ] }, "display_fields" : { "user_map" : { "xxxxx987b3dc4xxxx68b8dff1exxxxxx" : "auth_test", "xxxxxac55eeb4xxxxabc865130xxxxxx" : "chenxiantao", "xxxxx57ed1b94xxxx6c943de30xxxxxx" : "abac_test" }, "group_map" : { }, "field_map" : null } } ] }

请求示例 数据源新增。 POST /v1/{project_id}/connections 1.新增公网连接类型数据源 { "name": "dws02", "server_list": "xx.xx.x.xx:xxxx", "database_name": "gaussdb", "user_name": "xxxxx", "password": "xxxxxxx", "config": { "ssl": true }, "source": "public", "type": "DWS" } 2.新增DWS云数据源 { "name": "dws04_instance", "description": "测试新增", "source": "dws", "type": "DWS", "database_name": "xxxxx", "user_name": "xxxx", "password": "xxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxxxxxx" }, "config": { "ssl": false } } 3.新增RDS的MySQL云数据源 { "name": "mysql_instance", "description": "测试新增", "source": "rds", "type": "MySQL", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxxxxxx" }, "config": { "ssl": false } } 4.新增 GaussDB ForMySQL云数据源 { "name": "gaussdb_mysql_instance", "description": "测试新增", "source": "gaussdb", "type": "MySQL", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxx" }, "config": { "ssl": false } } 5.新增OpenGauss云数据源 { "name": "gaussdb_instance", "description": "测试新增", "source": "gaussdb", "type": "OpenGauss", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxx" }, "config": { "ssl": false } } 6.新增PostgreSQL云数据源 { "name": "postgre_instance", "description": "测试新增", "source": "rds", "type": "PostgreSQL", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxx" }, "config": { "ssl": false } }

计费项 目前智能数据洞察（DataArts Insight）的计费项由通用用户数数组成。 表1 计费项 计费项 产品版本 计费项说明 适用的计费模式 计费公式 通用用户数 企业版 计费因子：通用用户个数。 包年/包月 通用用户个数*单价*购买时长。 大屏 企业版 计费因子：大屏发布个数。 包年/包月 大屏数量*单价*购买时长。 嵌入分析 企业版 计费因子：嵌入分析开通个数。 包年/包月 嵌入分析*单价*购买时长。

计费模式 目前智能数据洞察（DataArts Insight）提供包年/包月的计费模式。 包年/包月：一种预付费模式，即先付费再使用，按照订单的购买周期进行结算。购买周期越长，享受的折扣越大。 阶梯计费：用户购买不同的通用用户数计费方式。 表1 企业版计费说明 计费项 周期 说明 企业版 包年/包月 包月周期计算公式：用户数*月单价 * 月数 包年周期计算公式：用户数*年单价 * 年数 表2 大屏计费说明 计费项 周期 说明 数据大屏 包年/包月 企业版默认赠送5个。 包月周期计算公式：大屏数量 * 月单价 * 月数 包年周期计算公式：大屏数量 * 年单价 * 年数 表3 嵌入式报表计费说明 计费项 周期 说明 嵌入式报表 包年/包月 企业版默认赠送5个。 包月周期计算公式：嵌入式报表数量 * 月单价 * 月数 包年周期计算公式：嵌入式报表数量 * 年单价 * 年数 包年周期费用是月单价 * 10。

响应消息 响应参数说明请参见下表： 参数 是否必选 类型 取值范围 说明 resultCode M String 6 调用结果码。 具体请参见调用结果码说明。 resultMsg O String 255 调用结果描述。 响应消息示例： { "resultCode":"000000", "resultMsg":"success." } HTTP Body签名: Body-Sign: sign_type="HMAC-SHA256", signature= "xxxxxxxxxxxxx" ，详情参考《HTTP Body签名》。

RDS for MySQL产品生命周期 RDS for MySQL在MySQL社区版本生命周期的基础上，延长了支持时间。在延长期内，RDS for MySQL会持续发布新的版本，新版本仅限于对严重影响实例安全和稳定的问题进行修复。由于MySQL社区对安全类问题进行了保密处理，华为云RDS for MySQL并不能承诺修复所有严重的安全和稳定性问题。 RDS for MySQL基于MySQL开源社区提供数据库云服务，本文将为您介绍RDS for MySQL的版本策略，您可以根据此信息进行规划，在创建实例、数据迁移等操作时选择更合适的目标版本。 华为云延长支持停止时间，是为用户迁移业务提供更充裕的时间。数据迁移的具体操作，请参见RDS for MySQL迁移到RDS for MySQL。 华为云对RDS for MySQL内核的支持停止时间参见表1。 表1中的部分时间为预计时间，将会在生命周期结束或RDS for MySQL停止支持前进行修正，请以实际时间为准。 华为云RDS for MySQL产品生命周期结束后，将不再售卖，并且对存量实例不提供维护服务（例如漏洞补丁修改等），不支持规格扩容。 请您提前制定版本升级或者数据迁移等操作的计划。 表1 华为云RDS for MySQL生命周期 MySQL版本号 社区发布时间 社区生命周期结束时间 华为云发布时间 华为云EOM（停止销售）时间 华为云EOS（停止服务）时间 5.6 2013年2月5日 2021年2月1日 2017年3月 2024年06月30日 2024年12月30日 5.7 2015年10月21日 2023年10月25日 2018年3月 2024年12月30日 2025年6月30日 8.0 2018年9月14日 2026年4月 2019年2月 2030年08月30日 - 以上RDS for MySQL生命周期发布时间是2024-01-01。 父主题： RDS for MySQL版本发布说明

修订记录 发布日期 修改说明 2024-05-16 第三次正式发布，包含以下内容： 新增内存使用率高怎么处理。 新增清理表的数据碎片。 新增错误日志页面显示handle_sync_msg_from_slave my_net_read error:-1。 2024-01-23 第二次正式发布，包含以下内容： 读写分离地址修改为代理地址，具体请参见对各个IP地址的解释说明。 2023-04-10 第一次正式发布。

原因一：内存相关参数设置不合理 GaussDB(for MySQL)中存在许多与内存相关的参数，表1-2列举了部分参数。当这些参数设置不合理时，可能会导致内存利用率过高。 表1 内存相关的参数 序号 参数名称 参数描述 1 innodb_buffer_pool_size InnoDB buffer pool大小。Global级别，容量不会缩减。 2 table_open_cache 表缓存的最大打开表数量。Global级别，当open_tables等于table_open_cache且opened_tables在不断增大时，可以适当调大table_open_cache。 3 sort_buffer_size 排序buffer大小。Session级别，调大值可以提高排序操作的性能，过大可能会导致内存不足。 针对上述原因，您可以采取以下处理措施： 内存相关参数值尽量使用默认值。 根据实际情况，合理配置相关参数。

原因二：存在大量消耗内存的查询语句 一些涉及到排序或者分组的语句会使用到临时表，当并发量过大、查询中间结果过多时，会导致临时表占用过多内存，出现实例OOM风险。 针对上述原因，您可采取以下处理措施： 可以使用EXPLAIN命令检查Extra列是否显示Using Temporary，确定语句是否会用到临时表，对于使用临时表的SQL语句进一步分析查询计划和重写查询语句，尽量减少临时表的使用。表2列举了部分需要使用临时表的SQL语句。 表2 需要使用临时表的场景 序号 场景 1 UNION查询。 2 用到TEMPTABLE算法或者是UNION查询中的视图。 3 ORDER BY和GROUP BY的子句不一样时。 4 表连接中，ORDER BY的列不是驱动表中的。 5 DISTINCT查询并且加上ORDER BY时。 6 SQL中用到SQL_SMALL_RESULT修饰符的查询。 7 FROM中的子查询（派生表）。 8 子查询或者SEMI-JOIN时创建的表。 9 评估多表UPDATE语句。 10 评估GROUP_CONCAT()或COUNT(DISTINCT)表达式计算。 创建合适的索引，减小查询结果的数量，来控制临时表使用的内存。 使用LIMIT子句限制查询结果的数量，避免一次性返回大量数据。 对于需要大量使用内存的SQL语句，减小并发度，避免内存突增导致实例OOM。 结合业务情况扩大实例规格。

内存使用率高的排查思路 以下排查思路根据原因的出现概率进行排序，建议您从高频率原因往低频率原因排查，从而帮助您快速找到问题的原因。 如果解决完某个可能原因仍未解决问题，请继续排查其他可能原因。 图1 内存使用率高的排查思路 序号 可能原因 解决方案 1 内存相关参数设置不合理。 请参见原因一：内存相关参数设置不合理。 2 存在大量消耗内存的查询语句。 请参见原因二：存在大量消耗内存的查询语句。 3 开启了消耗内存的特性。 请参见原因三：开启了消耗内存的特性。

原因三：开启了消耗内存的特性 部分特性开启会占用一定的内存空间。例如对小规格实例（如：2U4GB），开启performance_schema会带来一定的内存开销，可能会导致内存占用比例明显增大。 针对上述原因，您可以采取以下处理措施： 排查是否开启了消耗内存的特性，如performance_schema、plan cache、ptrc等。根据实际情况，考虑是否需要关闭相应特性。 结合业务情况扩大实例规格。

修订记录 发布日期 修改说明 2024-05-16 第二十次正式发布。 新增GaussDB(for MySQL)实例在空负载下CPU占用说明。 2024-05-09 第十九次正式发布。 新增慢日志监控中显示存在慢SQL，但日志管理中慢日志页面没有对应慢SQL信息。 2024-01-23 第十八次正式发布。 读写分离地址修改为代理地址。 2023-12-18 第十七次正式发布。 新增GaussDB(for MySQL)支持打开general_log吗？。 2023-11-08 第十六次正式发布。 GaussDB(for MySQL)服务如何开启并查看Binlog文件？，修改开启Binlog的方法。 2023-10-12 第十五次正式发布，新增以下内容： 新增GaussDB(for MySQL)的临时盘使用说明。 2023-08-31 第十四次正式发布，新增以下内容： 新增GaussDB(for MySQL)实例连接失败怎么办。 2023-07-24 第十三次正式发布，新增以下内容： 新增使用INSTANT方式快速添加列。 2023-05-16 第十二次正式发布，新增以下内容： 新增如何查看GaussDB(for MySQL)数据库的死锁日志。 2023-03-30 第十一次正式发布，新增以下内容： 新增联合索引设置不当导致慢SQL的解决办法。 新增联合索引设置不当导致慢SQL的解决办法。 新增持锁长事务导致后续业务报等锁超时的解决办法。 2023-02-22 第十次正式发布，新增以下内容： 新增如何修改Binlog保留时长。 优化GaussDB(for MySQL)服务如何开启并查看Binlog文件？。 2022-11-22 第九次正式发布，新增以下内容： 优化GaussDB(for MySQL)如何设置表名大小写敏感。 2022-11-03 第八次正式发布，新增以下内容： 优化如何通过JDBC连接MySQL数据库。 2022-08-30 第七次正式发布，新增以下内容： 新增资源冻结/解冻/释放/删除/退订。 2022-07-30 第六次正式发布，新增以下内容： 新增如何修改GaussDB(for MySQL)数据库字符集。 新增是否支持使用SQL命令修改全局参数。 新增GaussDB(for MySQL)如何设置表名大小写敏感。 新增使用utf8mb4字符集存储emoji表情到GaussDB(for MySQL)实例。 新增GaussDB(for MySQL)是否支持版本升级。 新增如何查看GaussDB(for MySQL)备份空间使用情况。 新增GaussDB(for MySQL)的备份是如何收费的。 2022-06-30 第五次正式发布，新增以下内容： 新增如何安装MySQL客户端。 2022-02-18 第四次正式发布，新增以下内容： 新增GaussDB(for MySQL)提供root账号或super权限吗 调整常见问题分类 2021-04-30 第三次正式发布，新增以下内容： 新增E CS 和GaussDB(for MySQL)部署在同一区域的不同的VPC内，网络不通怎么办。 2020-12-30 第二次正式发布，新增以下内容： GaussDB(for MySQL)新增如何通过JDBC连接MySQL数据库。 GaussDB(for MySQL)新增主备机分别执行MATCH AGAINST语句后结果不一致的原因。 2019-09-03 第一次正式发布。

GaussDB(for MySQL)实例在空负载下CPU占用说明 GaussDB(for MySQL)实例上包括操作系统进程、mysqld进程、监控进程、增量备份进程等。mysqld进程包含多个线程比如主备通信线程、连接线程、刷新线程等。监控进程负责实时监控实例的状态，增量备份进程负责进行增量数据备份。因此在实例空载情况下，仍然有多个进程和线程在后台持续运行，CPU的占用率不会为0，通常空载时CPU占用率为10%~15%。 父主题： 数据库性能

Windows操作系统 windows操作系统可以使用镜像的方式批量安装Agent，操作步骤如下： 购买华为云弹性云服务器，选定所需使用的Windows系统镜像，详细操作请参见购买华为云弹性云服务器。 在购买的弹性云服务器中安装HSS Agent，详细操作请参见安装Windows版本客户端。 除在主机中安装HSS的Agent外，请勿开启其他服务或执行相关配置操作。 在任务管理器中关闭HostGuard进程。 关闭弹性云服务器，使用该弹性云服务器制作镜像，详细操作请参见创建镜像。 关闭弹性云服务器后，在制作镜像前，请勿重启弹性云服务器，否则您需重新执行步骤3。 使用步骤4制作的镜像为Windows弹性云服务器批量安装Agent。 安装成功后，需要等待5~10分钟左右Agent才会自动刷新Agent状态。

Linux操作系统 Linux操作系统可以通过如下方式批量安装Agent： 购买华为云弹性云服务器，选定所需使用的Linux系统镜像，详细操作请参见购买弹性云服务器。 在购买的弹性云服务器中安装HSS的Agent，详细操作请参见安装Linux Agent。 除在主机中安装HSS的Agent外，请勿开启其他服务或执行相关配置操作。 在服务器中关闭HSS进程。 使用ps -ef命令确定HSS的PID，使用kill -pid命令关闭Linux系统中的hostguard进程。 关闭弹性云服务器，使用该弹性云服务器制作镜像，详细操作请参见创建镜像。 关闭弹性云服务器后，在制作镜像前，请勿重启弹性云服务器，否则您需重新执行步骤3和步骤4。 使用步骤4制作的镜像为Linux弹性云服务器批量安装Agent。 安装成功后，需要等待5~10分钟左右Agent才会自动刷新Agent状态。

缺陷全生命周期管理 和软件开发生命周期一样，缺陷也是由一系列的阶段和活动组成的，即缺陷同样具有生命周期。缺陷定位越精确，修复成本就越低、影响越小。CodeArts Defect打通缺陷过程监控链条，从缺陷的发现和提出，到开发人员的分析定位、实施修复，再到测试人员的测试和验收，层层把关，最终导向缺陷的闭环。让团队在整个缺陷生命周期中进行有效的跟踪和关联，将缺陷各作业环节产生的数据有机串联、风险实时预警，提高缺陷管理的效率和准确性，保障高质量的产品交付。 缺陷全生命周期管理的流程如下： 测试人员发现缺陷并提交缺陷单。 缺陷责任人定位缺陷产生的原因，并根据版本计划及时修复。 测试人员根据最新实现功能回归测试缺陷单，并验收。 项目经理可以查看缺陷的度量数据。 缺陷责任人可根据项目实际情况对缺陷单的关联项进行追溯。 父主题： 功能特性