华为云用户手册

API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口，您可以使用文档数据库服务的部分功能，具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。 查询数据库规格 查询指定条件下的所有实例规格信息。 查询数据库磁盘类型 查询当前区域下的数据库磁盘类型。 实例管理 包括创建实例、重启实例、删除实例、查询实例列表、扩容实例存储容量、扩容集群实例的节点数量、变更实例规格、切换副本集实例的主备节点、切换SSL开关、修改实例名称、修改数据库端口、变更实例安全组、绑定弹性公网IP、解绑弹性公网IP、修改实例内网地址、打开集群的Shard/Config IP开关接口、副本集跨网段访问配置、查询实例可迁移到的可用区、实例可用区迁移。 连接管理 包括查询实例节点会话、终结实例节点会话、查询实例节点连接数统计接口。 备份与恢复 包括创建手动备份、删除手动备份、查询备份列表、查询自动备份策略、设置自动备份策略、恢复到新实例、获取备份下载链接、查询可恢复的时间段、获取可恢复的数据库列表、获取可恢复的数据库集合列表、获取到当前实例、库表级时间点恢复接口。 参数配置 包括获取参数模板列表、创建参数模板、删除参数模板、获取参数模板的详情、修改参数模板、应用参数模板、获取指定实例的参数信息、修改指定实例的参数接口。 获取日志信息 包括查询数据库慢日志、获取慢日志下载链接、查询数据库错误日志、获取错误日志下载链接、设置审计日志策略、查询审计日志策略、获取审计日志列表、获取审计日志下载链接接口。 标签管理 包括查询资源实例、批量添加或删除资源标签、查询资源标签、查询项目标签接口。 管理数据库和用户 包括创建数据库用户、创建数据库角色、查询数据库用户列表、查询数据库角色列表、修改数据库用户密码、检查数据库密码接口、查询集群均衡设置、设置集群均衡开关、设置集群均衡活动时间窗、删除数据库用户、删除数据库角色。 配额管理 查询单租户在DDS服务下的资源配额，包括集群实例配额、单节点实例配额和副本集实例配额。 任务管理 获取DDS任务中心指定ID的任务信息。

响应消息 参数说明 状态码：202 表3 响应Body参数 参数 参数类型 说明 job_id String 参数解释： 任务ID，仅按需实例返回该参数。 取值范围： 不涉及。 order_id String 参数解释： 订单ID，仅包周期实例返回该参数。 取值范围： 不涉及。 状态码：default 表4 ErrorResponse 参数 参数类型 说明 error_code String 参数解释： 提交任务异常时返回的错误编码。 取值范围： 不涉及。 error_msg String 参数解释： 提交任务异常时返回的错误描述信息。 取值范围： 不涉及。 响应示例 状态码： 202 Accepted. { "job_id" : "6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc" }

URI URI格式 DELETE /v3/{project_id}/instances/{instance_id}/mongos-node 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 参数解释： 从 IAM 服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 project_id string path 是 参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id string path 是 参数解释： 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求消息 参数说明 表2 请求Body参数 参数 是否必选 参数类型 描述 node_list 是 Array of strings 参数解释： 所有需要删除的mongos节点ID，至少保留两个mongos节点。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 请求示例： 删除实例520c58ba00a3497e97ce0b9604874dd6in02的mongos节点fea413b892214c53a58e5a529096ed75no02 DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/mongos-node { "node_list" : [ "fea413b892214c53a58e5a529096ed75no02" ] }

响应 响应参数 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "total": 1, "list": [ { "region_id": "cn-north-7", "host_name": "CN_NORTH_7_E CS ", "vm_list": "[['', '', 'Euler', '[{"cores":"1","model":"","threads":"1","cpu":"16 * 1 * 1 * ","sockets":"16"}]']]", "host_id": "abfa96bc-29f6-4571-bfba-fcfdf6ad6ebb", "host_ip": "xx.xx.xx.xx", "last_update_time": "1726819320000" } ] }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/host/vms?host_id=abfa96bc-29f6-4571-bfba-fcfdf6ad6ebb&offset_value=0&page_size=1 Content-Type: application/json Accept: application/json X-Auth-Token: xxxxx x-hcso-appcode: xxxx

响应 响应参数 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "total": 1, "list": [ { "REGION_ID": "cn-north-7", "HOST_ID": "dea41fb4-2583-45d7-a4b1-22d8d27c5024", "HOST_NAME": "ecs_4-CXXX034", "MANUFACTURER": "cn-north-7", "KERNEL": "0", "CPU": "[{"cores":"22","model":"Intel(R) Xeon(R) Gold 6161 CPU @ 2.20GHz","threads":"2","cpu":"2 * 22 * 2 * Intel(R) Xeon(R) Gold 6161 CPU @ 2.20GHz","sockets":"2"}]", "MEMORY": "[{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"}]", "DISK": "[{"disk":"/dev/sda:599.0GB"},{"disk":"/dev/sdb:1598.0GB"},{"disk":"/dev/sdc:10.7GB"}]", "MAC_IP": "xx.xx.xx.xx", "NETWORK_ADAPTER": "1", "RAID": "1", "SN": "abfa96bc-29f6-4571-bfba-fcfdf6ad6ebb", "CPU_ARCH": "x86_64", "AZ_CODE": "1", "POD_CODE": "1", "CLUSTER_NAME": "ecs", "ROOM_CODE": "1", "RACK_CODE": "1", "DC_CODE": "1" } ] }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求。 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/host/detail?begin_time=0&end_time=0&offset_value=0&page_size=1 Content-Type: application/json Accept: application/json X-Auth-Token: xxxxx x-hcso-appcode: xxxx

URI /rest/dataapi/homs/open-api/v1/host/detail 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 begin_time 是 integer 无 开始时间 end_time 是 integer 无 结束时间 offset_value 是 integer 无 偏移大小：大于等于0 page_size 是 integer 默认值：500 页大小：大于等于0 host_id 否 string 无 主机ID

URI /rest/dataapi/homs/open-api/v1/ecs/performance 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 begin_time 是 integer 无 开始时间 end_time 是 integer 无 结束时间 offset_value 是 integer 无 偏移大小：大于等于0 page_size 是 integer 默认值：500 页大小：大于等于0 vm_id 否 string 无 虚拟机ID

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求。 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/ecs/performance?begin_time=0&end_time=0&offset_value=0&page_size=1 Content-Type: application/json Accept: application/json X-Auth-Token: xxxxx x-hcso-appcode: xxxx

响应 响应参数 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "total": 1, "list": [ { "SERVICE": "ECS", "REGION_ID": "cn-north-7", "NAMESPACE": "ecs", "SOURCE_SERVICE": " CES ", "SOURCE_TYPE": "TenantMon", "SOURCE_TAG": "CN_NORTH_7_ECS", "TENANT_NAME": "xxx", "METRIC_NAME": "cpu_usage", "METRIC_VALUE": "10", "METRIC_UNIT": "%", "INSTANCE_ID": "abfa96bc-29f6-4571-bfba-fcfdf6ad6ebb", "TIMESTAMP": "1726819320000" } ] }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/network-device/metric-data?begin_time=0&end_time=0&offset_value=0&page_size=1 Content-Type: application/json Accept: application/json X-Auth-Token: xxx x-hcso-appcode: xxx

响应 响应参数 参数 是否必选 类型 值域 说明 device_ip 是 string 无 网络设备管理IP。 res_type 是 string 无 资源类型。 metric 是 string 无 设备指标。 region_id 是 string 无 区域编码。 value 是 string 无 指标值。 timestamp 是 string 无 时间戳。 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "total": 1698669, "list": [ { "device_ip": "xx.xx.xx.xx", "res_type": "2", "metric": "14", "region_id": "cn-north-7", "value": "0", "timestamp": "1726819320000" } ] }

URI /rest/dataapi/homs/open-api/v1/network-device/metric-data 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 begin_time 是 integer 无 开始时间 end_time 是 integer 无 结束时间 offset_value 是 integer 无 偏移大小：大于等于0 page_size 是 integer 默认值：500 页大小：大于等于0 management_ip 否 string 无 网络设备管理IP地址 metric 否 string 取值范围：59, 60, 14, 18, 101, 102, 61, 52 设备指标

预注销管理 为了防止租户账号被误删或需要恢复，系统默认开启预注销管理功能。 预注销租户 单击主菜单的“组织”。默认进入“租户管理”页面。 单击“更多 ＞ 预注销”。 确认弹框提示信息，单击“确定”。 租户状态将变为“预注销”，默认进入“预注销管理”页面。 预注销管理 单击主菜单的“组织”。默认进入“租户管理”页面。 单击“预注销管理”页签。 根据表 预注销管理操作执行以下操作。 表3 预注销管理操作 任务 说明 步骤 开启或关闭设置冷冻期 根据需要设置是否开启冷冻期。 单击开启设置冷冻期。 单击关闭设置冷冻期。 设置冷冻期时长 该设置对全局生效，但对已进入冷冻期的预注销租户不生效。 单击打开“设置冷冻期”。 设置销户冷冻期时间。 单击“确定”。 还原租户 根据需要对预注销的租户进行还原操作。 说明： 只有状态为“已冻结”的租户支持还原操作。 在租户所在行，单击“操作 ＞ 还原”。 也可选中需要还原的租户，单击左上方“还原”进行批量操作。 删除租户 对不需要使用的租户进行彻底删除操作。 说明： 租户冷冻期已解除的租户才可执行删除操作。 彻底删除后，租户下的所有资源数据及配置都无法恢复，请谨慎操作。 在租户所在行，单击“彻底删除”。 在弹框中输入“租户名+DELETE”后，单击“确定”。

查看与修改 单击主菜单的“组织”。默认进入“租户管理”页面。 可执行表中表2的操作。 表2 相关操作 任务 说明 步骤 查看租户列表 当需要查看租户名称、状态及描述时，可以直接在列表中查看。 查看租户内的各项基础信息。 导出租户 将租户的基本信息导出并保存到本地，仅用于信息备份和统计。 单击“导出 ＞ 导出租户”，默认导出所有租户。 导出项目 将租户下所有的项目信息进行导出。 单击“导出 ＞ 导出项目”，默认导出所有项目。 单击“操作 ＞ 修改”。 修改租户描述。 当进行白名单配置时，也可修改租户名称。 单击“确认”。

创建用户并授权IAM ESM ReadOnlyAccess策略 登录 统一身份认证 服务（IAM）控制台。 在IAM控制台创建用户组，并授予ESM服务的权限“ESM ReadOnlyAccess”。 在IAM控制台创建用户，并将其加入2中创建的用户组。 将新创建的用户ID反馈至华为云服务技术支持人员，由技术支持人员进行大屏配置。 用户登录并验证权限。 新创建的用户登录控制台，验证ESM服务的权限：在主菜单中选择 “可视化”，若能正常查看大屏，表示“ESM ReadOnlyAccess”已生效。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于创建查询任务接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，字段需要根据实际值填写。 POST https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs Content-Type: application/json { "hcso_id": "********", "region_id": "********", "min_sdr_time": "2022-01-01 00:00:00", "max_sdr_time": "2022-02-01 00:00:00" } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Accept 接收消息体的类型（格式），当前只支持application/json。 否 application/json X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 是 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 在创建查询任务的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同。您可以从地区和终端节点获取。 例如ESM服务在“华南-广州”区域的Endpoint为“esm-api.cn-south-1.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“创建查询任务”API的resource-path为“/meter/v1/{domain_id}/query-jobs”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取ESM在“华南-广州”区域的Token，则需使用“华南-广州”区域的Endpoint（esm-api.cn-south-1.myhuaweicloud.com），并在创建查询任务的URI部分找到resource-path（/meter/v1/{domain_id}/query-jobs），拼接起来如下所示。 https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式：项目级服务和全局级服务。其中： 项目级服务需要获取项目级别的Token，此时请求body中“auth.scope”的取值为“project”。 全局级服务需要获取全局级别的Token，此时请求body中“auth.scope”的取值为“domain”。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 POST https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs Content-Type: application/json X-Auth-Token: ABCDEFJ....

操作步骤 单击主菜单的“组织”。默认进入“租户管理”页面。 单击“预注销管理”页签。 根据表1执行以下操作。 表1 预注销管理操作 任务 说明 步骤 开启或关闭设置冷冻期 根据需要设置是否开启冷冻期。 单击开启设置冷冻期。 单击关闭设置冷冻期。 设置冷冻期时长 该设置对全局生效，但对已进入冷冻期的预注销租户不生效。 单击打开“设置冷冻期”。 设置销户冷冻期时间。 单击“确定”。 还原租户 根据需要对预注销的租户进行还原操作。 说明： 只有状态为“已冻结”的租户支持还原操作。 在租户所在行，单击“操作 ＞ 还原”。 也可选中需要还原的租户，单击左上方“还原”进行批量操作。 删除租户 对不需要使用的租户进行彻底删除操作。 说明： 局点已经对接ROS服务。 租户冷冻期已解除的租户才可执行删除操作。 彻底删除后，租户下的所有资源数据及配置都无法恢复，请谨慎操作。 在租户所在行，单击“彻底删除”。 在弹框中输入“租户名+DELETE”后，单击“确定”。

操作步骤 单击主菜单的“可视化”，默认进入“运营大屏”页面。 大屏详细说明可参见表1。 选择进入需要查看的大屏。 单击“导出”按钮可将大屏的数据导出至本地查看。 仅支持已开通专业版的局点用户使用导出功能。 表1 可视化运营大屏 大屏名称 说明 资源总览 大屏展示了硬件资源和常用云资源的数量、云资源总览、物理资源使用率、云资源配额统计、云资源使用趋势、虚拟资源分配率、虚拟资源分配额统计和虚拟资源使用率等内容，帮助用户更加清晰直观的了解资源的使用情况。 单击大屏右上角下拉框选择时间范围，用于指定物理资源使用率、云资源使用趋势、虚拟资源使用率展示的时间范围。 计算节点资源明细大屏和存储节点资源明细大屏属于资源总览的下钻大屏，相关数据内容可参见资源总览的数据内容，各展示项说明见表 资源总览。 硬件资源 大屏展示了硬件资源数量、运行状态、告警状态等，帮助用户实时掌握资源的运行情况，及时调整资源的分配，提高资源使用率以及避免可能的风险。 各展示项说明见表 硬件资源。 硬件告警 大屏展示了硬件资源近一个月的告警总量、告警总体状态、硬件告警统计、近一个月告警增长趋势和未清除的告警列表，帮助用户了解告警的整体现状，提高告警运营质量。 各展示项说明见表 硬件告警总览。 云服务状态 大屏展示云服务总体状态及各区域所有云服务的告警状态大盘，帮助用户掌握云服务的整体状态，快速识别出处于高危、隐患等状态的云服务分布，提高运营效率。 各展示项说明见表 云服务状态。 说明： 云服务状态说明如下： 高危：已部署的云服务存在未处理的紧急告警，则状态为高危。 隐患：已部署的云服务没有未处理的紧急告警，但存在未处理的重要告警，则状态为隐患。 健康：已部署的云服务既没有未处理的紧急告警，也没有未处理的重要告警，则状态为健康。 未部署：云服务未部署。 租户维度资源大屏 大屏展示各个云资源数量总计，从租户维度统计租户云列表、云资源变化趋势，并展示租户维度资源使用列表，帮助用户从租户维度全面掌握资源的分配和使用情况。 各展示项说明见表 租户维度资源大屏。 审计日志 大屏按风险级别对操作动作进行统计，并详细展示了操作人员在具体时间点对服务器、存储、网络设备等资源进行的操作，以审计日志报告的形式展现，方便用户查看。可在大屏右上角选择需要统计的时间范围。 各展示项说明见表 审计日志。 云服务资源容量明细 大屏展示云服务中各服务资源类型统计，并将分别以物理和逻辑维度展示总量、分配量、可用量的资源使用趋势。自助按虚拟机规格查询资源池的分配量、使用量等并支持导出。 各展示项说明见表 云服务资源容量明细。 硬件设备指标 大屏展示服务器中关键指标的利用率，包括CPU利用率、内存利用率、磁盘IO利用率、发送报文丢包率和系统平均负载，并展示TOP5数据统计。另外支持通过下钻大屏查看服务器的硬件详情、资源分配以及监控信息。 各展示项说明见表 硬件设备指标。 说明： 该大屏仅支持已开通专业版的局点用户。 AI算力资源运营看板 大屏展示算力资源的类型统计，其中包括GPU卡总数、NPU卡总数、专属资源池数量、AI节点总数等。当前站点和公共站点的算力容量以及所关联的训练作业/推理服务使用TOP排名，资源使用率趋势统计。 各展示项说明见表表 AI算力资源运营看板。 AI资源明细大屏 AI资源明细大屏属于AI算力资源运营看板的下钻大屏，提供租户关联资源池下的资源明细，各展示项说明见表表 AI资源明细大屏。 表2 资源总览 展示项 说明 硬件资源 统计硬件资源数量。 常用云资源 统计ECS统计发放的虚拟机个数，EVS发放的磁盘个数，及其他常用云服务统计管理区和租户区已发放的资源。 单击EVS右侧的“详情”链接，可查看租户区和管理区存储节点资源容量明细。 云资源总览 统计ECS统计发放的虚拟机个数，EVS发放的磁盘个数，及其他云服务统计管理区和租户区已发放的资源。 物理资源使用率 展示所选时间范围内每日CPU和内存的平均使用率。 单击物理资源使用率右侧的“详情”链接，可查看租户区和管理区计算节点资源容量明细。 云资源配额统计 统计云资源的分配量与总量（只统计租户区）。 云资源使用趋势 展示所选时间范围内每日云资源分配率的变化趋势（只统计租户区）。 虚拟资源分配率 统计虚拟资源（vCPU、内存、磁盘）的分配率（租户区和管理区均统计在内）。 虚拟资源分配额统计 统计虚拟资源（vCPU、内存、磁盘）的分配量与总量（租户区和管理区均统计在内）。 虚拟资源使用率 展示所选时间范围内每日虚拟资源（vCPU、内存、磁盘）的使用率（租户区和管理区均统计在内）。 计算节点资源明细大屏 展示ECS资源各维度（AZ、Cluster、资源类型）的资源容量明细，包括vCPU、内存、vGPU等指标（租户区和管理区均统计在内）。 存储节点资源明细大屏 展示EVS资源各维度（AZ、资源类型）的资源容量明细，包括普通IO、高IO、超高IO等磁盘类型（租户区和管理区均统计在内），详细内容请参见表表 资源类型说明。 表3 资源类型说明 参数 极速型SSD 通用型SSD V2 超高IO 通用型SSD 高IO 普通IO API名称e ESSD GPSSD2 SSD GPSSD SAS SATA 描述 适用于需要超大带宽和超低时延的场景。 容量与性能解耦，支持在容量固定的情况下，基于业务性能诉求，按需、灵活地调整IOPS和吞吐量。适合各种主流的高性能、低延迟交互应用场景。 超高性能云硬盘，可用于企业关键性业务，适合高吞吐、低时延的工作负载。 高性价比的云硬盘，适合中等性能诉求的企业应用。 可用于一般访问的工作负载f。 可用于不常访问的工作负载。 表4 硬件资源 展示项 说明 服务器 展示服务器数量和服务器名称、告警状态、运行状态、管理IP等信息。 交换机 展示交换机数量和交换机名称、告警状态、运行状态、管理IP等信息。 路由器 展示路由器数量和路由器名称、告警状态、运行状态、管理IP等信息。 防火墙 展示防火墙数量和防火墙名称、告警状态、运行状态、管理IP等信息。 安全设备 展示安全设备数量和安全设备名称、告警状态、运行状态、管理IP等信息。 表5 租户维度资源大屏 展示项 说明 租户云资源TOP10 按租户维度统计各个云资源的资源数，以资源数TOP10排序。 租户云资源使用趋势统计 按云资源维度统计每天资源数量变化趋势。 清单详情 各个云资源数量统计。 详情列表 云资源的详情列表，展示资源的常见信息。 表6 硬件告警总览 展示项 说明 告警总量 统计近一个月的历史告警（即已清除告警）和活动告警（即未清除告警），及各个级别的告警数量（包括已清除告警和未清除告警）。 告警总体状态 统计近一个月已清除告警的数量及占告警总数的比例，未清除告警的数量及占告警总数的比例。 硬件告警统计 分别统计近一个月网络设备（包含交换机、路由器、防火墙等）和物理主机的告警数量（包括已清除告警和未清除告警）。 近一个月告警增长趋势 统计近一个月各级别告警数量（包括已清除告警和未清除告警）的趋势。 当前告警 展示近一个月未清除告警的告警名称、级别、设备ID、开始发生时间、最后一次发生时间等信息。单击告警名称可查看告警详细信息。 历史告警 展示近一个月的历史告警（即已清除告警）和活动告警（即未清除告警）的告警名称、级别、设备ID、开始发生时间、最后一次发生时间等信息。单击告警名称可查看告警详细信息。 表7 审计日志 展示项 说明 风险级别统计 根据风险级别（紧急、重要、次要、提示）对操作动作进行汇总统计。 操作日志列表 轮播展示操作日志列表，显示操作名称、风险级别、操作人等信息。支持通过日志列表的操作名称、region匹配关键字搜索。 表8 云服务状态 展示项 说明 状态分布 统计处于高危、隐患、健康、未部署状态的云服务数量。 告警状态大盘 展示各区域内各云服务的状态及告警数量。 区域数量少于5个时，横向显示所有区域，区域下方一个方格代表该区域的一个云服务，已部署的云服务方格内显示当前未处理的紧急和重要告警数量。 区域数量是5个或5个以上时，告警状态大盘显示成一个二维表格，表头横向是各区域，纵向是各云服务。已部署的云服务，鼠标悬停到单元格上时显示对应区域对应云服务当前未处理的紧急和重要告警数量。 表9 云服务资源容量明细 展示项 说明 资源类型统计列表 展示常用基础云服务的容量视图情况。包含以下云服务：OBS、BMS、SFS、RDS、DeH、EIP、VPN。 资源使用趋势 展示不同云服务下的资源变化趋势。可在右上方选择时间维度，支持以“最近一周”、“最近一月”、“最近三月”进行查询。 表10 硬件设备指标 展示项 说明 服务器高利用率关键指标 包括CPU高利用率、内存高利用率、磁盘IO高利用率、高发送报文丢包率、高系统平均负载。 高负载资源列表 展示各项高利用率指标中的高负载资源TOP5。 硬件详情 展示该设备的配置详情，如CPUs、硬盘、内存及Mac&IPs。 资源分配 展示该设备的基本信息，如主机名、Region、AZ、SN、主机类型等信息。 监控信息 通过数据图表展示该设备的关键指标，如磁盘IO指标、网卡指标等。 表11 AI算力资源运营看板 展示项 说明 资源及指标统计 包括AI节点总数、GPU卡总数、NPU卡总数、专属资源池数量、任务总数、每秒请求数（QPS）、平均响应时延、请求总次数（近1h）。 算力容量 展示当前站点和公共的算力容量，包括CPU分配率、MEM分配率、NPU（卡）占用率、NPU（显存）分配率、GPU分配率。 使用量TOP10 展示租户训练任务及推理服务的使用量TOP10，并支持以算力或任务数进行排名。 资源使用率趋势统计 展示资源使用率趋势图，支持按照最近一天、最近一周、最近一月、最近三月切换查看。 表12 AI资源明细大屏 展示项 说明 资源及指标统计 包括资源池总数、AI节点总数、任务总数、训练任务总数、推理任务总数、NOTEBOOK总数、NPU算力/卡数、GPU算力/卡数。 资源池数据统计 包括任务总数、AI节点总数、用户总数、NPU卡总数、NPU卡分配量、NPU卡分配率、GPU卡分配率、NPU显存分配率、CPU总量、CPU平均使用率、内存总量、内存平均使用量。 趋势图 展示NPU卡分配率、NPU显存分配率、GPU卡分配率及CPU和MEM分配率的趋势图。 节点信息 展示节点详情信息，如节点名称、节点IP、NPU卡总数等信息。

操作步骤 单击界面右上方用户名，选择“ 消息通知 设置”。 选择“消息模板”菜单，单击“创建模板”。 请参考表 模板参数创建进行。 表1 模板参数 参数 说明 模板名称 新建模板的名称。 描述 其他描述。 邮件或短信 主题 邮件主题内容，该参数仅当选择邮件方式时存在。 正文 支持以邮件或短信进行告警消息通知，消息通知模板中支持的变量及取值范围如下所示： 告警中文名称：${alarm_name} 告警英文名称：${alarm_name_en} 说明： 若告警上报的服务未上报告警英文名称时，将从告警中文名称中取值。 告警id：${alarm_id} 告警Region：${region_code} 告警类别：${event_category}，取值：硬件告警（HARDWARE）/云服务告警（SERVICE_ALARM） 告警级别：${event_severity}，取值：Critical/Major/Minor/Warning 告警对象：${event_object} 清除类型：${clear_category}，取值：发生（Occur）/清理（Clear） 时间：${time}，取值：告警发生时间/告警清理时间（UTC时间） 单击“确定”，完成创建。

前提条件 给用户组授权之前，请您了解用户组可以添加的系统权限，如表1所示。并结合实际需求进行选择。 表1 ESM系统策略 策略名称 描述 策略类型 策略使用建议 ESM FullAccess 拥有ESM管理权限，可以使用ESM所有功能。 系统策略 建议对进行开销户的管理员用户分配该策略。 ESM ReadOnlyAccess 拥有ESM只读权限，不可进行修改操作。 系统策略 建议对使用大屏可视的管理员用户分配该策略。

示例流程 图1 给用户授权ESM服务权限流程 创建用户组并授权 在IAM控制台创建用户组，并授予ESM服务的权限“ESM FullAccess”。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，验证ESM服务的权限： 在主菜单中选择 “组织”，进入“租户管理”页面。单击“创建租户”，若能正常创建租户，表示“ESM FullAccess”已生效。

操作步骤 管理员登录IAM控制台。 在统一身份认证服务，左侧导航窗格中，选择“委托”页签。 图1 委托 在委托列表中找到名称为“esm_agency”的委托，单击名称。 选择“授权记录”页签，找到“ SMN FullAccess”单击“操作 ＞ 删除”。 单击“确定”。 登录ESM，单击界面右上方用户名，选择“消息通知设置”。 在授权提示页面，阅读并确认授权信息，详情请参见授权。 授权成功后，委托中的权限将会更新为支持消息通知服务（SMN）服务所需的最小化和必要权限。

修订记录 发布日期 修订记录 2025-03-30 第六次正式发布。 2024-10-30 第五次正式发布。 新增： 管理委托：管理委托。 我的工单：我的工单。 2024-07-30 第四次正式发布。 新增： 运营大屏：硬件设备监控大屏。 大屏管理：自定义Logo及订阅授权。 2024-04-30 第三次正式发布。 新增： 运营大屏：HCSO云服务资源容量明细。 2023-11-30 第二次正式发布。 新增：消息通知：新增消息通知功能。 2023-10-30 第一次正式发布。