华为云用户手册

请求示例 示例背景 已在cn-north-4区域的TestApp应用中，构建一个名称为“TestMV”、多维版本属性为“view2”的M-V模型数据实体，并完成了实体发布、应用发布和应用部署。 已在应用运行态通过可视化页面或API的方式创建一个多维版本的 数据实例 ，其数据实例的唯一编码为“523616294595981234”。 您的业务数据存在较大变更，希望可以创建新的版本，差异化管理实例数据。 示例代码 { "params": { "modifier": "XDM_Developer", "masterId": "637652965003370496", "workCopyType": "BOTH", "view2": { "id": "4" } } }

响应示例 { "result": "SUC CES S", "data": [ { "id": "637773750976122880", "creator": "XDM_Developer", "modifier": "XDM_Developer", "createTime": "2024-05-30T14:05:11.504+0000", "lastUpdateTime": "2024-05-30T14:05:11.504+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "MultiViewMv", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2024-05-30T01:11:34.110+0000", "lastUpdateTime": "2024-05-30T01:11:34.110+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "nameEn": null, "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "MultiViewMv", "name": "1", "description": null, "kiaguid": null, "securityLevel": "internal", "master": { "id": "637652965003370496", "creator": "XDM_Developer", "modifier": "XDM_Developer", "createTime": "2024-05-30T06:05:13.911+0000", "lastUpdateTime": "2024-05-30T06:14:31.070+0000", "rdmVersion": 2, "rdmDeleteFlag": 0, "rdmExtensionType": "MultiViewMvMaster", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2024-05-30T01:11:34.110+0000", "lastUpdateTime": "2024-05-30T01:11:34.110+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "nameEn": null, "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "MultiViewMvMaster" }, "branch": { "id": "637773751051620352", "creator": "XDM_Developer", "modifier": "XDM_Developer", "createTime": "2024-05-30T14:05:11.496+0000", "lastUpdateTime": "2024-05-30T14:05:11.496+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "MultiViewMvBranch", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2024-05-30T01:11:34.110+0000", "lastUpdateTime": "2024-05-30T01:11:34.110+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "nameEn": null, "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "MultiViewMvBranch", "version": "C" }, "latest": true, "latestIteration": true, "versionCode": 3, "iteration": 1, "version": "C", "latestVersion": true, "workingCopy": false, "workingState": { "code": "CHECKED_IN", "cnName": "已检入", "enName": "checked in", "alias": "CHECKED_IN" }, "checkOutUserName": null, "checkOutTime": null, "preVersionId": "637760894251569152", "view2": { "id": "4", "creator": "XDM_Developer", "modifier": "XDM_Developer", "createTime": "2024-05-30T07:17:01.666+0000", "lastUpdateTime": "2024-05-30T07:17:01.666+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Entity", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": "2024-05-30T01:11:34.110+0000", "lastUpdateTime": "2024-05-30T01:11:34.110+0000", "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "nameEn": null, "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "Entity", "name": null, "description": null, "kiaguid": null, "securityLevel": "internal", "ref": null, "lifecycleTemplate": null, "lifecycleState": null, "folder": null, "clsAttrs": null, "owner": [], "aclEntry": null, "rootNode": null, "parentNode": null, "leafFlag": true, "fullPath": "4/", "rawFullPath": "4/", "disableFlag": false, "extAttrs": [], "extAttrMap": {} }, "lifecycleTemplate": null, "lifecycleState": null, "disableFlag": false, "aclEntry": null, "clsAttrs": null, "owner": [], "extAttrs": [], "extAttrMap": {} } ], "errors": [] }

请求参数 表2 请求body参数 参数 是否必填 参数类型 描述 creator 否 String 创建者。 modifier 否 String 更新者。 masterId 是 String 主对象ID。 workCopyType 否 Object 此配置项用于创建多维版本数据实例时是否继承其对应的关系实例。根据业务需求，选择类型。 BOTH：若存在关系实例引用此数据实例作为源端实例或目标端实例，创建后的数据实例将继承这些关系实例。 SOURCE：若存在关系实例引用此数据实例作为源端实例，创建后的数据实例将继承这些关系实例。 TARGET：若存在关系实例引用此数据实例作为目标端实例，创建后的数据实例将继承这些关系实例。 NONE：创建后的数据实例将不继承任何关系实例。 CUSTOM：若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例，创建后的数据实例将继承这些关系实例。 workingCopy 否 Boolean 是否工作副本，默认值false customLinkSet 否 List 关系实体名称的集合。 当“workCopyType”设置为“CUSTOM”时，需要设置此参数。 needSetNull 否 List 指定不复制的属性。被指定不复制的属性，其返回值将被设置为“null”。 view2 否 说明： 如果用户在应用设计态配置“多维版本”功能配置时，将此多维版本属性设置为必填，则请求参数为必填项。 Object 自定义的多维版本属性。 view2.id 是 String 多维版本属性的ID。 view2.clazz 否 String 多维版本属性的类名。

URI URL格式： POST http://{Endpoint}/rdm_{appID}_app/publicservices/dynamic/api/{entityName}/revise 参数说明： 表1 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器 域名 或IP地址。 appID 是 String 应用ID。 entityName 是 String 实体的英文名称。

请求示例 示例背景 您已在cn-north-4区域的TestApp应用中，构建一个名称为“TestMV”、多维版本属性为“view2”的M-V模型数据实体，并完成了实体发布、应用发布和应用部署。希望可以根据已创建的M-V模型数据实例，创建一个多维版本数据实例。 示例代码 { "params": { "versionId": "521722330943061234", "modifier": "DME_Developer", "view2": { "id": "11", "clazz": "ViewAttr" } } }

请求参数 表2 请求body参数 参数 是否必填 参数类型 描述 versionId 是 String 原视图的versionId，即已创建数据实例的version.唯一编码。 workCopyType 否 Object 此配置项用于创建多维版本数据实例时是否继承其对应的关系实例。根据业务需求，选择类型。 BOTH：若存在关系实例引用此数据实例作为源端实例或目标端实例，创建后的数据实例将继承这些关系实例。 SOURCE：若存在关系实例引用此数据实例作为源端实例，创建后的数据实例将继承这些关系实例。 TARGET：若存在关系实例引用此数据实例作为目标端实例，创建后的数据实例将继承这些关系实例。 NONE：创建后的数据实例将不继承任何关系实例。 CUSTOM：若指定的关系实体集合对应的关系实例引用此数据实例作为源端实例或目标端实例，创建后的数据实例将继承这些关系实例。 customLinkSet 否 List 关系实体名称的集合。 当“workCopyType”设置为“CUSTOM”时，需要设置此参数。 needSetNull 否 List 指定不复制的属性。被指定不复制的属性，其返回值将被设置为“null”。 view2 否 说明： 如果用户在应用设计态配置“多维版本”功能配置时，将此多维版本属性设置为必填，则请求参数为必填项。 Object 自定义的多维版本属性。 modifier 是 String 更新者。

响应示例 为篇幅起见，这里只展示部分内容。其中，"version": "A"表示多维视图的迭代版本。 { "result": "SUCCESS", "data": [ { "id": "523616294595981234", ...... "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "View2", "tenant": { ...... }, "className": "View2", "name": "AS", "description": null, "kiaguid": null, "securityLevel": "internal", "master": { ...... "rdmExtensionType": "View2Master", "tenant": { ...... }, "className": "View2Master" }, "branch": { ...... "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "View2Branch", "tenant": { ...... }, "className": "View2Branch", "version": "A" }, "latest": true, "latestIteration": true, "versionCode": 1, "iteration": 1, "version": "A", "latestVersion": true, "workingCopy": false, "workingState": { "code": "CHECKED_IN", "cnName": "已检入", "enName": "checked in", "alias": "CHECKED_IN" }, "checkOutUserName": null, "checkOutTime": null, "preVersionId": "52281****087179264", "viewAttr1": null, "viewAttr3": null, "viewAttr2": null } ], "errors": [] }

URI URL格式： POST http://{Endpoint}/rdm_{appID}_app/publicservices/api/{entityName}/createView 参数说明： 表1 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器域名或IP地址。 appID 是 String 应用ID。 entityName 是 String 实体的英文名称。

功能介绍 版本对象的创建视图接口（createView）和批量创建视图接口（batchCreateView）是根据M-V模型实体已有数据实例的versionId（version.唯一编码）并指定多版本属性进行创建。创建后该M-V模型实体会生成实例数据完全复制原数据实例现有信息，但“version.修订版本”和“branch.大版本”会从初始值重新开始计算的多维版本数据实例。 本章节以createView为例，如需调用batchCreateView，请前往全量数据服务查看。

请求参数 根据实体类型、功能的不同，请求body参数不同，您可以在全量数据服务查看API具体参数。为篇幅起见，这里只展示部分内容。 表2 请求body参数 参数 是否必填 参数类型 描述 sorts 否 List 排序。 sort 否 String 排序方式（asc/desc）。 orderBy 否 String 排序字段，可填写模型自身属性、参考对象的属性、扩展属性及分类属性。 filter 否 Object 查询条件。 isNeedTotal 否 Boolean 是否需要查询总记录数（false/true）。

请求示例 示例背景 已在设计态构建一个名称为“employee”的数据实体，该实体自定义了“age”和“sex”两个属性，并完成了实体发布、应用发布和应用部署。 已在运行态通过控制台或API的方式创建多个数据实例。 需要查询“sex”为“男性”的数据实例，且结果需要先按名称倒序排序，再按年龄倒序排序。 示例代码 { "params": { "sorts": [ { "sort": "DESC", "orderBy": "name" }, { "sort": "DESC", "orderBy": "age" } ], "filter": { "joiner": "and", "conditions": [ { "conditionName": "sex", "operator": "=", "conditionValues": [ "男" ] } ] }, "isNeedTotal": true } }

响应示例 { "result": "SUCCESS", "data": [ { "id": "455304645330341888", "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX", "createTime": "2023-01-13T01:38:07.000+00:00", "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX", "lastUpdateTime": "2023-01-13T01:38:07.000+00:00", "rdmVersion": 1, "rdmExtensionType": "People", "rdmDeleteFlag": 0, "tenant": { "id": "-1", "clazz": "Tenant" }, "className": "People", "name": "李四", "description": null, "kiaguid": null, "securityLevel": "internal", "sex": "男", "age": 20 }, { "id": "455304534248394752", "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX", "createTime": "2023-01-13T01:37:40.000+00:00", "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX", "lastUpdateTime": "2023-01-13T01:37:40.000+00:00", "rdmVersion": 1, "rdmExtensionType": "People", "rdmDeleteFlag": 0, "tenant": { "id": "-1", "clazz": "Tenant" }, "className": "People", "name": "张三", "description": null, "kiaguid": null, "securityLevel": "internal", "sex": "男", "age": 18 } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 20, "totalRows": 2, "totalPages": 1 } }

URI URI格式： POST http://{Endpoint}/rdm_{appID}_app/services/dynamic/api/{entityName}/find/{pageSize}/{curPage} 参数说明： 表1 URI参数说明 参数 是否必填 参数类型 描述 Endpoint 是 String 承载REST服务端点的服务器域名或IP地址。 appID 是 String 应用ID。 entityName 是 String 实体的英文名称。 pageSize 否 String 分页查询时，每页最多展示的记录数。 curPage 否 String 分页查询的页数。

功能使用 表1 xDM-F功能使用 功能 描述 使用方式 基础数据服务 针对数据实体、关系实体、接口模型等自动生成数据服务，例如生成增、删、改、查、分页查询等原子接口，实现基础服务的调用。 控制台 API 文件服务 可以在数据实例中上传、下载多种格式文件，可满足文件管理的诉求。 控制台 API 安全受控 安全受控功能可以高安全、高可靠的管控数据访问权限及业务关键信息。 控制台 API 主版本服务 可以对数据对象进行检出、修订、检入操作，为M-V模型数据对象中master提供父类。 控制台 API 版本服务 可以为多版本对象提供M-V模型原子服务，用于业务对象追溯管理，提高追溯效率。 控制台 API 系统版本 可以通过版本号标识记录修改历史记录。 控制台 API 树形结构 可以指定全路径字段，为树形节点全路径绑定属性。 控制台 API 权限管理 可以根据自身业务需求，对数据或功能进行授权鉴权的开发。 控制台 API 业务编码生成器 业务编码生成器功能可以自定义规则，自动生成业务编码，为系统维护者提供便利。 控制台 API 文件夹管理 可创建多层级的文件夹结构，在创建数据实例时可指定所属文件夹，方便对数据进行分门别类。 控制台 API 分类管理 可以根据分类节点及分类属性快速检索对象，节约时间成本、提高查询效率和业务效率。 控制台 API 扩展属性 可以为数据对象添加扩展属性，用于租户的定制化扩展业务。 控制台 API 扩展类型 可以灵活定义对象的扩展类型，用于标识数据对象是否可被扩展。 控制台 API 生命周期管理 可以通过生命周期模板定义及管理，实现数据对象的全过程管理，以及对不同类型业务对象的过程追溯。 控制台 API 失效管理 可以灵活管理用户权限、业务属性（如零部件的损坏），便于用户识别。 控制台 API 所有者管理 可以通过所有者属性为数据对象授权。 控制台 API 标签管理 可以对已有数据对象从不同维度进行规划和分类管理。 控制台 API 多维视图&多维分支 可以通过不同视角（如设计、工艺、制造、服务等）对同一个数据对象（如BOM编码）进行差异化管理。 API 说明： xDM-F只能对M-V模型数据实体设置多维视图&多维分支能力，只支持通过API方式创建多维视图&多维分支数据实例。 数据分类管理 方便用户将同维度的数据实例进行分门别类管理、实例数据统一归集。 控制台 API 说明： 仅支持通过API方式将数据分类和数据分类对象进行关联。

概述 随着企业数字化转型的浪潮不断来袭，众多非数字原生企业的多年信息化建设，除了给企业带来了成长的红利，也给企业带来了数据管理和消费的历史包袱。当前，国内企业业务持续的风险不断升高，现有系统面临业务数据获取周期长、业务数据转换效率低、升级替换难等挑战，亟须破局。工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME），是基于数字化变革和数据管理优秀实践开发的创新型工业软件开发与运营平台，打造“基于模型+数据驱动”的公共底座，为协同打造新一代全栈自主可控工业软件体系提供根技术服务，助力快速构建和运营云化SaaS化工业软件，汇聚企业全场景数据，构建企业级数据图谱，提供万数互联的数据索引、追溯、交互服务。 开发指南从iDME功能实现的角度，介绍iDME的功能、使用方法、样例工程及代码介绍，提供给需要进行业务应用开发的并具备Java开发经验的开发人员使用。

GaussDB (for MySQL)实例连接失败怎么办 报错信息：Access denied for user 'user_name'@'100.xxx.xx.xx' (using password: YES)。 报错原因：GaussDB(for MySQL)数据库用户名或密码不对。 解决方法：请确认数据库用户名和密码是否正确，如果您不确认密码是否正确，可以在GaussDB控制台重置实例密码。 修改密码可能会影响业务，请谨慎操作。 如果确认账户名和密码正确，可以通过客户端或命令行工具登录数据库，执行select * from mysql.user where user = 'user_name'命令查看用户信息，如果存在100.%网段的用户，则DAS只能通过100.%网段的数据库用户去连接数据库。user_name @%与user_name @100.%是两个用户，其密码和权限都是独立的，请确认输入的密码是否是user_name @100.%用户的密码。 报错原因：DAS服务器的IP地址不在您输入用户的白名单中。 解决方法：使用客户端或命令行工具登录到数据库，创建DAS可以访问的数据库用户。 create user 'user_name'@'100.%' identified by 'password'; grant all privileges on *.* to 'user_name'@'100.%'; DAS服务器IP地址所在网段为100.%，请根据实际使用需要添加白名单。 请根据实际使用需要给user_name@100.%用户赋予权限。 报错信息： Trying to connect with ssl, but ssl not enabled in the server 报错原因： 使用SSL用户登录，服务端没有开启SSL功能。 解决方法：请执行如下语句查询用户是否是SSL用户，如果是，则在GaussDB(for MySQL)实例详情页面，将SSL开关打开。其中，ssl_type字段有值即表示此用户是SSL用户。 select user, host, ssl_type from mysql.user where user = 'user_name'; 报错信息： Client does not support authentication protocol requested by server. plugin type was = 'sha256_password' 报错原因： DAS暂不支持密码的加密方式为sha256_password的数据库用户连接登录。 解决方法：请执行如下语句将密码的加密方式改为mysql_native_password。 alter user 'user_name'@'%' identified with mysql_native_password by 'password'; 报错信息： Communications link failure The last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server 报错原因： DAS服务器与实例网络不通。 解决方法：请联系技术支持协助处理。 父主题： 连接管理

RDS for MySQ L实例 连接失败怎么办 报错信息：Access denied for user 'user_name'@'100.xxx.xx.xx' (using password: YES)。 报错原因：RDS实例用户名或密码不对。 解决方法：请确认数据库用户名和密码是否正确，如果您不确认密码是否正确，可以在RDS控制台重置实例密码。 修改密码可能会影响业务，请谨慎操作。 如果确认账户名和密码正确，可以通过客户端或命令行工具登录数据库，执行select * from mysql.user where user = 'user_name'命令查看用户信息，如果存在100.%网段的用户，则DAS只能通过100.%网段的数据库用户去连接数据库。user_name @%与user_name @100.%是两个用户，其密码和权限都是独立的，请确认输入的密码是否是user_name @100.%用户的密码。 报错原因：DAS服务器的IP地址不在您输入用户的白名单中。 解决方法：使用客户端或命令行工具登录到数据库，创建DAS可以访问的数据库用户。 create user 'user_name'@'100.%' identified by 'password'; grant select on *.* to 'user_name'@'100.%'; DAS服务器IP地址所在网段为100.%，请根据实际使用需要添加白名单。 请根据实际使用需要给user_name@100.%用户赋予权限。 报错原因： 使用SSL用户登录，服务端没有开启SSL功能。 解决方法：请执行如下语句查询用户是否是SSL用户，如果是，则在RDS实例详情页面，将SSL开关打开。其中，ssl_type字段有值即表示此用户是SSL用户。 select user, host, ssl_type from mysql.user where user = 'user_name'; 报错信息： Trying to connect with ssl, but ssl not enabled in the server 报错原因： 使用SSL用户登录，服务端没有开启SSL功能。 解决方法：请执行如下语句查询用户是否是SSL用户，如果是，则在RDS实例详情页面，将SSL开关打开。其中，ssl_type字段有值即表示此用户是SSL用户。 select user, host, ssl_type from mysql.user where user = 'user_name'; 报错信息： Client does not support authentication protocol requested by server. plugin type was = 'sha256_password' 报错原因： DAS暂不支持密码的加密方式为sha256_password的数据库用户连接登录。 解决方法：请执行如下语句将密码的加密方式改为mysql_native_password。 alter user 'user_name'@'%' identified with mysql_native_password by 'password'; 报错信息： Communications link failure The last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server 报错原因： DAS服务器与实例网络不通。 解决方法：请提交工单联系客服人员协助处理。 报错信息：Instance connect timeout, please login again. 报错原因：DAS服务器连接超时。 解决方法：请提交工单联系客服人员协助处理。 报错信息：RSA public key is not available client side (option serverRsaPublicKeyFile not set). 报错原因：数据库用户的身份认证方式对密码安全性要求较高，要求用户认证过程中在网络传输的密码是加密的。 如果是SSL加密连接，则使用SSL证书和密钥对来完成“对称加密密钥对（在TSL握手中生成）”的交换，后续使用“对称加密密钥对”加密密码和数据。 如果是非SSL加密连接，则在连接建立时客户端使用MySQL Server端的RSA公钥加密用户密码，Server端使用RSA私钥解密验证密码的正确性，可以防止密码在网络传输时被窥探。 解决方法：开启实例SSL或者修改数据库用户的身份认证方式。 父主题： 连接管理

响应示例 { "instance_list" : [ { "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", "instance_name" : "rds-sql", "instance_status" : "ACTIVE", "version" : 5.7, "ip" : "192.168.0.84", "port" : 3306, "cpu" : 2, "mem" : 8, "login_flag" : true, "slow_sql_flag" : true, "deadlock_flag" : false, "lock_blocking_flag" : false, "charge_flag" : true, "full_sql_flag" : true } ], "total_count" : 2 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 X-Language 否 String 语言。 枚举值： zh-cn en-us 表3 Query参数 参数 是否必选 参数类型 描述 datastore_type 是 String 数据库类型。 offset 否 Integer 偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 最小值：0 最大值：5000 limit 否 Integer 每页记录数，默认为20，最大取值200。 最小值：0 最大值：200

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instance_list Array of 表5 实例列表。 数组长度：0 - 200 total_count Integer 总数。 最小值：0 最大值：10000 表5 DASInstanceInfo 参数 参数类型 描述 instance_id String 实例id。 最小长度：1 最大长度：64 instance_name String 实例名称。 最小长度：1 最大长度：64 instance_status String 实例状态。 最小长度：1 最大长度：16 version String 实例版本号。 engine_type String 引擎类型。 最小长度：0 最大长度：64 ip String ip 最小长度：0 最大长度：128 port Integer 端口号 最小值：0 最大值：65535 cpu Integer 实例cpu核数 mem Integer 实例内存大小 login_flag Boolean 实例登录是否启用 slow_sql_flag Boolean 慢sql是否启用 deadlock_flag Boolean 死锁分析是否启用 lock_blocking_flag Boolean 锁阻塞是否启用 charge_flag Boolean 当前实例是否计费 full_sql_flag Boolean 全量sql是否启用 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

请求示例 获取实例健康诊断报告内容。 GET https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/get-instance-health-report?task_id=bb252ed0-3d06-489a-a662-6609e054e91c

响应示例 状态码： 200 Success. { "success" : true, "summary_info" : { "analysis_results" : [ { "risk_code" : "SLOW_ LOG _ISSUE", "risk_level" : "WARNING", "risk_content" : "慢SQL问题", "reasons" : [ { "reason_code" : "SLOW_LOG_EXIST", "reason_content" : "存在慢SQL", "suggestions" : [ { "suggestion_code" : "ANALYZE_SLOW_LOG", "suggestion_content" : "分析慢SQL查找问题根源" } ] } ] } ] }, "instance_info" : { "tenant_id" : "05204146e600d48f0f02c002850ec340", "project_id" : "052041494800d57c2f02c00275b4c247", "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", "instance_name" : "rds-sql-勿删1", "cpu" : 2, "mem" : 8, "disk_size" : 60, "disk_type" : "CLOUDSSD", "engine" : "mysql", "engine_version" : "5.7" }, "performance_stat" : { "analyze_success" : true, "peak_stats" : [ { "metric" : "qps", "value" : 64.88, "max_value" : 11178, "normalized" : 0.005804258364644837, "stage" : "LIGHT", "timestamp" : 1728756000 } ], "ratio_stats" : [ { "criticalThreshold" : 11178, "mediumThreshold" : 7824.599999999999, "lightThreshold" : 3353.4, "metric" : "qps", "max_value" : 11178, "critical_ratio" : 0, "medium_ratio" : 0, "light_ratio" : 1 } ] }, "disk_stat" : { "analyze_success" : true, "peak_stats" : [ { "metric" : "iops", "value" : 91.9, "max_value" : 4500, "normalized" : 0.020422222222222224, "stage" : "LIGHT", "timestamp" : 1728750600 } ], "ratio_stats" : [ { "criticalThreshold" : 4500, "mediumThreshold" : 3150, "lightThreshold" : 1350, "metric" : "iops", "max_value" : 4500, "critical_ratio" : 0, "medium_ratio" : 0, "light_ratio" : 1 } ] }, "table_space_stat" : { "analyze_success" : true }, "slow_log_stat" : { "analyze_success" : true, "collect_slow_log" : true, "top_execute_slow_logs" : [ { "template_id" : "5B20B6BF446F926F", "template" : "INSERT INTO test123 VALUES (?);", "databases" : [ "test_db" ], "times" : 83, "avg_query_time" : 0.9021538595657752, "max_query_time" : 45.08398997783661, "avg_rows_examined" : 0, "sum_rows_examined" : 0, "avg_rows_sent" : 0 } ], "rows_examined_exceeding" : [ ] }, "full_sql_Stat" : { "analyze_success" : true, "collect_full_sql" : true, "execute_top_templates" : [ { "template_id" : "B38F825636B24B7", "template" : "CREATE TABLE IF NOT EXISTS table_001 (id int)", "databases" : [ "test_db" ], "times" : 1, "avg_query_time" : 5, "avg_rows_examined" : 0, "sum_rows_examined" : 0 } ] }, "inspection_Stat" : { "analyze_success" : true, "inspection_score" : [ { "score" : 100, "critical" : 0, "medium" : 0, "light" : 0, "cpu_usage" : 3.93, "mem_usage" : 22.91, "space_usage" : 8.66, "connection_rate" : 0.54, "iops_usage" : 0.28, "thread_running" : 4, "slow_sql_total" : 0, "lost_points_detail_list" : [ { "metric" : "memUsage", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "cpuUsage", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "spaceUsage", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "iopsUsage", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "connectionRate", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "threadRunning", "lost_points" : 0, "risk_level" : "NORMAL" }, { "metric" : "slowSqlTotal", "lost_points" : 0, "risk_level" : "NORMAL" } ] } ] } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 success Boolean 日报诊断是否成功。 start_at Long 日报诊断区间的起始时间（Unix timestamp），单位：毫秒。 end_at Long 日报诊断区间的结束时间（Unix timestamp），单位：毫秒。 task_id String 报告ID。 summary_info 表5 object 日报内容摘要信息 instance_info 表9 object 实例信息列表。 performance_stat 表10 object 性能统计分析列表。 disk_stat 表11 object 磁盘统计分析列表。 table_space_stat 表14 object 表空间统计分析列表。 slow_log_stat 表17 object 慢SQL统计分析列表。 full_sql_stat 表18 object 全量SQL统计分析列表。 inspection_stat 表20 object 巡检评分统计分析列表。 error_message String 错误信息。 表5 HealthReportSummaryInfo 参数 参数类型 描述 analysis_results Array of 表6 objects 分析结果列表。 表6 HealthReportAnalysisResult 参数 参数类型 描述 risk_code String 风险点编码。 risk_level String 风险点级别。 risk_content String 风险点内容。 reasons Array of 表7 objects 可能原因列表。 表7 HealthReportRiskReason 参数 参数类型 描述 reason_code String 可能原因编码。 reason_content String 可能原因内容。 suggestions Array of 表8 objects 建议优化措施列表。 表8 HealthReportRiskSuggestion 参数 参数类型 描述 suggestion_code String 建议优化措施编码。 suggestion_content String 建议优化措施。 表9 HealthReportInstanceInfo 参数 参数类型 描述 tenant_id String 账号ID。 project_id String 项目ID。 instance_id String 实例ID。 master_node_id String 主节点ID。 instance_name String 实例名称。 cpu Integer 实例cpu核数。 mem Integer 实例内存大小。 disk_size Integer 磁盘大小。 disk_type String 磁盘类型。 engine String 实例引擎类型。 engine_version String 引擎内核版本。 表10 HealthReportPerformanceStat 参数 参数类型 描述 peak_stats Array of 表12 objects 峰值统计信息列表。 ratio_stats Array of 表13 objects 比率值数据列表。 表11 HealthReportDiskStat 参数 参数类型 描述 peak_stats Array of 表12 objects 峰值统计信息列表。 ratio_stats Array of 表13 objects 比率值数据列表。 表12 HealthReportSingleValueStat 参数 参数类型 描述 metric String 指标名。 value Double 数值。 max_value Double 最大值。 normalized Double 归一化值。 stage String 当前状态。 timestamp Long 指标采集时间。 表13 HealthReportRatioStat 参数 参数类型 描述 metric String 指标名。 max_value Double 最大值。 critical_ratio Double 高水位占比。 medium_ratio Double 中水位占比。 light_ratio Double 低水位占比。 表14 HealthReportTableSpaceStat 参数 参数类型 描述 size_top Array of 表15 objects 表大小Top列表。 rows_top Array of 表15 objects 表行数量Top列表。 size_incr_top Array of 表16 objects 表大小增长Top列表。 rows_incr_top Array of 表16 objects 表行数量增长Top列表。 analyze_success Boolean 统计分析是否成功。 error_message String 错误信息。 表15 HealthReportTableSpaceInfo 参数 参数类型 描述 database String 数据库名。 table String 表名。 db_engine String 数据库引擎。 table_size Long 表大小。 data_size Long 数据大小。 index_size Long 索引大小。 rows Long 行数量。 表16 HealthReportTableSpaceIncrInfo 参数 参数类型 描述 database String 数据库名。 table String 表名。 increment Long 增长量。 analyze_success Boolean 统计分析是否成功。 error_message String 错误信息。 表17 HealthReportSlowLogStat 参数 参数类型 描述 collect_slow_log Boolean 是否收集慢SQL。 top_execute_slow_logs Array of 表19 objects 慢SQL Top执行次数列表。 top_avg_query_time_slow_logs Array of 表19 objects 慢SQL Top平均执行时间列表。 top_max_query_time_slow_logs Array of 表19 objects 慢SQL Top最大执行时间列表。 rows_examined_exceeding Array of 表19 objects 慢SQL Top扫描返回比列表。 analyze_success Boolean 统计分析是否成功。 error_message String 错误信息。 表18 HealthReportFullSqlStat 参数 参数类型 描述 collect_full_sql Boolean 是否收集全量SQL。 execute_top_templates Array of 表19 objects 全量SQL Top总执行次数列表。 sum_rows_examined_top_templates Array of 表19 objects 全量SQL Top总扫描行数列表。 avg_cost_top_templates Array of 表19 objects 全量SQL Top平均执行耗时列表。 analyze_success Boolean 统计分析是否成功。 error_message String 错误信息。 表19 HealthReportSqlTemplate 参数 参数类型 描述 template_id String 模板ID。 template String 模板内容。 databases Array of strings 数据库列表。 times Long 执行次数。 avg_query_time Double 平均执行时间。 max_query_time Double 最大执行时间。 avg_rows_examined Double 平均扫描行数。 max_rows_examined Double 最大扫描行数。 sum_rows_examined Double 总扫描行数。 avg_rows_sent Double 平均返回行数。 max_rows_sent Double 最大返回行数。 表20 HealthReportInspectionStat 参数 参数类型 描述 inspection_score Array of 表21 objects 巡检评分。 analyze_success Boolean 统计分析是否成功。 error_message String 错误信息。 表21 HealthReportInspectionScore 参数 参数类型 描述 score Double 得分。 critical Integer 严重事件。 medium Integer 警告事件。 light Integer 优化事件。 cpu_usage Double CPU使用率。 mem_usage Double 内存使用率。 space_usage Double 空间使用率。 connection_rate Double 连接使用率。 iops_usage Double IOPS使用率。 thread_running Double 活跃会话。 slow_sql_total Long 慢SQL数量。 lost_points_detail_list Array of 表22 objects 扣分详情。 表22 HealthReportLostPointsDetail 参数 参数类型 描述 metric String 扣分项。 lost_points Double 所扣分数。 risk_level String 事件等级。 状态码： 400 表23 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表24 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "slow_sql_templates" : [ { "max_rows_examined" : 0, "max_lock_wait_time" : 0, "avg_rows_examined" : 0, "execute_count" : 27, "avg_execute_time" : 5.000509315066868, "max_execute_time" : 5.008123874664307, "avg_lock_wait_time" : 0, "sql_template" : "SELECT sleep(?);", "sql_sample" : "select sleep(5)", "avg_rows_sent" : 1, "db_names" : [ "db_01" ], "max_rows_sent" : 1 } ], "total_count" : 1 }

请求示例 导出慢SQL模板列表。 GET https://das.cn-north-1.myhuaweicloud.com/v3/054c630ff780d4cc2f40c00d7f6fb21d/instances/6243b3fcf2f948578d46ed4c52fb54eein01/slow-sql-templates?startAt=1611975464337&endAt=1611979064337&datastore_type=MySQL&db_name=db&offset=0&limit=10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 slow_sql_templates Array of SlowSqlTemplate objects 慢日志模板数据列表。 total_count Integer 慢日志模板总数。 表5 SlowSqlTemplate 参数 参数类型 描述 sql_template String SQL模板。 sql_sample String SQL样本。 db_names Array of strings 库名。 execute_count Long 执行次数。 avg_execute_time Double 平均执行耗时(ms)。 max_execute_time Double 最大执行耗时(ms)。 avg_lock_wait_time Double 平均锁等待时间(ms)。 max_lock_wait_time Double 最大锁等待时间(ms)。 avg_rows_examined Double 平均扫描行数。 max_rows_examined Double 最大扫描行数。 avg_rows_sent Double 平均返回行数。 max_rows_sent Double 最大返回行数。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

URI GET /v3/{project_id}/instances/{instance_id}/slow-sql-templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_at 是 Long 开始时间（Unix timestamp），单位：毫秒。 end_at 是 Long 结束时间（Unix timestamp），单位：毫秒。 datastore_type 是 String 数据库类型。支持MySQL和TaurusDB。 db_name 否 String 数据库名称。 offset 否 Integer 偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 每页记录数，默认为20，最大取值100。

使用须知 全量SQL默认关闭，如需使用SQL洞察功能，请先开启全量SQL收集开关。开启收集全量SQL后，实例性能损耗5%以内。 关闭收集全量SQL后，将不再采集新产生的SQL，已经收集的SQL也会被删除，请您谨慎操作。 当前全量SQL受内存缓冲区限制，业务量大的场景下，全量SQL有较小概率因缓冲区满，存在丢弃部分记录。 当前全量SQL单条记录超过4096字节时，会默认丢弃该条记录。 此限制在MySQL 5.7.33.3及以后小版本可以通过设置参数rds_sql_tracer_reserve_big_records来选择是否丢弃，5.6和8.0版本不支持设置该参数。您可以在参数设置界面，将该参数设为ON，即表示单条记录超过4096字节也不被丢弃。 免费实例的全量SQL日志仅保留1个小时，付费实例默认保留7天，最长可保存30天，到期后自动删除。 版本限制：5.6.51.1及以上版本、5.7.29.2及以上版本、8.0.20.3及以上版本支持。

前提条件 GaussDB(for MySQL)5.6的内核版本要大于等于5.6.43.3，5.7的内核版本要大于等于5.7.25.3。 不支持E CS 自建库，不支持创建中、冻结、异常实例。 请务必在紧急情况下使用该功能，您的Kill操作将会以日志的形式被记录下来。 当您的实例能够通过DAS正常登录时，请勿使用该功能，您可以登录实例，通过实时会话功能执行相关操作。 rdsadmin、rdsbackup、rdsmetric、rdsRepl等敏感用户的会话禁止Kill。 当CPU或者连接数打满的情况下，kill会话请求有一定概率会下发超时，此时请重新下发kill会话请求。

示例流程 图1 给用户授权DAS权限流程 创建用户组并授权 在 IAM 控制台创建用户组，并授予数据管理服务 “DAS FullAccess”权限。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1中创建的用户组。 用户登录并验证权限 在“服务列表”中选择“数据管理服务 DAS”，进入DAS主界面，单击详情页左上角“新增数据库登录”，若可以正常创建数据库登录，则表示DAS所需权限策略均已生效。