华为云用户手册

响应示例 状态码： 200 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "phone_id" : "1234567b8bab40ffb711234cb80d0234", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "phone_id" : "1678567b8bab40f93711234cb80d0764", "job_id" : "1564567b8bab40f34711234cb80d5678" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of PhoneJob objects 任务列表。 表5 PhoneJob 参数 参数类型 描述 phone_id String 云手机的唯一标识ID，云手机相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 jobs Array of ServerJob objects 任务列表。 表5 ServerJob 参数 参数类型 描述 server_id String 云手机服务器的唯一标识ID，云手机服务器相关任务包含此字段。 job_id String 任务的唯一标识。 error_code String 错误码。 error_msg String 错误说明。

URI GET /v1/{project_id}/cloud-phone/servers/share-files 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量为一个大于等于0整数，表示查询该偏移量后面的所有的资源数，默认值为0。 limit 否 Integer 每页返回的资源个数。取值范围：1~100（默认值为100），一般设置为10、20、50。 server_ids 是 String 云手机服务器ID列表，多个服务器ID用逗号（,）分隔。 path 是 String 待查询的目录名称， 可以包含大小写字母、数字、“.”、“+”、“-”、“_”、“/”、"="；必须以“/”开头，并且不能只包含“/”；不能包含“../”、“//”等。 示例：/data/data

响应示例 状态码： 200 OK { "servers" : [ { "server_name" : "cph-edgr-1", "server_id" : "4aff349ab539452a85ac5d7442b39377", "server_model_name" : "physical.rx1.xlarge", "phone_model_name" : "rx1.cp.c105.d6.e5v5", "keypair_name" : "keypair01", "status" : 2, "vpc_id" : "9a11e291-967f-4dd6-99bd-9be54f10583c", "cidr" : "192.168.0.0/16", "vpc_cidr" : "192.168.0.0/16", "subnet_id" : "c7f9983d-03ca-4a2e-a0e1-d6bd97174669", "subnet_cidr" : "192.168.0.0/24", "addresses" : [ { "intranet_ip" : "192.168.0.62", "server_ip" : "192.168.0.62", "access_ip" : "10.246.175.190", "public_ip" : "10.246.175.190" }, { "intranet_ip" : "192.168.0.169", "server_ip" : "192.168.0.169", "access_ip" : "10.246.171.245", "public_ip" : "10.246.171.245" } ], "resource_project_id" : "06a5b529fa80d28b2f53c014024bed44", "metadata" : { "product_id" : "00301-221014-0--0", "order_id" : "CS21111116336E8RX" }, "availability_zone" : "br-iaas-odin1a", "network_version" : "v2", "create_time" : "2021-11-11T08:33:40Z", "update_time" : "2021-11-11T09:28:30Z" }, { "server_name" : "cph-igfp-2", "server_id" : "6d74b672216d40f39377a99e7f95aa95", "server_model_name" : "physical.kg1m.4xlarge.cg", "phone_model_name" : "kg1m.cg.c60.d20SSD.e1v1", "keypair_name" : "KeyPair-2", "status" : 2, "vpc_id" : "12021c68-730f-41fa-9884-11c616f4c9ad", "cidr" : "172.31.0.0/16", "vpc_cidr" : "172.31.0.0/16", "subnet_id" : "92cf2447-163c-4fe8-897b-fd262ab6b134", "subnet_cidr" : "172.31.0.0/16", "addresses" : [ { "intranet_ip" : "172.31.185.82", "access_ip" : "88.88.48.151", "server_ip" : "172.31.185.82", "public_ip" : "88.88.48.151" } ], "resource_project_id" : "06a5b529fa80d28b2f53c014024bed44", "metadata" : { "product_id" : "OFFI635412973496623104", "order_id" : "CS21083015171L1CA" }, "availability_zone" : "br-iaas-odin1a", "network_version" : "v1", "create_time" : "2021-08-30T07:17:40Z", "update_time" : "2021-11-05T09:07:57Z" } ], "request_id" : "4336f6c61d2048c6b58b4368d9d95ecd", "count" : 2 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 count Integer 实例总数。 servers Array of Server objects 云手机服务器信息。 表5 Server 参数 参数类型 描述 server_name String 云手机服务器名称，不超过65字符，只支持英文字母、数字、汉字、下划线和中划线。 availability_zone String 云手机服务器所在的可用区。 server_id String 云手机服务器的唯一标识，不超过32个字节。 server_model_name String 云手机服务器规格名称，不超过64个字节。 phone_model_name String 云手机规格名称，不超过64个字节。 keypair_name String 连接云手机所使用的密钥对的名称，不超过64个字节。 status Integer 服务器状态。 0、1、3、4：创建中 2：异常 5：正常 8：冻结 10：关机 11：关机中 12：关机失败 13：开机中 vpc_id String 云手机服务器所属虚拟私有云（简称VPC）的ID。 网络版本network_version取值为“v1”时，表示云手机服务器所属资源租户的VPC ID；取值为“v2”时，表示租户创建服务器时指定VPC的 VPC ID。 cidr String 云手机服务器所属虚拟私有云（简称VPC）的网段。网络版本 network_version 取值为“v1”时，表示云手机服务器所属资源租户的VPC CIDR；取值为“v2”时，表示租户创建服务器时指定 VPC 的 VPC CIDR。 vpc_cidr String 云手机服务器所属虚拟私有云（简称VPC 网络版本 network_version 取值为“v1”时，表示云手机服务器所属资源租户的VPC CIDR；取值为“v2”时，表示租户创建服务器时指定 VPC 的 VPC CIDR subnet_id String 云手机服务器所属子网的ID。仅在网络版本 network_version 取值为“v2”时，该取值表示租户创建服务器时指定子网的 ID，网络版本取值为“v1”时，该字段表示云手机服务器所属资源租户的子网ID。 subnet_cidr String 云手机服务器所属子网网段。网络版本 network_version 取值为“v2”时，表示租户创建服务器时指定子网的 CIDR; 取值为“v1”时，表示云手机服务器所属资源租户的子网CIDR。 addresses Array of Address objects 云手机服务器的IP相关信息。 resource_project_id String 云手机服务器的项目ID。 metadata metadata object 订单以及产品相关信息。 network_version String 是否为自定义网络的云手机服务器标识。"v1"，非自定义网络的云手机服务器。 "v2"，自定义网络的云手机服务器。支持按照网络版本字段进行筛选。 enterprise_project_id String 云手机服务器所属企业项目ID。 create_time String 创建时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 update_time String 更新时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 表6 Address 参数 参数类型 描述 intranet_ip String 云手机服务器的内网IP，过期字段。 access_ip String 云手机服务器的公网IP，过期字段。 server_ip String 云手机服务器的内网IP，新增字段。 public_ip String 云手机服务器的公网IP，新增字段。 表7 metadata 参数 参数类型 描述 product_id String 订单ID，不超过64个字节。 order_id String 产品ID，不超过64个字节。

URI GET /v1/{project_id}/cloud-phone/servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量为一个大于等于0整数，表示查询该偏移量后面的所有的资源数，默认值为0。 limit 否 Integer 每页返回的资源个数。取值范围：1~100（默认值为100），一般设置为10、20、50。 server_name 否 String 云手机服务器名称，支持模糊查询。 server_id 否 String 云手机服务器的唯一标识。 network_version 否 String 云手机服务器是否为自定义网络标识。 v1：系统定义网络的云手机服务器 v2：自定义网络的云手机服务器 phone_model_name 否 String 手机规格名称。 create_since 否 Long 查询的起始时间戳。 create_until 否 Long 查询的结束时间戳。 status 否 Integer 服务器状态。 0、1、3、4：创建中 2：异常 5：正常 8：冻结 10：关机 11：关机中 12：关机失败 13：开机中

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 members Array of ListImageMembersView objects 镜像成员详情 表4 ListImageMembersView 参数 参数类型 描述 create_time Long 共享时间 update_time Long 更新时间 image_id String 镜像ID member_id String 被共享账号的PROJECT_ID

响应示例 状态码： 200 OK { "members" : [ { "image_id" : "23030320230421e300221a2000004167", "member_id" : "87dc6af96095488d9205b6f31f314b16", "create_time" : 1713320018058, "update_time" : 1713320018058 }, { "image_id" : "23030320230421e300221a2000004167", "member_id" : "6733a7ad58694af18c7ee4820052d63f", "create_time" : 1713083265307, "update_time" : 1713083265307 } ] }

什么是区域、可用区？ 区域和可用区用来描述数据中心的位置，您可以在特定的区域、可用区创建资源。 区域（Region）：从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区（AZ，Availability Zone）：一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 图1阐明了区域和可用区之间的关系。 图1 区域和可用区 目前，华为云已在全球多个地域开放云服务，您可以根据需求选择适合自己的区域和可用区。更多信息请参见华为云全球站点。

如何选择区域？ 选择区域时，您需要考虑以下几个因素： 地理位置 一般情况下，建议就近选择靠近您或者您的目标用户的区域，这样可以减少网络时延，提高访问速度。 在除中国大陆以外的亚太地区有业务的用户，可以选择“中国-香港”、“亚太-曼谷”或“亚太-新加坡”区域。 在非洲地区有业务的用户，可以选择“非洲-约翰内斯堡”区域。 在拉丁美洲地区有业务的用户，可以选择“拉美-圣地亚哥”区域。 “拉美-圣地亚哥”区域位于智利。 资源的价格 不同区域的资源价格可能有差异，请参见华为云服务价格详情。

CPH权限 默认情况下，管理员创建的IAM用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 CPH部署时通过物理区域划分，为项目级服务。授权时，“授权范围”需要选择“指定区域项目资源”，然后在指定区域（如华东-上海一）对应的项目（cn-east-3）中设置相关权限，并且该权限仅对此项目生效；如果“授权范围”选择“所有资源”，则该权限在所有区域项目中都生效。访问CPH时，需要先切换至授权区域。 权限根据授权精细程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于华为云各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对ECS服务，管理员能够控制IAM用户仅能对某一类云服务器资源进行指定的管理操作。多数细粒度策略以API接口为粒度进行权限拆分，权限的最小粒度为API授权项（action），CPH支持的API授权项请参见策略及授权项说明。 如表1所示，包括了CPH的所有系统权限。 表1 CPH系统权限 角色名称 描述 类别 依赖关系 CPH Administrator 云手机服务器服务的管理员权限，拥有该权限的用户拥有云手机服务器服务所有执行权限。 系统角色 对于购买自定义网络的服务器，需要依赖VPC FullAccess权限,在同项目中勾选依赖的角色。 CPH User 云手机服务器服务只读权限，拥有该权限的用户仅能查看云手机服务器资源数据。 系统角色 依赖Tenant Guest，在同项目中勾选依赖的角色。 CPH FullAccess 云手机服务已支持细粒度授权项的所有执行操作。 系统策略 不支持的授权项需结合系统角色进行授权。 CPH ReadOnlyAccess 云手机服务已支持细粒度授权项的只读操作，即查看云手机服务器资源数据。 系统策略 不支持的授权项需结合系统角色进行授权。 CPH NotSupportEnterpriseAccess 云手机服务不支持企业项目的细粒度权限项集合。 使用企业项目功能时：在企业项目视图授权了CPH FullAccess策略后，还需要在IAM项目视图授权该策略，用户才可以正常使用CPH的全部功能。 系统策略 不支持的授权项需结合系统角色进行授权。 CPH AgencyDependencyAccess 云手机服务依赖用户委托给服务的细粒度权限项集合。 包含云手机服务在创建云手机服务器时依赖的其他服务的权限。 系统策略 不支持的授权项需结合系统角色进行授权。 表2列出了常用操作与系统角色的授权关系，您可以参照该表选择合适的系统角色。 表2 常用操作与系统角色的关系 操作 CPH Administrator CPH User CPH FullAccess CPH ReadOnlyAccess CPH NotSupportEnterpriseAccess 购买云手机服务器 √ × √ × × 删除云手机服务器 √ × √ × × 切换云手机服务器 √ × √ × × 查询云手机服务器列表 √ √ √ √ × 查询云手机服务器详情 √ √ √ √ × 查询云手机服务器规格列表 √ √ √ √ √ 修改云手机服务器名称 √ × √ × × 变更云手机服务器规格 √ × √ × × 重启云手机服务器 √ × √ × × 推送共享存储文件 √ × √ × × 查询共享存储文件 √ √ √ √ × 删除共享存储文件 √ × √ × × 推送共享应用 √ × √ × × 删除共享应用 √ × √ × × 更改密钥对 √ × √ × × 查询编码服务 √ √ √ √ × 重启编码服务 √ × √ × × 查询带宽信息 √ √ √ √ √ 修改共享带宽 √ × √ × √ 查询云手机列表 √ √ √ √ × 查询云手机详情 √ √ √ √ × 查询云手机规格列表 √ × √ × √ 重置云手机实例 √ × √ × × 重启云手机实例 √ × √ × × 关闭云手机实例 √ × √ × × 修改云手机名称 √ × √ × × 更新云手机属性 √ × √ × × 导出云手机数据 √ × √ × × 恢复云手机数据 √ × √ × × 云手机流量导流 √ × √ × × 云手机磁盘扩容 √ × √ × × 获取云手机连接信息 √ √ √ √ × 执行异步adb shell命令 √ × √ × × 执行同步adb shell命令 √ × √ × × 查询任务执行状态 √ √ √ √ √ 查询任务执行状态列表 √ √ √ √ √ 批量添加标签 √ × √ × × 批量删除标签 √ × √ × × 查询资源实例 √ √ √ √ × 查询资源标签 √ √ √ √ × 查询项目标签 √ √ √ √ × 获取手机镜像列表 √ √ √ √ √ 删除手机镜像 √ × √ × × 手机镜像共享 √ × √ × × 获取手机镜像共享用户列表 √ √ √ √ × 手机镜像取消共享 √ × √ × × 获取可用区列表 √ √ √ √ √ 获取子网列表 √ √ √ √ √ 查询对等连接配置 √ √ √ √ √ 删除对等连接配置 √ × √ × × 添加对等连接配置 √ × √ × × 导出云手机详情 √ × √ × × 创建委托 √ × √ × √ 检查委托 √ × √ × √

示例流程 图1 给用户授予SWR权限流程 创建用户组并授权 在IAM控制台创建用户组，并授予容器镜像服务的管理员权限“SWR Administrator”。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，切换至授权区域，验证权限（如果能顺利完成如下操作，说明权限设置成功）： 在“服务列表”中选择容器镜像服务，进入SWR主界面。 在左侧导航栏选择“组织管理”，单击右上角“创建组织”，输入组织名称，能够成功创建组织。 在左侧导航栏选择“我的镜像”，单击右上角“页面上传”，选择上一步创建的组织，以及一个本地的镜像文件，能够成功上传镜像。

创建组织 容器镜像服务为您提供组织管理功能，方便您根据自身组织架构来构建镜像的资源管理。上传镜像前，请先创建组织。 登录容器镜像服务控制台。 单击控制台左上角的，选择区域和项目。 在左侧导航栏单击“组织管理”，进入组织管理页面。 单击页面右上角的“创建组织”按钮，在弹框中填写“组织名称”，然后单击“确定”。 组织名称全局唯一，即当前区域下，组织名称唯一。创建组织时如果提示组织已存在，可能该组织名称已被其他用户使用，请重新设置一个组织名称。 用户在IAM中被授予SWR Admin或Tenant Administrator策略才有创建组织的权限。

业务架构画图 左侧导航树选择“架构设计”进入架构设计页面。 点击左上角“新建业务架构”，需要填写架构名称，选择架构类型（对画图无影响），填写描述，选择部署情况（对画图无影响）。 “业务架构”列表中找到刚刚新建的业务架构图，鼠标放到架构图中央，单击“查看架构图”，进入架构图。 单击画图上方“浏览”开关打开编辑功能。 左侧提供了画图需要的基础图元。 左侧“部署架构”一栏包含了已经创建好的部署架构图，可以拖拽至画布进行关联画图，还可以双击部署架构图图元查看架构图信息。

创建提取任务 在Druid页面列表中，单击待编辑任务的Druid数据源所在行的“编辑任务”，进入该数据源提取任务页面。 单击“创建任务”，进入“创建任务”页面。 配置任务参数，参数说明如表2所示。配置完成后，单击“确定”。 表2 配置任务参数说明 参数名称 参数说明 名称 Druid提取任务名，默认与数据源同名，无需手动填写。 描述 输入描述信息。 调度集成 定时执行Druid提取任务的调度集群。 Kafka Topic 选择需要消费数据的kafka topic。 使用最早offset消费 首次提交的任务设置为false，补数据时配置为true。 任务数 需要多少个并发进程同时读取该druid任务所对应的kafka topic，任务数（默认为2）应该小于topic分区数，并且能被topic分区数所整除，这样每个druid的子任务可以读取相同的数据量，达到负载均衡的效果。 指标列表 该指标列表由创建数据源时选择的指标决定，如果指标与对应的kafka字段名一致，会自动填充，如果不一致，需手动添加映射。 任务配置完成后，在Druid页面列表中，单击已编辑的任务的Druid数据源所在行的“启动”，启动导流任务。 在数据源生命周期内，Druid集群会持续提取Kafka数据到Druid数据源中。

更多操作 您还可以对Druid进行以下操作。 表3 Druid管理 操作名称 操作步骤 导入 在Druid页面单击“导入”。 上传文件。 查看导入进度 在Druid页面单击“查看导入进度”。 导出 在Druid页面列表中，勾选需要导出的Druid数据源。 单击列表上方的“导出”。 编辑Tags 在Druid页面单击“编辑Tags”。 在“编辑Tags”页面单击“新建Tags”。 输入Tags并单击“保存”。 单击“确定”。 关联Tags 在Druid页面列表中，单击待关联Tags数据源所在行的“关联Tags”。 选择已新建的Tags。 单击“确定”。 说明： 关联Tags之前须先编辑并新建Tags。 编辑数据源 在Druid页面列表中，单击待编辑Druid数据源所在行的“编辑”。 删除数据源 在Druid页面列表中，单击待删除Druid数据源所在行的“删除”。 查看操作历史 在Druid页面列表中，单击待查看操作历史的Druid数据源所在行的“操作历史”。 查看历史版本信息 在Druid页面列表中，单击待查看历史版本信息的Druid数据源所在行的“历史版本信息”。 （可选）可单击历史版本所在行的“对比当前版本”，查看版本差异。

更多操作 您还可以对组件资源进行以下操作。 表3 组件管理操作 操作名称 操作步骤 下载 在代码包详情列表，可以选择需要下载的版本所在行“操作”列的“下载”。 解析 在代码包详情列表，可以选择需要解析的版本所在行“操作”列的“解析”。 激活、去激活 在代码包详情列表，可以选择需要激活的版本所在行“操作”列的“激活”。 已激活的版本，如需回退到之前的版本，可以把新版本的代码包“去激活”，变更后即可回退为最后一个激活的版本。

scriptcollet 插件类型 APP 功能说明 执行脚本命令或者读取指定文件内容，并将结果上报给HCW。 参数配置 配置样例： type：script # 采集方式，可选填 script（采集脚本）或者 path（采集文件）。 ex_path：/opt/huawei/monitor/disk.sh # 脚本执行路径或者采集文件路径。 _filter_key_id：/opt/huawei/monitor/disk.sh # 多实例插件的key，此参数是为了支持多实例插件上报使用，只需要保证多个实例中该值均不同，建议与ex_path值保持一致。 scriptcollect为多实例插件，即scriptcollect插件可以配置多组参数，但需要每组参数均不相同。 消息样例及含义说明 { "plugin_id":"scriptcollect", #单位： | 类型：string | 说明：插件名 "metric":[{ "node": " host-10-22-0-170", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": "1518078026000", #单位： | 类型：string | 说明：字符类型时间戳 "key_id":"/opt/huawei/monitor/disk.sh", #单位： | 类型：string | 说明：对应模板配置的key值 "collect_value":"80", #单位： | 类型：string | 说明：执行脚本命令或者读取指定文件内容上报的值 }] }

redis 插件类型 APP 功能说明 检测redis数据库信息，并将检测结果上报至HCW。 参数配置 配置样例： _filter_port_id：6379 # redis端口 password：123456,123457 # redis密码，可配置多个密码。redis插件会先从/opt/zabbix/bin/redis_stats.sh中获取redis密码，若获取或校验失败，会去读取配置参数中的password中的密码列表。 redis为多实例插件，即redis插件可以配置多组参数，但需要每组参数均不相同。 消息样例及含义说明 { "plugin_id": "redis", #单位： | 类型：string | 说明：插件名 "metric": [ { "node": " host-10-22-0-170", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": "1518078026000", #单位： | 类型：string | 说明：字符类型时间戳 "port_id": "80", #单位： | 类型：string | 说明：redis端口 "port_status": "1", #单位： | 类型：string | 说明：端口状态，端口可达值为1，不可达值为0 "cpuload": "10", #单位： | 类型：string | 说明：redis进程CPU占用率 "used_memory": "2403776 ", #单位： | 类型：string | 说明：Redis分配器分配的内存总量 "mem_fragmentation_ratio": "5.60", #单位： | 类型：string | 说明：used_memory_rss和used_memory之间的比率 "used_memory_peak": "4352360", #单位： | 类型：string | 说明：Redis内存消耗峰值 "keyspace_hits": "47343", #单位： | 类型：string | 说明：命中key的次数 "keyspace_misses": "1437", #单位： | 类型：string | 说明：未命中key的次数 "connected_clients": "1", #单位： | 类型：string | 说明：连接的客户端数量 "evicted_keys": "0", #单位： | 类型：string | 说明：运行以来删除过的key的数量 "blocked_clients": "0", #单位： | 类型：string | 说明：正在等待阻塞命令（BLPOP、BRPOP、BRPOPLPUSH）的客户端的数量 "rejected_connections": "0", #单位： | 类型：string | 说明：因为最大客户端数量限制而被拒绝的连接请求数量 "used_memory_rss": "13471744", #单位： | 类型：string | 说明：Redis分配的内存总量(包括内存碎片) "loading": "0", #单位： | 类型：string | 说明：是否正在载入持久化文件，0为否，1为是 "rdb_bgsave_in_progress": "0", #单位： | 类型：string | 说明：后台进行中的 save 操作的数量 "rdb_last_bgsave_status": "1", #单位： | 类型：string | 说明：最后一次创建RDB文件的结果，0为失败，1为成功 "rdb_last_bgsave_time_sec": "1", #单位： | 类型：string | 说明：最后一次创建RDB文件耗费的秒数 "instantaneous_ops_per_sec": "0", #单位： | 类型：string | 说明：服务器每秒中执行的命令数量 "expired_keys": "1281", #单位： | 类型：string | 说明：过期而被自动删除的数据库键数量 "latest_fork_usec": "0", #单位： | 类型：string | 说明：最近一次fork()操作耗费的时间 "client_biggest_input_buf": "0", #单位： | 类型：string | 说明：当前连接的客户端中，最大的输入缓存 "client_longest_output_list": "0", #单位： | 类型：string | 说明：当前的客户端连接中，最长的输出列表 "keyspace_hits_ratio": "80" #单位： | 类型：string | 说明：keyspace_hits与keyspace_hits + keyspace_misses的比率 } ] }

file_regexp 插件类型 APP 功能说明 逐行读取指定路径文件，将内容按分界符分解为指标名称和指标值，并按照过滤条件过滤，将过滤后的指标数据上报给HCW。 参数配置 配置样例： path：/tmp/sds_zabbix.result # 采集文件路径。 delimiter # 分隔符。 _filter_key_word：.*_cassandra # 指标值关键字, 支持正则, 为空则直接上报所有指标信息，非空则只上报匹配关键字的指标数据。 _filter_value_word：ok* # 指标值匹配关键字，支持正则,为空则不进行二次匹配，直接上报指标数据，非空则 匹配成功为1，匹配失败为0。 file_regexp为多实例插件，即file_regexp插件可以配置多组参数，但需要每组参数均不相同。 消息样例及含义说明 { "plugin_id":"file_regexp", #单位： | 类型：string | 说明：插件名 "metric":[{ "node": " host-10-22-0-170", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": "1518078026000", #单位： | 类型：string | 说明：字符类型时间戳 "name_id":"zj23_cassandra", #单位： | 类型：string | 说明：分隔后的指标名称(标签数据) "value_id":"ok", #单位： | 类型：string | 说明：分割后的指标值(标签数据) "value":"1", #单位： | 类型：string | 说明：指标上报值 }] }

file_check 插件类型 APP 功能说明 查看文件是否存在以及查看文件的大小，以Byte为单位，将结果上报到HCW。 参数配置 配置样例： path：/tmp/error_*.log #路径为绝对路径，支持通配符。 消息样例及含义说明 { "plugin_id":"file_check", #单位： | 类型：string | 说明：插件名 "metric":[{ "node": " host-10-22-0-170", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": "1518078026000", #单位： | 类型：string | 说明：字符类型时间戳 "exists":"1", #单位： | 类型：string | 说明：文件是否存在，1表示存在，0表示不存在 "size":"80", #单位：Byte | 类型：string | 说明：表示文件大小 }] }

alarmmonitor 插件类型 ALARM 功能说明 周期性执行脚本，将指定文件中的业务告警数据，上报给HCW监控系统。 业务文件中写入的告警数据的站点site需要为cn_product_cbu，否则上报到监控服务后告警列表不会显示该告警。 参数配置 为插件配置业务文件采集路径： collect_file_path：${ALARM_HOME}/*.dat,/opt/huawei/alarm/hispace/*.dat 该配置为绝对路径，可以配置变量，并且能够把识别到的环境变量展开，可以配置通配符（*.），并将识别到的路径展开，可以配置多个路径，按逗号分隔。 如果使用了环境变量，要求在~/.bashrc中添加export命令进行配置。如export ALARM_HOME=/opt/huawei/alarm，在配置生效后，可通过source ~/.bashrc或重启机器，再启动agent进行数据采集。 消息样例及含义说明 插件按行上报业务文件中的监控告警数据，告警上报的数据会根据产品ID、服务ID、level等信息生成一个唯一标识，该标识为告警的指纹信息，监控服务会依据指纹信息进行告警的判重，不同的上报源指纹信息不同，具体如下： CES上报：产品id、服务id、'alarm_id'_'metric_name'、'dimension'、告警级别，其中单引号内字段均为CES上报告警体中的原始字段，alarm_id为CES告警id，metric_name为指标名称，dimension一般为资源id。 AOM上报：产品id、服务id、'id'、'cluster_name'、告警级别，其中单引号内字段均为AOM上报告警体中的原始字段，id为AOM告警id，cluster_name一般为资源id。 监控服务上报：产品id、服务id、'id'、'source_tag'、告警级别，其中单引号内字段均为监控服务上报告警体中的原始字段。 aiops上报：租户id、产品id、服务id、'id'，其中单引号内字段为aiops上报告警体中的原始字段。 监控告警数据样例如下所示，一个json体为一条告警，内容需要写在一行中，以下示例是为了方便查看和理解分行展示，并且文件的json体中间或者结尾不能有空行。 #上报告警 { "id":"q20934uii2uss8i7", #单位： | 类型：string | 说明：告警ID "name":"The IF getxxx is abnormal", #单位： | 类型：string | 说明：告警名称 "level":"major", #单位： | 类型：string | 说明：告警级别 "site": "cn_product_cbu", #单位： | 类型：string | 说明：站点 "tenant_id": "T006", #单位： | 类型：string | 说明：租户ID "application_id": "com.huawei.wiseeye", #单位： | 类型：string | 说明：产品ID "service_id": "com.huawei.wiseeyewatchservice", #单位： | 类型：string | 说明：服务ID "env_id": "6132b864b7c6437691fa55c1f44dec4e", #单位： | 类型：string | 说明：可选, 环境ID "source_tag":"host-10-22-0-36", #单位： | 类型：string | 说明：告警产生来源 "op_type":"firing", #单位： | 类型：string | 说明：告警操作类型(firing 产生告警、resolved 清除告警) "details":"DownloadSuccess is less than 90% for 5m", #单位：| 类型：string | 说明：告警详情 "clear_type":"ADAC", #单位： | 类型：string | 说明：清除类型，固定写为ADAC，无具体逻辑含义 "start_timestamp":1514942958000, #单位： | 类型：long | 说明：告警开始时间戳 "end_timestamp":0 #单位： | 类型：long | 说明：告警结束时间戳 "receive":"xx8000000", #单位： | 类型：string | 说明：可选, 告警接收人名单 } #清除告警 { "id":"qjxswr8ge2no5mat", #单位： | 类型：string | 说明：告警ID "name":"The IF getxxx is abnormal", #单位： | 类型：string | 说明：告警名称 "level":"critical", #单位： | 类型：string | 说明：告警级别 "site": "cn_dev_default", #单位： | 类型：string | 说明：站点 "tenant_id": "T006", #单位： | 类型：string | 说明：租户ID "application_id": "com.huawei.wiseeye", #单位： | 类型：string | 说明：产品ID "service_id": "com.huawei.wiseeyewatchservice", #单位： | 类型：string | 说明：服务ID "env_id": "6132b864b7c6437691fa55c1f44dec4e", #单位： | 类型：string | 说明：可选, 环境ID "source_tag":"host-10-22-0-36", #单位： | 类型：string | 说明：告警产生来源 "op_type":"resolved ", #单位： | 类型：string | 说明：告警操作类型(firing 产生告警、resolved 清除告警) "start_timestamp":0, #单位： | 类型：long | 说明：告警开始时间戳 "end_timestamp":1515242958000 #单位： | 类型：long | 说明：告警结束时间戳 "receive":"xx8000000", #单位： | 类型：string | 说明：可选, 告警接收人名单 }

logalarm 插件类型 ALARM 功能说明 监控指定日志文件，配置日志匹配关键字，并按照配置参数的要求，生成告警并上报到HCW。 参数配置 collect_file_path #日志文件采集路径 消息样例及含义说明 插件按照配置参数的要求上报日志告警数据，日志告警数据样例： { "id": "Log_030104014395", #单位： | 类型：string | 说明：告警ID "use_custom_id":"" #单位： | 类型：string | 说明：是否使用用户自定义告警ID "alarm_name": "Interface getSC() success rate abnormal", #单位： | 类型：string | 说明：告警名称(支持配置变量{{$log_info}}，上报告警时会替换成匹配到的最后一条ERROR日志；支持配置变量{{$all_matching_log}}，上报告警时会替换成匹配到的所有ERROR日志，当alarm_name配置了变量{{$all_matching_log}}时，若产生告警且后续周期又匹配到了告警，新匹配到的告警会在原告警ID的基础上，产生一个新的告警，并上报到监控系统，告警清除时会清除当前告警和后续产生的告警；当alarm_name配置为空时，会读取文件中的所有内容，逐行检测并上报告警。） "alarm_level": "critical", #单位： | 类型：string | 说明：告警级别（notice 提示、minor 一般、major 严重、critical 致命） "key_word": "-ERROR .*getSC", #单位： | 类型：string | 说明：日志匹配关键字，支持正则表达式 "match_file": "/opt/huawei/test/error.log", #单位： | 类型：string | 说明：日志文件绝对路径，支持变量、通配符，配置多个地址时需要使用逗号分隔 "matches": 2, #单位： | 类型：long | 说明：最大匹配次数 "number_of_match_period": 30, #单位： | 类型：long | 说明：匹配周期数，与matches和key_word组合使用（30个周期内匹配2次以上，则产生告警；30个周期内匹配2次或者2次以下，则清除告警。） "number_of_nodata_period": 10, #单位： | 类型：long | 说明：无数据上报的周期数, 单独使用，与matches和key_word无关联（10个周期内有数据则产生告警，10个周期内无数据上报则清除告警。） "description": "test" #单位： | 类型：string | 说明：告警详情，进一步丰富告警信息 }

mem 插件类型 OS 功能说明 采集全系统有关的内存信息。 原始数据来源：/proc/meminfo、/proc/vmstat 参数配置 不需配置。 消息样例及含义说明 { "plugin_id": "mem", "metric": { "node": "host-10-33-0-188", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": 1482161028000, #单位： | 类型：long | 说明：UTC时间戳 "active": "6476724", #单位：kB | 类型：int | 说明：活跃内存 "buffers": "1776864", #单位：kB | 类型：int | 说明：buffers缓存 "cached": "8662036", #单位：kB | 类型：int | 说明：cached缓存 "dirty": "152", #单位：kB | 类型：int | 说明：等待写回磁盘的内存 "inactive": "4966164", #单位：kB | 类型：int | 说明：不活跃内存 "mem_free": "3964160", #单位：kB | 类型：int | 说明：可用内存 "mem_free_in_buf_cache": "14403060", #单位：kB | 类型：int | 说明：实际可用内存(+buffers+cached) "mem_free_size": "15072556", #单位：kB | 类型：int | 说明："MemFree + Cached + Buffers + SReclaimable + Swapcached + Nfs_unstable - Shmem" "mem_total": "16311792", #单位：kB | 类型：int | 说明：全部内存 "mem_used": "12347632", #单位：kB | 类型：int | 说明：已用内存 "mem_used_ex_buf_cache": "1908732", #单位：kB | 类型：int | 说明：实际内存占用(-buffers-cached) "mem_used_size": "1239236", #单位：kB | 类型：int | 说明：mem_total - mem_free_size "mem_util": "7.6", #单位：% | 类型：double | 说明：mem_used_size / mem_total "swap_cached": "2632", #单位：kB | 类型：int | 说明：交换内存被缓存的大小 "swap_free": "4151180", #单位：kB | 类型：int | 说明：当前未使用的交换空间数 "swap_total": "4192252", #单位：kB | 类型：int | 说明：可用的交换空间总数 "swap_util": "3", #单位：% | 类型：double | 说明：交换空间占用率 "writeback": "0", #单位：kB | 类型：int | 说明：正在写回磁盘的内存 "pgfault": "4123", #单位： | 类型：int | 说明：本周期page fault数 "pgin": "0", #单位： | 类型：int | 说明：本周期page in数 "pgmajfault": "0", #单位： | 类型：int | 说明：本周期major page fault数 "pgout": "0" #单位： | 类型：int | 说明：本周期page out数 }}

tomcat 插件类型 APP 功能说明 针对机器上运行性的多个Tomcat进程，周期采集其运行数据。 插件运行后，将首先在“agent框架lib/tomcat/”路径下生成TomcatJmx_fat.jar，后续每次执行时，都会通过该jar包使用JMX接口采集tomcat进程相关信息。每次采集结束，每个tomcat进程分别生成一条消息，http_port可作为区分标志。 参数配置 用户在使用该插件进行采集之前，需要先手动修改tomcat安装目录下bin/catalina.sh，在文件中添加以下字段以支持JMX采集功能： CATALINA_OPTS="$CATALINA_OPTS -Djava.rmi.server.hostname=127.0.0.1 -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=58880 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false" 用户还需要为插件配置当前本机运行中的Tomcat对应的安装路径，可配置单个或多个，以”,”做分隔符。 tomcat_install_path #可以识别绝对路径以及环境变量。 如果采用环境变量来传递Tomcat安装路径，要求在~/.bashrc中添加export命令进行配置，如下图： 在配置生效后，可通过source ~/.bashrc或重启机器，再启动agent进行数据采集。 消息样例及含义说明 {      "plugin_id":"tomcat",     "metric":{ "node": " host-10-33-0-188", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": 1482161028000, #单位： | 类型：long long | 说明：UTC时间戳 "request_count":"0", #单位： | 类型：double | 说明：采集间隔内新增请求数 "request_errors_count":"0", #单位： | 类型：double | 说明：采集间隔内新增错误请求数 "thread_total":"47", #单位： | 类型：double | 说明：累计线程数 "http_port_id":"8080", #单位： | 类型：double | 说明：tomcat对外提供服务的端口号         } }

osinfo 插件类型 OS 功能说明 osinfo插件采集操作系统相关信息。 使用该插件要求/etc/nsswitch.conf文件有读权限，且其中hosts的解释项不能使用dns，即cat /etc/nsswitch.conf | grep "^hosts:" | grep dns命令返回应为空。"running"/"sleeping"/"stopped"/"zombie"，全部进程数total与top命令输出的结果一致；最大文件打开数max_opens、最大进程数max_procs与ulimit -u、ulimit -n命令输出一致；本机当前打开的句柄数open_files与lsof|wc –l命令输出一致。open_files的获取每180秒只采集并上报一次，对于那些没有采集open_files的周期，该指标不出现在消息中。 原始数据来源：/proc/stat 参数配置 不需配置。 消息样例及含义说明 { "plugin_id": "osinfo", "metric": { "node": " host-10-33-0-188", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": 1482161028000, #单位： | 类型：long | 说明：UTC时间戳 "ctx": "245480", #单位： | 类型：int | 说明：本周期上下文切换次数 "procs": "1032", #单位： | 类型：int | 说明：采集周期内新增的任务总数 "blocked": "0", #单位： | 类型：int | 说明：当前被阻塞的任务数 "running": "0", #单位： | 类型：int | 说明：当前R状态的进程数（top: running） "sleeping": "882", #单位： | 类型：int | 说明：当前D状态的进程数（top: sleeping） "stopped": "1", #单位： | 类型：int | 说明：当前T状态的进程数（top: stopped） "zombie": "1" #单位： | 类型：int | 说明：当前Z状态的进程数（top: zombie） "procs_total": "884", #单位： | 类型：int | 说明：当前总进程数（top: Tasks） "max_opens": "1024", #单位： | 类型：int | 说明：执行ulimit -n结果 "max_procs": "2059087", #单位： | 类型：int | 说明：执行ulimit -u结果 "open_files": "2059087", #单位： | 类型：int | 说明：本机当前打开的句柄数 } }

tcp 插件类型 APP 功能说明 检测本机或者指定主机端口是否可连通，并将结果返回HCW。 参数配置 配置样例： _filter_ip_id：xxx.0.0.1 # 检测IP，检测本机指定端口是否可达，配置值为127.0.0.1，检测指定主机端口是否可达，配置值为指定主机IP；当检测本机端口是否可达时，会检测127.0.0.1+端口和本机公网IP+端口是否可达，若有一项可达则表明本机端口可达。 _filter_port_id：80 # 检测端口。 TCP为多实例插件，即TCP插件可以配置多组参数，但需要每组参数均不相同。 消息样例及含义说明 {    "plugin_id":"tcp", #单位： | 类型：string | 说明：插件名    "metric":[{ "node": " host-10-33-0-188", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": "1518078026000", #单位： | 类型：string | 说明：字符类型时间戳 "port_status":"1", #单位： | 类型：string | 说明：端口状态，端口可达值为1，不可达值为0 "ip_id":"xxx.0.0.1", #单位： | 类型：string | 说明：检测IP "port_id":"80", #单位： | 类型：string | 说明：检测端口 }] }

fs 插件类型 OS 功能说明 统计文件系统使用情况，采集数据内容和df -lh命令一致。 参数配置 配置样例：“_filter_mounted_name：^/shm,/dev,/opt”，其中带"^"前缀的为反向筛选关键字（/shm），其余为正向筛选关键字（/dev、/opt），每条消息在最终生成之前，插件会先执行一次正向筛选（若mounted_name的值包含/dev或/opt任一字段，则保留这条消息；反之则删掉。若没有配置正向筛选关键字，则跳过这步筛选，保留消息。）若该条消息得以保留，插件会继续执行一次反向筛选（若mounted_name的值包含/shm字段，则删掉这条消息；反之则保留。若没有配置反向筛选关键字，则跳过这步筛选，保留消息。） 假设某台服务器执行df -lh命令结果如图2所示，共4行数据，按照_filter_mounted_name：^/shm,/dev,/opt”配置正反向过滤后，仅生成第2、4行对应的消息。/dev/shm由于包含/shm，对应的消息将被剔除。 图2 示例2 消息样例及含义说明 { "plugin_id": "fs", "metric": { "node": "host-10-33-0-188", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": 1482161028000, #单位： | 类型：long long | 说明：UTC时间戳 "fs_name": "/dev/mapper/vg1-lv1", #单位： | 类型：string | 说明：文件系统（= df命令的Filesystem列） "free": " 8707.9", #单位：mb | 类型：double | 说明：分区可用空间大小（= df命令的Avail列） "total": " 90710.0", #单位：mb | 类型：double | 说明：分区总大小（= df命令的Size列） "usage": "90.0", #单位：% | 类型：double | 说明：分区使用率（= df命令的Use%列） "used": " 80988.4", #单位：mb | 类型：double | 说明：分区已使用大小（= df命令的Used列） "mounted_name":"/opt", #单位： | 类型：string | 说明：分区挂载点（= df命令的Mounted on列） "index_node_use_util": " 3.00000 " #单位：% | 类型：double | 说明：inode使用率（= df -i命令的IUse%列） }

net 插件类型 OS 功能说明 采集网络IO信息，默认采集的目标网卡与本机ifconfig命令显示的网卡列表一致，仅采集ifconfig显示UP状态的网卡。 原始数据来源：/proc/net/dev 参数配置 通过_filter_nic_name配置，根据nic_name指标，对消息进行筛选，决定最终生成的哪些网卡的消息。 _filter_nic_name的配置比较特殊，只有当nic_name值以配置关键字串开头时，才会保留这条消息，而其他插件的消息筛选机制为包含即保留。如某台机器ifconfig列出的网卡名有eth0、eth1、veth1、lo。如果配置“_filter_nic_name：eth”，则剔除veth1和lo的消息，保留eth0、eth1的消息。 消息样例及含义说明 { "plugin_id": "net", "metric": { "node": "host-10-33-0-188", #单位： | 类型：string | 说明：主机名，消息来源标识 "timestamp": 1482161028000, #单位： | 类型：long long | 说明：UTC时间戳 "collps": "0.0000", #单位：次/s | 类型：double | 说明：检测到发送冲突频率 "nic_name": "enp2s0f0", #单位： | 类型：string | 说明：网卡名，与ifconfig列表一致 "rxcmpps": "0.0000", #单位：包/s | 类型：double | 说明：接收压缩报速率 "rxdropps": "0.0000", #单位：包/s | 类型：double | 说明：接收丢报速率 "rxdroprate": "0.0", #单位：% | 类型：double | 说明：接收丢报率 "rxerrps": "0.0000", #单位：次/s | 类型：double | 说明：接收错误频率 "rxfifops": "0.0000", #单位：次/s | 类型：double | 说明：接收FIFO缓存错误频率 "rxframps": "0.0000", #单位：次/s | 类型：double | 说明：接收帧错误频率 "rxkbps": "0.0000", #单位：kB/s | 类型：double | 说明：接收的kbps数,单位为KByte/s, 转换为kbps需乘以8 "rxmcstps": "0.0000", #单位：次/s | 类型：double | 说明：接收多播频率 "rxpckps": "0.0000", #单位：包/s | 类型：double | 说明：接收报文速率 "rxutil": "0.0", #单位：% | 类型：double | 说明：接收带宽利用率 "txcarrps": "0.0000", #单位：次/s | 类型：double | 说明：传输介质故障频率 "txcmpps": "0.0000", #单位：包/s | 类型：double | 说明：发送压缩报速率 "txdropps": "0.0000", #单位：包/s | 类型：double | 说明：发送丢报数速率 "txdroprate": "0.0", #单位：% | 类型：double | 说明：发送丢报率 "txerrps": "0.0000", #单位：次/s | 类型：double | 说明：发送错频率 "txfifops": "0.0000", #单位：次/s | 类型：double | 说明：发送FIFO缓存错误频率 "txkbps": "0.0000", #单位：kB/s | 类型：double | 说明：发送的kbps数，单位为KByte/s, 转换为kbps需乘以8 "txpckps": "0.0000", #单位：包/s | 类型：double | 说明：发送报文速率 "txutil": "0.0", #单位：% | 类型：double | 说明：发送带宽利用率 "running": "1" #单位：% | 类型：double | 说明：网卡运行状态监测，如果为1表示ifconfig该网卡状态RUNNING，如果为-1表示ifconfig该网卡状态非RUNNING }