华为云用户手册

响应示例 状态码：200 查询成功 { "versions" : [ { "id" : "v1", "links" : [ { "href" : "https://eg.cn-north-4.myhuaweicloud.com/v1", "rel" : "self" } ], "version" : "", "min_version" : "", "status" : "CURRENT", "updated" : "2022-04-19T12:20:10Z" } ] }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 versions Array of versions objects 版本定义 表3 versions 参数 参数类型 描述 id String 版本号，如v1 links Array of links objects url地址 version String 若该版本API支持微版本，则为支持的最大微版本号，如果不支持微版本，则为空 min_version String 若该版本API支持微版本，则为支持的最小微版本号，如果不支持微版本，则为空 status String 版本状态，支持CURRENT：推荐版本；SUPPORTED：老版本，仍支持使用；DEPRECATED：废弃版本，后续会删除 updated String 版本发布UTC时间 表4 links 参数 参数类型 描述 href String href属性 rel String rel属性

响应示例 状态码：200 请求成功 { "advance_config" : { "dcs2dcs" : null, "kafka2kafka" : { "compress_alg" : "none", "is_add_header" : false, "is_sync_progress" : true, "rename_topic" : false, "replica_cnt" : 1, "seek_to" : "earliest", "topic_mappings" : [ ], "topic_regex" : ".*", "topics" : "" } }, "cluster_id" : "1a8b384f-b788-3000-0010-924ef6f516b2", "created_time" : "2025-04-25T03:16:32Z", "description" : "", "err_code" : null, "err_message" : null, "job_id" : "1a959958-06f9-0000-0013-0bcb5b2cb356", "name" : "eventRoute-0ztrqj7o", "scene_type" : "DISASTER_BACKUP", "sink_config" : { "sink_kafka" : { "address" : "192.168.0.49:9092,192.168.0.91:9092,192.168.0.210:9092", "authenticate_mode" : "PLAINTEXT", "cluster_alias" : "b", "config_type" : "CLOUD", "instance_id" : "d7d5bcec-2b73-4331-a568-1288f23dbbb0", "password" : null, "project_id" : "bac852160cc743158936edaab6dda813", "region" : "cn-north-7", "sasl_mechanism" : "", "user_name" : "" } }, "sink_status" : "UNDEFINED", "sink_status_info" : "", "sink_type" : "KAFKA", "source_config" : { "source_kafka" : { "address" : "192.168.0.107:9092,192.168.0.216:9092,192.168.0.220:9092", "authenticate_mode" : "PLAINTEXT", "cluster_alias" : "a", "config_type" : "CLOUD", "instance_id" : "9280ed54-bd21-4721-bd99-7773b6b724ab", "password" : null, "project_id" : "bac852160cc743158936edaab6dda813", "region" : "cn-north-7", "sasl_mechanism" : "", "user_name" : "" } }, "source_status" : "UNDEFINED", "source_type" : "KAFKA", "status" : "WAIT_START", "subnet_id" : "33bd70bd-1d62-4438-96c8-da19fdd65230", "updated_time" : "2025-04-25T03:16:32Z", "vpc_id" : "0c4975eb-5575-4be0-b788-539ee002f45c" }

请求示例 更新jobId=123的专业版事件流作业 PUT https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/123 { "advance_config" : { "kafka2kafka" : { "compress_alg" : "none", "is_add_header" : false, "is_sync_progress" : true, "rename_topic" : false, "replica_cnt" : 1, "seek_to" : "earliest", "topic_mappings" : [ ], "topic_regex" : ".*", "topics" : "" } }, "cluster_id" : "1a8b384f-b788-3000-0010-924ef6f516b2", "description" : "", "name" : "eventRoute-0ztrqj7o", "scene_type" : "DISASTER_BACKUP", "sink_config" : { "sink_kafka" : { "address" : "192.168.0.49:9092,192.168.0.91:9092,192.168.0.210:9092", "authenticate_mode" : "PLAINTEXT", "cluster_alias" : "b", "config_type" : "CLOUD", "instance_id" : "d7d5bcec-2b73-4331-a568-1288f23dbbb0", "password" : null, "project_id" : "bac852160cc743158936edaab6dda813", "region" : "cn-north-7", "sasl_mechanism" : "", "user_name" : "" } }, "source_config" : { "source_kafka" : { "address" : "192.168.0.107:9092,192.168.0.216:9092,192.168.0.220:9092", "authenticate_mode" : "PLAINTEXT", "cluster_alias" : "a", "config_type" : "CLOUD", "instance_id" : "9280ed54-bd21-4721-bd99-7773b6b724ab", "password" : null, "project_id" : "bac852160cc743158936edaab6dda813", "region" : "cn-north-7", "sasl_mechanism" : "", "user_name" : "" } } }

响应参数 状态码：200 表14 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求ID 表15 响应Body参数 参数 参数类型 描述 cluster_id String 专业版事件流集群ID job_id String 专业版事件流作业ID name String 作业名称。约束：作业名称由大小英文字母、数字、点、中划线和下划线组成，必须以大小英文字母或数字开头，最多128个字符。 description String 作业描述，约束：作业描述不能超过256位。 scene_type String 场景类型 source_type String 源端类型 sink_type String 目标端类型 subnet_id String 子网ID vpc_id String 虚拟私有云ID source_config EventRouterJobSource object 专业版事件流作业源端配置 sink_config EventRouterJobSink object 专业版事件流作业目标端配置 advance_config EventRouterAdvanceConfig object 专业版事件流作业高级配置 status String 作业状态 err_code String 错误码 err_message String 错误原因 created_time String 创建UTC时间 updated_time String 更新UTC时间 sink_status String 目标端连通性状态 sink_status_info String 目标端连通性状态信息 source_status String 源端连通性状态 source_status_info String 源端连通性状态信息 log_group_id String 用户侧保存事件流作业日志的日志组ID log_stream_id String 用户侧保存事件流作业日志的日志流ID 表16 EventRouterJobSource 参数 参数类型 描述 source_kafka KafkaParameters object kafka配置 source_rocketmq RocketmqParameters object rocketmq配置 source_dcs DcsParameters object dcs配置 表17 EventRouterJobSink 参数 参数类型 描述 sink_kafka KafkaParameters object kafka配置 sink_rocketmq RocketmqParameters object rocketmq配置 sink_dcs DcsParameters object dcs配置 表18 KafkaParameters 参数 参数类型 描述 config_type String 实例类型 CLOUD：云服务DMS kafka实例 region String 区域ID project_id String 资源空间ID instance_id String kafka实例ID，配置类型选择CLOUD时必填 cluster_alias String kafka集群别名 address String kafka地址 authenticate_mode String kafka认证方式 sasl_mechanism String SASL认证机制 user_name String 用户名，开启SASL_SSL时必填 password String 用户密码，开启SASL_SSL时必填 表19 RocketmqParameters 参数 参数类型 描述 config_type String 实例类型。 CLOUD：云服务DMS Rocketmq实例 region String 区域id project_id String 资源空间ID instance_id String rocketmq实例ID，配置类型选择CLOUD时必填 cluster_alias String rocketmq集群别名 address String rocketmq地址 ssl_open String rocketmq SSL开关 true: 开启 false: 关闭 acl_open Boolean rocketmq ACL开关 true: 开启 false: 关闭 user_name String 用户名，开启ACL时必填 password String 用户密码，开启ACL时必填 表20 DcsParameters 参数 参数类型 描述 config_type String 实例类型 CLOUD：云服务D CS 实例 region String 区域id project_id String 资源空间ID instance_id String dcs实例ID，配置类型选择CLOUD时必填 address String dcs地址 password String 用户密码 表21 EventRouterAdvanceConfig 参数 参数类型 描述 kafka2kafka Kafka2KafkaAdvanceConfig object kafka同步自定义配置 rocketmq2rocketmq Rocketmq2RocketmqAdvanceConfig object rocketmq同步自定义配置 dcs2dcs Dcs2DcsAdvanceConfig object dcs同步自定义配置 表22 Kafka2KafkaAdvanceConfig 参数 参数类型 描述 topics String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex String 要同步的topic正则表达式，与topics参数二选一 replica_cnt Integer 副本数，不能大于broker数量 seek_to String 数据同步点 compress_alg String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 snappy：snappy压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 is_sync_progress Boolean 是否同步消费进度 true：同步 false：不同步 is_add_header Boolean 是否添加来源Header rename_topic Boolean 是否重命名Topic topic_mappings Array of KafkaTopicMapping objects topic映射 表23 KafkaTopicMapping 参数 参数类型 描述 source_topic String 源主题 sink_topic String 目标主题 表24 Rocketmq2RocketmqAdvanceConfig 参数 参数类型 描述 topics String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex String 要同步的topic正则表达式，与topics参数二选一 is_sync_progress Boolean 是否同步消费进度 seek_to String 数据同步点 最早（first），最新（last），自定义时间戳（long类型） compress_alg String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 表25 Dcs2DcsAdvanceConfig 参数 参数类型 描述 synchronize_type String 同步类型 默认全量加增量 connect_retry_time String 无法连接后重试时间，默认60秒 other_retry_time String 出现其他问题后的重试时间，默认60秒 use_rate_limit Boolean 是否限制增量同步速率，默认5MS/s true：限制 false：不限制 rate_limit String 限制增量同步速率，默认5MB/s use_salve_node Boolean 是否使用Slave节点 true：使用从节点同步数据 false：不使用从节点同步数据，即使用主节点

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 cluster_id 是 String 专业版事件流集群ID name 是 String 作业名称。约束：作业名称由大小英文字母、数字、点、中划线和下划线组成，必须以大小英文字母或数字开头，最多128个字符。 description 否 String 作业描述，约束：作业描述不能超过256位。 scene_type 是 String 场景类型，DISASTER_BACKUP：同步任务 source_config 否 EventRouterJobSource object 专业版事件流作业源端配置 sink_config 否 EventRouterJobSink object 专业版事件流作业目标端配置 advance_config 否 EventRouterAdvanceConfig object 专业版事件流作业高级配置 表4 EventRouterJobSource 参数 是否必选 参数类型 描述 source_kafka 否 KafkaParameters object kafka配置 source_rocketmq 否 RocketmqParameters object rocketmq配置 source_dcs 否 DcsParameters object dcs配置 表5 EventRouterJobSink 参数 是否必选 参数类型 描述 sink_kafka 否 KafkaParameters object kafka配置 sink_rocketmq 否 RocketmqParameters object rocketmq配置 sink_dcs 否 DcsParameters object dcs配置 表6 KafkaParameters 参数 是否必选 参数类型 描述 config_type 是 String 实例类型 CLOUD：云服务DMS kafka实例 region 是 String 区域ID project_id 是 String 资源空间ID instance_id 否 String kafka实例ID，配置类型选择CLOUD时必填 cluster_alias 是 String kafka集群别名 address 否 String kafka地址 authenticate_mode 否 String kafka认证方式 sasl_mechanism 否 String SASL认证机制 user_name 否 String 用户名，开启SASL_SSL时必填 password 否 String 用户密码，开启SASL_SSL时必填 表7 RocketmqParameters 参数 是否必选 参数类型 描述 config_type 是 String 实例类型。 CLOUD：云服务DMS Rocketmq实例 region 是 String 区域id project_id 是 String 资源空间ID instance_id 否 String rocketmq实例ID，配置类型选择CLOUD时必填 cluster_alias 是 String rocketmq集群别名 address 否 String rocketmq地址 ssl_open 否 String rocketmq SSL开关 true: 开启 false: 关闭 acl_open 否 Boolean rocketmq ACL开关 true: 开启 false: 关闭 user_name 否 String 用户名，开启ACL时必填 password 否 String 用户密码，开启ACL时必填 表8 DcsParameters 参数 是否必选 参数类型 描述 config_type 是 String 实例类型 CLOUD：云服务DCS实例 region 是 String 区域id project_id 是 String 资源空间ID instance_id 否 String dcs实例ID，配置类型选择CLOUD时必填 address 否 String dcs地址 password 否 String 用户密码 表9 EventRouterAdvanceConfig 参数 是否必选 参数类型 描述 kafka2kafka 否 Kafka2KafkaAdvanceConfig object kafka同步自定义配置 rocketmq2rocketmq 否 Rocketmq2RocketmqAdvanceConfig object rocketmq同步自定义配置 dcs2dcs 否 Dcs2DcsAdvanceConfig object dcs同步自定义配置 表10 Kafka2KafkaAdvanceConfig 参数 是否必选 参数类型 描述 topics 否 String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex 否 String 要同步的topic正则表达式，与topics参数二选一 replica_cnt 是 Integer 副本数，不能大于broker数量 seek_to 是 String 数据同步点 compress_alg 是 String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 snappy：snappy压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 is_sync_progress 是 Boolean 是否同步消费进度 true：同步 false：不同步 is_add_header 是 Boolean 是否添加来源Header rename_topic 否 Boolean 是否重命名Topic topic_mappings 否 Array of KafkaTopicMapping objects topic映射 表11 KafkaTopicMapping 参数 是否必选 参数类型 描述 source_topic 否 String 源主题 sink_topic 否 String 目标主题 表12 Rocketmq2RocketmqAdvanceConfig 参数 是否必选 参数类型 描述 topics 否 String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex 否 String 要同步的topic正则表达式，与topics参数二选一 is_sync_progress 是 Boolean 是否同步消费进度 seek_to 是 String 数据同步点 最早（first），最新（last），自定义时间戳（long类型） compress_alg 是 String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 表13 Dcs2DcsAdvanceConfig 参数 是否必选 参数类型 描述 synchronize_type 是 String 同步类型 默认全量加增量 connect_retry_time 是 String 无法连接后重试时间，默认60秒 other_retry_time 是 String 出现其他问题后的重试时间，默认60秒 use_rate_limit 否 Boolean 是否限制增量同步速率，默认5MS/s true：限制 false：不限制 rate_limit 否 String 限制增量同步速率，默认5MB/s use_salve_node 否 Boolean 是否使用Slave节点 true：使用从节点同步数据 false：不使用从节点同步数据，即使用主节点

请求示例 创建名为xxx的专业版事件流作业 POST https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs { "cluster_id": "fac59513-6c18-4266-bc81-5d412dfc1925", "name": "eventRoute-qapbtr95", "scene_type": "DISASTER_BACKUP", "description": "", "source_config": [ { "source_kafka": [ { "config_type": "CLOUD", "region": "roma-dev-1", "project_id": "cb13a5c409fe40599271f44bbea5a2ad", "instance_id": "cdecf0b0-35b8-461b-a430-d7cd02d3d712", "cluster_alias": "aa", "address": "21.22.0.58:9092", "user_name": "", "password": null, "authenticate_mode": "PLAINTEXT", "sasl_mechanism": "" } ], } ], "sink_config": [ { "sink_kafka": [ { "config_type": "CLOUD", "region": "roma-dev-1", "project_id": "cb13a5c409fe40599271f44bbea5a2ad", "instance_id": "47896f0e-f90a-4528-b407-78ee00362cc9", "cluster_alias": "bb", "address": "21.22.0.175:9092", "user_name": null, "password": null, "authenticate_mode": "PLAINTEXT", "sasl_mechanism": "" } ], } ], "advance_config": [ { "kafka2kafka": [ { "topics": "t01", "topic_regex": "", "task_cnt": null, "topic_mappings": [], "rename_topic": false, "is_add_header": false, "is_sync_progress": false, "replica_cnt": 1, "seek_to": "earliest", "compress_alg": "none" } ] } ] }

响应示例 状态码：200 请求成功 { "cluster_id" : "fac59513-6c18-4266-bc81-5d412dfc1925", "job_id" : "fac59513-6c18-4266-bc81-5d412dfc1925", "name" : "eventRoute-ifpcv5u4", "description" : "", "scene_type" : "DISASTER_BACKUP", "source_type" : "KAFKA", "source_config" : null, "sink_type" : "KAFKA", "sink_config" : null, "advance_config" : null, "status" : "CREATING", "err_code" : null, "err_message" : null, "created_time" : "2024-05-16T11:46:07Z", "updated_time" : "2024-05-16T11:46:07Z", "vpc_id" : "199f632d-34e7-4915-b4d8-1bc4e2824867", "subnet_id" : "0d1799e1-116e-4551-92dc-02dd8a860072" }

响应参数 状态码：200 表14 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求ID 表15 响应Body参数 参数 参数类型 描述 cluster_id String 专业版事件流集群ID job_id String 专业版事件流作业ID name String 作业名称。约束：作业名称由大小英文字母、数字、点、中划线和下划线组成，必须以大小英文字母或数字开头，最多128个字符。 description String 作业描述，约束：作业描述不能超过256位。 scene_type String 场景类型 source_type String 源端类型 sink_type String 目标端类型 subnet_id String 子网ID vpc_id String 虚拟私有云ID source_config EventRouterJobSource object 专业版事件流作业源端配置 sink_config EventRouterJobSink object 专业版事件流作业目标端配置 advance_config EventRouterAdvanceConfig object 专业版事件流作业高级配置 status String 作业状态 err_code String 错误码 err_message String 错误原因 created_time String 创建UTC时间 updated_time String 更新UTC时间 sink_status String 目标端连通性状态 sink_status_info String 目标端连通性状态信息 source_status String 源端连通性状态 source_status_info String 源端连通性状态信息 log_group_id String 用户侧保存事件流作业日志的日志组ID log_stream_id String 用户侧保存事件流作业日志的日志流ID 表16 EventRouterJobSource 参数 参数类型 描述 source_kafka KafkaParameters object kafka配置 source_rocketmq RocketmqParameters object rocketmq配置 source_dcs DcsParameters object dcs配置 表17 EventRouterJobSink 参数 参数类型 描述 sink_kafka KafkaParameters object kafka配置 sink_rocketmq RocketmqParameters object rocketmq配置 sink_dcs DcsParameters object dcs配置 表18 KafkaParameters 参数 参数类型 描述 config_type String 实例类型 CLOUD：云服务DMS kafka实例 region String 区域ID project_id String 资源空间ID instance_id String kafka实例ID，配置类型选择CLOUD时必填 cluster_alias String kafka集群别名 address String kafka地址 authenticate_mode String kafka认证方式 sasl_mechanism String SASL认证机制 user_name String 用户名，开启SASL_SSL时必填 password String 用户密码，开启SASL_SSL时必填 表19 RocketmqParameters 参数 参数类型 描述 config_type String 实例类型。 CLOUD：云服务DMS Rocketmq实例 region String 区域id project_id String 资源空间ID instance_id String rocketmq实例ID，配置类型选择CLOUD时必填 cluster_alias String rocketmq集群别名 address String rocketmq地址 ssl_open String rocketmq SSL开关 true: 开启 false: 关闭 acl_open Boolean rocketmq ACL开关 true: 开启 false: 关闭 user_name String 用户名，开启ACL时必填 password String 用户密码，开启ACL时必填 表20 DcsParameters 参数 参数类型 描述 config_type String 实例类型 CLOUD：云服务DCS实例 region String 区域id project_id String 资源空间ID instance_id String dcs实例ID，配置类型选择CLOUD时必填 address String dcs地址 password String 用户密码 表21 EventRouterAdvanceConfig 参数 参数类型 描述 kafka2kafka Kafka2KafkaAdvanceConfig object kafka同步自定义配置 rocketmq2rocketmq Rocketmq2RocketmqAdvanceConfig object rocketmq同步自定义配置 dcs2dcs Dcs2DcsAdvanceConfig object dcs同步自定义配置 表22 Kafka2KafkaAdvanceConfig 参数 参数类型 描述 topics String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex String 要同步的topic正则表达式，与topics参数二选一 replica_cnt Integer 副本数，不能大于broker数量 seek_to String 数据同步点 compress_alg String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 snappy：snappy压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 is_sync_progress Boolean 是否同步消费进度 true：同步 false：不同步 is_add_header Boolean 是否添加来源Header rename_topic Boolean 是否重命名Topic topic_mappings Array of KafkaTopicMapping objects topic映射 表23 KafkaTopicMapping 参数 参数类型 描述 source_topic String 源主题 sink_topic String 目标主题 表24 Rocketmq2RocketmqAdvanceConfig 参数 参数类型 描述 topics String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex String 要同步的topic正则表达式，与topics参数二选一 is_sync_progress Boolean 是否同步消费进度 seek_to String 数据同步点 最早（first），最新（last），自定义时间戳（long类型） compress_alg String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 表25 Dcs2DcsAdvanceConfig 参数 参数类型 描述 synchronize_type String 同步类型 默认全量加增量 connect_retry_time String 无法连接后重试时间，默认60秒 other_retry_time String 出现其他问题后的重试时间，默认60秒 use_rate_limit Boolean 是否限制增量同步速率，默认5MS/s true：限制 false：不限制 rate_limit String 限制增量同步速率，默认5MB/s use_salve_node Boolean 是否使用Slave节点 true：使用从节点同步数据 false：不使用从节点同步数据，即使用主节点

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 cluster_id 是 String 专业版事件流集群ID name 是 String 作业名称。约束：作业名称由大小英文字母、数字、点、中划线和下划线组成，必须以大小英文字母或数字开头，最多128个字符。 description 否 String 作业描述，约束：作业描述不能超过256位。 scene_type 是 String 场景类型，DISASTER_BACKUP：同步任务 source_config 否 EventRouterJobSource object 专业版事件流作业源端配置 sink_config 否 EventRouterJobSink object 专业版事件流作业目标端配置 advance_config 否 EventRouterAdvanceConfig object 专业版事件流作业高级配置 表4 EventRouterJobSource 参数 是否必选 参数类型 描述 source_kafka 否 KafkaParameters object kafka配置 source_rocketmq 否 RocketmqParameters object rocketmq配置 source_dcs 否 DcsParameters object dcs配置 表5 EventRouterJobSink 参数 是否必选 参数类型 描述 sink_kafka 否 KafkaParameters object kafka配置 sink_rocketmq 否 RocketmqParameters object rocketmq配置 sink_dcs 否 DcsParameters object dcs配置 表6 KafkaParameters 参数 是否必选 参数类型 描述 config_type 是 String 实例类型 CLOUD：云服务DMS kafka实例 region 是 String 区域ID project_id 是 String 资源空间ID instance_id 否 String kafka实例ID，配置类型选择CLOUD时必填 cluster_alias 是 String kafka集群别名 address 否 String kafka地址 authenticate_mode 否 String kafka认证方式 sasl_mechanism 否 String SASL认证机制 user_name 否 String 用户名，开启SASL_SSL时必填 password 否 String 用户密码，开启SASL_SSL时必填 表7 RocketmqParameters 参数 是否必选 参数类型 描述 config_type 是 String 实例类型。 CLOUD：云服务DMS Rocketmq实例 region 是 String 区域id project_id 是 String 资源空间ID instance_id 否 String rocketmq实例ID，配置类型选择CLOUD时必填 cluster_alias 是 String rocketmq集群别名 address 否 String rocketmq地址 ssl_open 否 String rocketmq SSL开关 true: 开启 false: 关闭 acl_open 否 Boolean rocketmq ACL开关 true: 开启 false: 关闭 user_name 否 String 用户名，开启ACL时必填 password 否 String 用户密码，开启ACL时必填 表8 DcsParameters 参数 是否必选 参数类型 描述 config_type 是 String 实例类型 CLOUD：云服务DCS实例 region 是 String 区域id project_id 是 String 资源空间ID instance_id 否 String dcs实例ID，配置类型选择CLOUD时必填 address 否 String dcs地址 password 否 String 用户密码 表9 EventRouterAdvanceConfig 参数 是否必选 参数类型 描述 kafka2kafka 否 Kafka2KafkaAdvanceConfig object kafka同步自定义配置 rocketmq2rocketmq 否 Rocketmq2RocketmqAdvanceConfig object rocketmq同步自定义配置 dcs2dcs 否 Dcs2DcsAdvanceConfig object dcs同步自定义配置 表10 Kafka2KafkaAdvanceConfig 参数 是否必选 参数类型 描述 topics 否 String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex 否 String 要同步的topic正则表达式，与topics参数二选一 replica_cnt 是 Integer 副本数，不能大于broker数量 seek_to 是 String 数据同步点 compress_alg 是 String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 snappy：snappy压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 is_sync_progress 是 Boolean 是否同步消费进度 true：同步 false：不同步 is_add_header 是 Boolean 是否添加来源Header rename_topic 否 Boolean 是否重命名Topic topic_mappings 否 Array of KafkaTopicMapping objects topic映射 表11 KafkaTopicMapping 参数 是否必选 参数类型 描述 source_topic 否 String 源主题 sink_topic 否 String 目标主题 表12 Rocketmq2RocketmqAdvanceConfig 参数 是否必选 参数类型 描述 topics 否 String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex 否 String 要同步的topic正则表达式，与topics参数二选一 is_sync_progress 是 Boolean 是否同步消费进度 seek_to 是 String 数据同步点 最早（first），最新（last），自定义时间戳（long类型） compress_alg 是 String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 表13 Dcs2DcsAdvanceConfig 参数 是否必选 参数类型 描述 synchronize_type 是 String 同步类型 默认全量加增量 connect_retry_time 是 String 无法连接后重试时间，默认60秒 other_retry_time 是 String 出现其他问题后的重试时间，默认60秒 use_rate_limit 否 Boolean 是否限制增量同步速率，默认5MS/s true：限制 false：不限制 rate_limit 否 String 限制增量同步速率，默认5MB/s use_salve_node 否 Boolean 是否使用Slave节点 true：使用从节点同步数据 false：不使用从节点同步数据，即使用主节点

请求示例 开启事件流作业日志 https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/{job_id}/log { "enabled" : true, "log_group_id" : "xxxxxxxxxxx", "log_stream_id" : "xxxxxxxxxxx" } 关闭事件流作业日志 https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/{job_id}/log { "enabled" : false, "log_group_id" : "", "log_stream_id" : "" }

响应示例 状态码：200 开启事件流作业日志成功 { "job_id" : "1a84ce5e-d060-1000-0094-xxxxxxxxxxx", "cluster_id" : "1a84cdab-8ae0-1000-0094-xxxxxxxxxxx", "name" : "eventRoute-xxxxxxxxxxx", "description" : "", "scene_type" : "DISASTER_BACKUP", "source_type" : "ROCKETMQ", "source_config" : null, "sink_type" : "ROCKETMQ", "sink_config" : null, "advance_config" : null, "status" : "PAUSED", "updated_time" : "2025-04-12T02:14:02Z", "vpc_id" : "0c4975eb-5575-4be0-b788-xxxxxxxxxxx", "subnet_id" : "33bd70bd-1d62-4438-96c8-xxxxxxxxxxx", "source_status" : "UNDEFINED", "source_status_info" : "", "sink_status" : "UNDEFINED", "sink_status_info" : "", "log_group_id" : "3cfe3347-43b9-4aa4-b62e-xxxxxxxxxxx", "log_stream_id" : "1a5b9d49-3003-49d3-93af-xxxxxxxxxxx" } 状态码：400 开启事件流作业日志失败 { "err_code" : "00513000", "err_detail" : "EventRoute task log is already enabled.", "err_msg" : "invalid parameters" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 cluster_id String 专业版事件流集群ID job_id String 专业版事件流作业ID name String 作业名称。约束：作业名称由大小英文字母、数字、点、中划线和下划线组成，必须以大小英文字母或数字开头，最多128个字符。 description String 作业描述，约束：作业描述不能超过256位。 scene_type String 场景类型 source_type String 源端类型 sink_type String 目标端类型 subnet_id String 子网ID vpc_id String 虚拟私有云ID source_config EventRouterJobSource object 专业版事件流作业源端配置 sink_config EventRouterJobSink object 专业版事件流作业目标端配置 advance_config EventRouterAdvanceConfig object 专业版事件流作业高级配置 status String 作业状态 err_code String 错误码 err_message String 错误原因 created_time String 创建UTC时间 updated_time String 更新UTC时间 sink_status String 目标端连通性状态 sink_status_info String 目标端连通性状态信息 source_status String 源端连通性状态 source_status_info String 源端连通性状态信息 log_group_id String 用户侧保存事件流作业日志的日志组ID log_stream_id String 用户侧保存事件流作业日志的日志流ID 表5 EventRouterJobSource 参数 参数类型 描述 source_kafka KafkaParameters object kafka配置 source_rocketmq RocketmqParameters object rocketmq配置 source_dcs DcsParameters object dcs配置 表6 EventRouterJobSink 参数 参数类型 描述 sink_kafka KafkaParameters object kafka配置 sink_rocketmq RocketmqParameters object rocketmq配置 sink_dcs DcsParameters object dcs配置 表7 KafkaParameters 参数 参数类型 描述 config_type String 实例类型 CLOUD：云服务DMS kafka实例 region String 区域ID project_id String 资源空间ID instance_id String kafka实例ID，配置类型选择CLOUD时必填 cluster_alias String kafka集群别名 address String kafka地址 authenticate_mode String kafka认证方式 sasl_mechanism String SASL认证机制 user_name String 用户名，开启SASL_SSL时必填 password String 用户密码，开启SASL_SSL时必填 表8 RocketmqParameters 参数 参数类型 描述 config_type String 实例类型。 CLOUD：云服务DMS Rocketmq实例 region String 区域id project_id String 资源空间ID instance_id String rocketmq实例ID，配置类型选择CLOUD时必填 cluster_alias String rocketmq集群别名 address String rocketmq地址 ssl_open String rocketmq SSL开关 true: 开启 false: 关闭 acl_open Boolean rocketmq ACL开关 true: 开启 false: 关闭 user_name String 用户名，开启ACL时必填 password String 用户密码，开启ACL时必填 表9 DcsParameters 参数 参数类型 描述 config_type String 实例类型 CLOUD：云服务DCS实例 region String 区域id project_id String 资源空间ID instance_id String dcs实例ID，配置类型选择CLOUD时必填 address String dcs地址 password String 用户密码 表10 EventRouterAdvanceConfig 参数 参数类型 描述 kafka2kafka Kafka2KafkaAdvanceConfig object kafka同步自定义配置 rocketmq2rocketmq Rocketmq2RocketmqAdvanceConfig object rocketmq同步自定义配置 dcs2dcs Dcs2DcsAdvanceConfig object dcs同步自定义配置 表11 Kafka2KafkaAdvanceConfig 参数 参数类型 描述 topics String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex String 要同步的topic正则表达式，与topics参数二选一 replica_cnt Integer 副本数，不能大于broker数量 seek_to String 数据同步点 compress_alg String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 snappy：snappy压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 is_sync_progress Boolean 是否同步消费进度 true：同步 false：不同步 is_add_header Boolean 是否添加来源Header rename_topic Boolean 是否重命名Topic topic_mappings Array of KafkaTopicMapping objects topic映射 表12 KafkaTopicMapping 参数 参数类型 描述 source_topic String 源主题 sink_topic String 目标主题 表13 Rocketmq2RocketmqAdvanceConfig 参数 参数类型 描述 topics String 要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一 topic_regex String 要同步的topic正则表达式，与topics参数二选一 is_sync_progress Boolean 是否同步消费进度 seek_to String 数据同步点 最早（first），最新（last），自定义时间戳（long类型） compress_alg String 压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法 表14 Dcs2DcsAdvanceConfig 参数 参数类型 描述 synchronize_type String 同步类型 默认全量加增量 connect_retry_time String 无法连接后重试时间，默认60秒 other_retry_time String 出现其他问题后的重试时间，默认60秒 use_rate_limit Boolean 是否限制增量同步速率，默认5MS/s true：限制 false：不限制 rate_limit String 限制增量同步速率，默认5MB/s use_salve_node Boolean 是否使用Slave节点 true：使用从节点同步数据 false：不使用从节点同步数据，即使用主节点 状态码：400 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_detail String 错误详情 error_msg String 错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 enable 是 Boolean 开启或者关闭事件流作业日志 true: 开启 false: 关闭 log_group_id 否 String 用户侧日志组ID，开启日志时不填此参数则由EG云服务创建自定义日志组 log_stream_id 否 String 用户侧日志流ID，开启日志时不填此参数则由EG云服务创建自定义日志流

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": $ADMIN_PASS, //IAM用户密码，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFG....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

镜像标签 权限 对应API接口 授权项（Action） 依赖的授权项 IAM项目（Project） 企业项目（Enterprise Project） 增加标签（OpenStack原生） PUT /v2/images/{image_id}/tags/{tag} ims:images:get ims:images:update - √ x 删除标签（OpenStack原生） DELETE /v2/images/{image_id}/tags/{tag} ims:images:get ims:images:update - √ x 增加或修改标签 PUT /v1/cloudimages/tags ims:images:get ims:images:update - √ x 查询租户镜像标签列表 GET /v1/cloudimages/tags ims:images:list - √ x 按标签查询镜像 POST /v2/{project_id}/images/resource_instances/action ims:images:list - √ x 批量删除镜像标签 DELETE /v1/{project_id}/cloudimages/{image_id}/tags/delete ims:images:update - √ x 批量添加删除镜像标签 POST /v2/{project_id}/images/{image_id}/tags/action ims:images:update - √ x 添加镜像标签 POST /v2/{project_id}/images/{image_id}/tags ims:images:update - √ x 删除镜像标签 DELETE /v2/{project_id}/images/{image_id}/tags/{key} ims:images:update - √ x 查询镜像标签 GET /v2/{project_id}/images/{image_id}/tags ims:images:list - √ x 查询租户所有镜像标签 GET /v2/{project_id}/images/tags ims:images:list - √ x 父主题： 权限和授权项

镜像共享 权限 对应API接口 授权项（Action） 依赖的授权项 IAM项目（Project） 企业项目（Enterprise Project） 获取镜像成员详情 GET /v1/{project_id}/cloudimages/{image_id}/members/{member_id} ims:images:get - √ x 获取镜像成员列表 GET /v1/{project_id}/cloudimages/{image_id}/members ims:images:get - √ x 添加镜像成员（OpenStack原生） POST /v2/images/{image_id}/members ims:images:get ims:images:share - √ x 更新镜像成员状态（OpenStack原生） PUT /v2/images/{image_id}/members/{member_id} ims:images:get ims:images:share - √ x 获取镜像成员详情（OpenStack原生） GET /v2/images/{image_id}/members/{member_id} ims:images:get ims:images:share - √ x 获取镜像成员列表（OpenStack原生） GET /v2/images/{image_id}/members ims:images:get ims:images:share - √ x 删除指定的镜像成员（OpenStack原生） DELETE /v2/images/{image_id}/members/{member_id} ims:images:get ims:images:share - √ x 批量添加镜像成员 POST /v1/cloudimages/members ims:images:share - √ x 批量更新镜像成员状态 PUT /v1/cloudimages/members ims:images:share - √ x 批量删除镜像成员 DELETE /v1/cloudimages/members ims:images:share - √ x 父主题： 权限和授权项

约束与限制 Agent插件目前仅支持64位Linux操作系统的裸金属服务器。 裸金属服务器必须配置委托，详情请参见如何配置委托？。 可选区域包括：华北-北京一（cn-north-1）、华南-广州（cn-south-1）、中国-香港（ap-southeast-1）。 用户私有镜像不在支持范围内。 主机监控对Linux镜像支持列表如表1所示。 表1 主机监控对Linux镜像支持列表 操作系统类型（64bit） 支持版本号 SUSE Enterprise11 SP4，Enterprise12 SP1 CentOS 6.9，7.2，7.3，7.4 EulerOS 2.2 Debian 8.6

恢复数据 如果遇到外部病毒入侵、人为误操作、业务软件Bug等故障场景，您需要执行备份恢复操作，将裸金属服务器的配置及云硬盘数据恢复到历史时间点，最大程度降低损失。 在云服务器备份页面，选择备份列表中某个时间点的备份，单击操作列的“恢复”。 弹出“恢复服务器”页面： 勾选“恢复后立即启动服务器”。 如果取消勾选“恢复后立即启动服务器”，则恢复服务器操作执行完成后，需要手动启动服务器。 恢复服务器的过程中会关闭服务器，请在业务空闲时操作。 在指定的磁盘下拉菜单中选择备份需要恢复到的磁盘。 如果服务器只有一个磁盘，则默认恢复到该磁盘。 如果服务器存在多个磁盘，默认将备份恢复到原来的磁盘，也可以在“指定的磁盘”下拉菜单中重新选择磁盘将备份恢复到备份服务器中的其他磁盘中。但是指定的磁盘容量不能小于之前的磁盘容量。 备份的数据盘的数据，不能恢复到系统盘中。 单击“确定”，并确认备份恢复是否成功。 您可以在备份列表中，查看备份恢复的执行状态，直到备份的“备份状态”恢复为“可用”。然后验证您的业务是否已经恢复。

手动备份 如果想在任意时间点即时备份，可以手动创建裸金属服务器备份。 在云服务器备份页面，单击右上角的“创建云服务器备份”。 在服务器列表中选择一台裸金属服务器，并勾选需要备份的磁盘。 考虑到恢复后数据的一致性问题，我们推荐您对整个服务器进行备份。 若您希望选择部分磁盘备份以节省成本，请尽量确保这些磁盘的数据不受其他未备份磁盘的数据影响，否则可能会导致数据不一致问题。 例如，Oracle应用的数据分散在不同磁盘上，如果只备份了部分磁盘，会导致恢复后数据不一致（已备份磁盘恢复到历史时间点数据，未备份磁盘仍保留当前数据），甚至导致应用无法启动。 勾选“立即备份”，输入名称和描述，启动全量备份。 当前服务器已绑定自动备份策略，如果想替换原有策略，请勾选“自动备份”，并且在下拉列表中重新选择一条策略，绑定操作会使服务器从原策略解绑并绑定到所选策略。 设置完成后，单击“立即申请”，在“资源详情”页面确认规格后，单击“提交申请”。 在“备份”页签，产生的备份的“备份状态”为“可用”时，表示一次性手动备份任务执行成功。

购买裸金属服务器 在左侧导航中选择“裸金属服务器”，单击右上角的“购买裸金属服务器”。 配置裸金属服务器的规格参数。 规格：选择裸金属服务器规格，如physical.s4.xlarge。 磁盘：设置系统盘参数，并新增一块数据盘。 备份：勾选“启用自动备份”，在下拉列表中选择创建备份策略中创建的备份策略。 设置完成后，单击“立即购买”创建裸金属服务器。 等待5分钟左右，裸金属服务器即可创建完成，状态变为“运行中”。 远程登录或使用密钥对登录裸金属服务器，完成数据盘初始化，并开始部署您的应用软件。 父主题： 备份

方案介绍 当我们部署在裸金属服务器上的系统出现外部病毒入侵、人为误操作、业务软件Bug等故障场景时，可以通过云服务器备份服务（Cloud Server Backup Service，CSBS）为裸金属服务器创建定期自动备份（备份周期最小为1小时）。当上述故障发生时，可通过备份进行快速恢复，避免数据丢失。 CSBS将裸金属服务器的配置和所包含的多个云硬盘数据备份到高可靠性等级的 对象存储服务 （Object Storage Service，OBS）中，保障用户的备份数据安全。 图1 备份及恢复示意图

前提条件 创建密钥对 为安全起见，裸金属服务器登录时建议使用密钥方式进行身份验证。因此，您需要使用已有密钥对或新建一个密钥对，用于远程登录身份验证。 参考创建密钥对中的指导完成操作。若您已有密钥对，可跳过此步骤，无需多次创建。 创建虚拟私有云 裸金属服务器使用虚拟私有云（Virtual Private Cloud，VPC）提供的网络，包括子网、安全组等。 参考创建虚拟私有云和子网中的指导完成操作。

流程说明 备份裸金属服务器，您需要完成以下步骤： 创建备份策略：通过设定备份时间、备份周期、保留规则等配置项，对裸金属服务器自动进行数据备份。 购买并配置裸金属服务器：购买一台快速发放裸金属服务器，并为其绑定备份策略；完成云硬盘初始化，根据实际需求部署应用软件。 创建裸金属服务器备份：通过设定的备份策略，裸金属服务器会在固定时间点进行自动备份；如果想在任意时间点即时备份，可以手动创建裸金属服务器备份。 查看备份、恢复数据：在控制台界面查看创建成功的自动或手动备份；根据需要恢复数据到历史时间点。

安装配置成功Agent后，为什么控制台没有监控数据或者显示数据滞后？ 安装配置Agent成功，需要等待2分钟，控制台上才会有主机监控数据。如果过了5min在总览页面还未看到“裸金属服务器”，则需要排查裸金属服务器时间和控制台所在客户端时间是否一致。 Agent上报数据取的是BMS实例中的本地时间，控制台下发的请求时间范围是依赖用户客户端浏览器的时间，两者如果不匹配则可能导致控制台查不到监控数据。 登录裸金属服务器，执行service telescoped status命令查看Agent运行状态，当系统返回以下内容，则表示Agent为正常运行状态。 Telescope process is running well. 如果还是看不到监控数据，请参考“手动配置Agent（Linux）”检查配置是否正确。 父主题： 常见问题

功能说明 本节内容介绍裸金属服务器支持上报 云监控 的操作系统监控指标。以下区域主机监控Agent采用最新版本的Agent，监控指标更为简洁。 当前支持的区域： “华东-上海一”、“华东-上海二”、“华北-北京一”、“华北-北京四”、“华南-广州”、“华南-深圳”、“西南-贵阳一”、“中国-香港”、“亚太-曼谷”、“亚太-新加坡”、“非洲-约翰内斯堡”。 安装Agent后，您便可以查看裸金属服务器的操作系统监控指标。指标采集周期是1分钟。

监控指标 裸金属服务器（操作系统监控）支持的监控指标如表1所示。 表1 监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） cpu_usage （Agent）CPU使用率 该指标用于统计测量对象当前CPU使用率。 通过计算采集周期内“/proc/stat”中的变化得出用户空间CPU使用率。 用户可以通过top命令查看“%Cpu(s)”值。 单位：百分比 0-100% 裸金属服务器 1分钟 load_average5 （Agent）5分钟平均负载 该指标用于统计测量对象在过去5分钟的CPU平均负载。 通过“/proc/loadavg”文件中load5/逻辑CPU个数得到。 用户可以通过top命令查看“load5”值。 ≥ 0 裸金属服务器 1分钟 mem_usedPercent （Agent）内存使用率 该指标用于统计测量对象的内存使用率。 通过“/proc/meminfo”文件获取。计算公式：(MemTotal-MemAvailable)/MemTotal。 单位：百分比 0-100% 裸金属服务器 1分钟 mountPointPrefix_disk_free （Agent）磁盘剩余存储量 该指标用于统计测量对象磁盘的剩余存储空间。 执行df -h命令，查看Avail列数据。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：GB ≥ 0 GB 裸金属服务器 1分钟 mountPointPrefix_disk_usedPercent （Agent）磁盘使用率 该指标用于统计测量对象磁盘使用率，以百分比为单位。计算方式为：磁盘已用存储量/磁盘存储总量。 通过计算Used/Size得出。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：百分比 0-100% 裸金属服务器 1分钟 mountPointPrefix_disk_ioUtils 和volumePrefix_disk_ioUtils （Agent）磁盘I/O使用率 该指标用于统计测量对象磁盘I/O使用率。 通过计算采集周期内/proc/diskstats中对应设备第十三列数据的变化得出磁盘I/O使用率。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：百分比 0-100% 裸金属服务器 1分钟 mountPointPrefix_disk_inodesUsedPercent （Agent）inode已使用占比 该指标用于统计测量对象当前磁盘已使用的inode占比。 执行df -i命令，查看IUse%列数据。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：百分比 0-100% 裸金属服务器 1分钟 net_bitRecv （Agent）入网带宽 该指标用于统计测量对象网卡每秒接收的比特数。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：bit/s ≥ 0 bit/s 裸金属服务器 1分钟 net_bitSent （Agent）出网带宽 该指标用于统计测量对象网卡每秒发送的比特数。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：bit/s ≥ 0 bit/s 裸金属服务器 1分钟 net_packetRecv （Agent）网卡包接收速率 该指标用于统计测量对象网卡每秒接收的数据包数。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：Counts/s ≥ 0 Counts/s 裸金属服务器 1分钟 net_packetSent （Agent）网卡包发送速率 该指标用于统计测量对象网卡每秒发送的数据包数。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：Counts/s ≥ 0 Counts/s 裸金属服务器 1分钟 net_tcp_total （Agent）所有状态的TCP连接数总和 该指标用于统计测量对象网卡所有状态的TCP连接数总和。 ≥0 裸金属服务器 1分钟 net_tcp_established （Agent）处于ESTABLISHED状态的TCP连接数量 该指标用于统计测量对象网卡处于ESTABLISHED状态的TCP连接数量。 ≥0 裸金属服务器 1分钟

监控指标 裸金属服务器（操作系统监控）支持的监控指标有：CPU相关监控指标（表1）、CPU负载类相关监控指标（表2）、内存相关监控指标（表3）、磁盘相关监控指标（表4）、磁盘I/O类（表5）、文件系统类（表6）、网卡类（表7）、软RAID相关监控指标（表8）和进程相关监控指标（表9）。 如果要监控软RAID相关指标，Agent版本必须为1.0.5及以上。 Windows系统的裸金属服务器暂不支持监控。 表1 CPU相关监控指标说明 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） cpu_usage_idle （Agent）CPU空闲时间占比 该指标用于统计测量对象当前CPU空闲时间占比。 通过计算采集周期内“/proc/stat”文件中的变化得出CPU空闲时间占比。 用户可以通过top命令查看“%Cpu(s) id”值。 单位：百分比 0-100% 裸金属服务器 1分钟 cpu_usage_other （Agent）其他CPU使用率 该指标用于统计测量对象其他占用CPU使用率。 计算公式： 1 - 空闲CPU使用率（%） - 内核空间CPU使用率 - 用户空间CPU使用率。 单位：百分比 0-100% 裸金属服务器 1分钟 cpu_usage_system （Agent）内核空间CPU使用率 该指标用于统计测量对象当前内核空间占用CPU使用率。 通过计算采集周期内“/proc/stat”文件中的变化得出内核空间CPU使用率。 用户可以通过top命令查看“%Cpu(s) sy”值。 单位：百分比 0-100% 裸金属服务器 1分钟 cpu_usage_user （Agent）用户空间CPU使用率 该指标用于统计测量对象当前用户空间占用CPU使用率。 通过计算采集周期内“/proc/stat”中的变化得出用户空间CPU使用率。 用户可以通过top命令查看“%Cpu(s) us”值。 单位：百分比 0-100% 裸金属服务器 1分钟 cpu_usage （Agent）CPU使用率 该指标用于统计测量对象当前CPU使用率。 通过计算采集周期内“/proc/stat”中的变化得出用户空间CPU使用率。 用户可以通过top命令查看“%Cpu(s)”值。 单位：百分比 0-100% 裸金属服务器 1分钟 cpu_usage_nice （Agent）Nice进程CPU使用率 该指标用于统计测量对象当前Nice进程CPU使用率。 通过计算采集周期内/proc/stat中的变化得出Nice进程CPU使用率。用户可以通过top命令查看 %Cpu(s) ni值。 单位：百分比 0-100% 裸金属服务器 1分钟 cpu_usage_iowait （Agent）iowait状态占比 该指标用于统计测量对象当前iowait状态占用CPU的比率。 通过计算采集周期内/proc/stat中的变化得出iowait状态占比。 用户可以通过top命令查看 %Cpu(s) wa值。 单位：百分比 0-100% 裸金属服务器 1分钟 cpu_usage_irq （Agent）CPU中断时间占比 该指标用于统计测量对象当前CPU处理中断用时占用CPU时间的比率，以百分比为单位。 通过计算采集周期内/proc/stat中的变化得出CPU中断时间占比。 用户可以通过top命令查看 %Cpu(s) hi值。 单位：百分比 0-100% 裸金属服务器 1分钟 cpu_usage_softirq （Agent）CPU软中断时间占比 该指标用于统计测量对象当前CPU处理软中断时间占用CPU时间的比率。 通过计算采集周期内/proc/stat中的变化得出CPU软中断时间占比。 用户可以通过top命令查看 %Cpu(s) si值。 单位：百分比 0-100% 裸金属服务器 1分钟 表2 CPU负载指标说明 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） load_average1 （Agent）1分钟平均负载 该指标用于统计测量对象在过去1分钟的CPU平均负载。 通过“/proc/loadavg”文件中load1/逻辑CPU个数得到。 用户可以通过top命令查看“load1”值。 ≥ 0 裸金属服务器 1分钟 load_average5 （Agent）5分钟平均负载 该指标用于统计测量对象在过去5分钟的CPU平均负载。 通过“/proc/loadavg”文件中load5/逻辑CPU个数得到。 用户可以通过top命令查看“load5”值。 ≥ 0 裸金属服务器 1分钟 load_average15 （Agent）15分钟平均负载 该指标用于统计测量对象在过去15分钟的CPU平均负载。 通过“/proc/loadavg”中load15/逻辑CPU个数得到。 用户可以通过top命令查看“load15”值。 ≥ 0 裸金属服务器 1分钟 表3 内存相关监控指标说明 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） mem_available （Agent）可用内存 该指标用于统计测量对象的可用内存。 通过“/proc/meminfo”文件得到MemAvailable。若“/proc/meminfo”中不显示MemAvailable，则MemAvailable=MemFree+Buffers+Cached。 单位：GB ≥ 0 GB 裸金属服务器 1分钟 mem_usedPercent （Agent）内存使用率 该指标用于统计测量对象的内存使用率。 通过“/proc/meminfo”文件获取。计算公式：(MemTotal-MemAvailable)/MemTotal。 单位：百分比 0-100% 裸金属服务器 1分钟 mem_free （Agent）空闲内存量 该指标用于统计测量对象的空闲内存量。 通过/proc/meminfo获取。 单位：GB ≥ 0 GB 裸金属服务器 1分钟 mem_buffers （Agent）Buffers占用量 该指标用于统计测量对象的Buffers内存量。 通过/proc/meminfo获取。 用户可以通过top命令查看 KiB Mem:buffers值。 单位：GB ≥ 0 GB 裸金属服务器 1分钟 mem_cached （Agent）Cache占用量 该指标用于统计测量对象Cache内存量。 通过/proc/meminfo获取。 用户可以通过top命令查看 KiB Swap:cached Mem值。 单位：GB ≥ 0 GB 裸金属服务器 1分钟 表4 磁盘相关监控指标说明 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） mountPointPrefix_disk_free （Agent）磁盘剩余存储量 该指标用于统计测量对象磁盘的剩余存储空间。 执行df -h命令，查看Avail列数据。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：GB ≥ 0 GB 裸金属服务器 1分钟 mountPointPrefix_disk_total （Agent）磁盘存储总量 该指标用于统计测量对象磁盘存储总量。 执行df -h命令，查看Size列数据。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：GB ≥ 0 GB 裸金属服务器 1分钟 mountPointPrefix_disk_used （Agent）磁盘已用存储量 该指标用于统计测量对象磁盘的已用存储空间。 执行df -h命令，查看Used列数据。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：GB ≥ 0 GB 裸金属服务器 1分钟 mountPointPrefix_disk_usedPercent （Agent）磁盘使用率 该指标用于统计测量对象磁盘使用率，以百分比为单位。计算方式为：磁盘已用存储量/磁盘存储总量。 通过计算Used/Size得出。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：百分比 0-100% 裸金属服务器 1分钟 表5 磁盘I/O相关监控指标说明 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） mountPointPrefix_disk_agt_read_bytes_rate （Agent）磁盘读速率 该指标用于统计每秒从测量对象磁盘读出的数据量。 通过计算采集周期内“/proc/diskstats”文件中对应设备第六列数据的变化得出磁盘读速率。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：byte/s ≥ 0 byte/s 裸金属服务器 1分钟 mountPointPrefix_disk_agt_read_requests_rate （Agent）磁盘读操作速率 该指标用于统计每秒从测量对象磁盘读取数据的请求次数。 通过计算采集周期内“/proc/diskstats”文件中对应设备第四列数据的变化得出磁盘读操作速率。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：请求/秒 ≥ 0 请求/秒 裸金属服务器 1分钟 mountPointPrefix_disk_agt_write_bytes_rate （Agent）磁盘写速率 该指标用于统计每秒写到测量对象磁盘的数据量。 通过计算采集周期内“/proc/diskstats”文件中对应设备第十列数据的变化得出磁盘写速率。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：byte/s ≥ 0 byte/s 裸金属服务器 1分钟 mountPointPrefix_disk_agt_write_requests_rate （Agent）磁盘写操作速率 该指标用于统计每秒向测量对象磁盘写数据的请求次数。 通过计算采集周期内“/proc/diskstats”文件中对应设备第八列数据的变化得出磁盘写操作速率。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：请求/秒 ≥ 0 请求/秒 裸金属服务器 1分钟 disk_readTime （Agent）读操作平均耗时 该指标用于统计测量对象磁盘读操作平均耗时。 通过计算采集周期内/proc/diskstats中对应设备第七列数据的变化得出磁盘读操作平均耗时。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：ms/Count ≥ 0 ms/Count 裸金属服务器 1分钟 disk_writeTime （Agent）写操作平均耗时 该指标用于统计测量对象磁盘写操作平均耗时。 通过计算采集周期内/proc/diskstats中对应设备第十一列数据的变化得出磁盘写操作平均耗时。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：ms/Count ≥ 0 ms/Count 裸金属服务器 1分钟 disk_ioUtils （Agent）磁盘I/O使用率 该指标用于统计测量对象磁盘I/O使用率。 通过计算采集周期内/proc/diskstats中对应设备第十三列数据的变化得出磁盘I/O使用率。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：百分比 0-100% 裸金属服务器 1分钟 disk_queue_length （Agent）平均队列长度 该指标用于统计指定时间段内，平均等待完成的读取或写入操作请求的数量。 通过计算采集周期内/proc/diskstats中对应设备第十四列数据的变化得出磁盘平均队列长度。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：个 ≥ 0 个 裸金属服务器 1分钟 disk_write_bytes_per_operation （Agent）平均写操作大小 该指标用于统计指定时间段内，平均每个写I/O操作传输的字节数。 通过计算采集周期内/proc/diskstats中对应设备第十列数据的变化与第八列数据的变化相除得出磁盘平均写操作大小。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：KB/op ≥ 0 KB/op 裸金属服务器 1分钟 disk_read_bytes_per_operation （Agent）平均读操作大小 该指标用于统计指定时间段内，平均每个读I/O操作传输的字节数。 通过计算采集周期内/proc/diskstats中对应设备第六列数据的变化与第四列数据的变化相除得出磁盘平均读操作大小。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：KB/op ≥ 0 KB/op 裸金属服务器 1分钟 disk_io_svctm （Agent）平均I/O服务时长 该指标用于统计指定时间段内，平均每个读或写I/O的操作时长。 通过计算采集周期内/proc/diskstats中对应设备第十三列数据的变化与第四列数据与第八列数据和的变化相除得出磁盘平均I/O时长。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：ms/op ≥ 0 ms/op 裸金属服务器 1分钟 表6 文件系统类监控指标说明 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） disk_fs_rwstate （Agent）文件系统读写状态 该指标用于统计测量对象挂载文件系统的读写状态。状态分为：可读写（0）/只读（1）。 通过读取/proc/mounts中第四列文件系统挂载参数获得。 0，1 裸金属服务器 1分钟 disk_inodesTotal （Agent）inode空间大小 该指标用于统计测量对象当前磁盘的inode空间量。执行df -i命令，查看Inodes列数据。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 ≥ 0 裸金属服务器 1分钟 disk_inodesUsed （Agent）inode已使用空间 该指标用于统计测量对象当前磁盘已使用的inode空间量。 执行df -i命令，查看IUsed列数据。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 ≥ 0 裸金属服务器 1分钟 disk_inodesUsedPercent （Agent）inode已使用占比 该指标用于统计测量对象当前磁盘已使用的inode占比。 执行df -i命令，查看IUse%列数据。 挂载点前缀路径长度不能超过64个字符，必须以字母开头，只能包含0-9/a-z/A-Z/-/./~。 单位：百分比 0-100% 裸金属服务器 1分钟 表7 网卡相关监控指标说明 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） net_bitRecv （Agent）入网带宽 该指标用于统计测量对象网卡每秒接收的比特数。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：bit/s ≥ 0 bit/s 裸金属服务器 1分钟 net_bitSent （Agent）出网带宽 该指标用于统计测量对象网卡每秒发送的比特数。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：bit/s ≥ 0 bit/s 裸金属服务器 1分钟 net_packetRecv （Agent）网卡包接收速率 该指标用于统计测量对象网卡每秒接收的数据包数。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：Counts/s ≥ 0 Counts/s 裸金属服务器 1分钟 net_packetSent （Agent）网卡包发送速率 该指标用于统计测量对象网卡每秒发送的数据包数。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：Counts/s ≥ 0 Counts/s 裸金属服务器 1分钟 net_errin （Agent）接收误包率 该指标用于统计测量对象网卡每秒接收的错误数据包数量占所接收的数据包的比率。 单位：百分比 0-100% 裸金属服务器 1分钟 net_errout （Agent）发送误包率 该指标用于统计测量对象网卡每秒发送的错误数据包数量占所发送的数据包的比率。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：百分比 0-100% 裸金属服务器 1分钟 net_dropin （Agent）接收丢包率 该指标用于统计测量对象网卡每秒接收并已丢弃的数据包数量占所接收的数据包的比率。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：百分比 0-100% 裸金属服务器 1分钟 net_dropout （Agent）发送丢包率 该指标用于统计测量对象网卡每秒发送并已丢弃的数据包数量占所发送的数据包的比率。 通过计算采集周期内“/proc/net/dev”文件中的变化得出。 单位：百分比 0-100% 裸金属服务器 1分钟 表8 软RAID相关监控指标说明 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） md1_status_device:1 （Agent）软RAID状态 该指标用于统计测量对象软RAID设备的状态，RAID异常情况下值为0。 通过采集周期内执行插件脚本“/usr/local/telescope/plugins/raid-monitor.sh”，脚本中计算“/proc/mdstat”文件中的变化并执行mdadm -D /dev/md0（RAID名称）得出。 0，1 裸金属服务器 1分钟 md1_active_device:2 （Agent）软RAID活跃设备数 该指标用于统计测量对象软RAID设备的活跃盘数，RAID异常情况下值为-1。 通过采集周期内执行插件脚本“/usr/local/telescope/plugins/raid-monitor.sh”，脚本中计算“/proc/mdstat”文件中的变化并执行mdadm -D /dev/md0（RAID名称）得出。 ≥0，-1 裸金属服务器 1分钟 md1_working_device:2 （Agent）软RAID工作设备数 该指标用于统计测量对象软RAID设备的工作设备数，RAID异常情况下值为-1。 通过采集周期内执行插件脚本“/usr/local/telescope/plugins/raid-monitor.sh”，脚本中计算“/proc/mdstat”文件中的变化并执行mdadm -D /dev/md0（RAID名称）得出。 ≥0，-1 裸金属服务器 1分钟 md1_failed_device:0 （Agent）软RAID失败设备数 该指标用于统计测量对象软RAID设备的失败设备数，RAID异常情况下值为-1。 通过采集周期内执行插件脚本“/usr/local/telescope/plugins/raid-monitor.sh”，脚本中计算“/proc/mdstat”文件中的变化并执行mdadm -D /dev/md0（RAID名称）得出。 ≥0，-1 裸金属服务器 1分钟 md1_spare_device:0 （Agent）软RAID备用设备数 该指标用于统计测量对象软RAID设备的备用设备数，RAID异常情况下值为-1。 通过采集周期内执行插件脚本“/usr/local/telescope/plugins/raid-monitor.sh”，脚本中计算“/proc/mdstat”文件中的变化并执行mdadm -D /dev/md0（RAID名称）得出。 ≥0，-1 裸金属服务器 1分钟 表9 进程相关监控指标说明 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） proc_pHashId_cpu 进程CPU使用率 进程消耗的CPU百分比，pHashId是（进程名+进程ID）的md5值。 通过计算/proc/pid/stat的变化得出。 单位：百分比 0-100% 裸金属服务器 1分钟 proc_pHashId_mem 进程内存使用率 进程消耗的内存百分比，pHashId是（进程名+进程ID）的md5值。 计算方式：RSS*PAGESIZE/MemTotal RSS：通过获取/proc/pid/statm第二列得到 PAGESIZE：通过命令getconf PAGESIZE获取 MemTotal：通过/proc/meminfo获取 单位：百分比 0-100% 裸金属服务器 1分钟 proc_pHashId_file 进程打开文件数 进程打开文件数，pHashId是（进程名+进程ID）的md5值。 通过执行ls -l /proc/pid/fd可以查看数量。 ≥0 裸金属服务器 1分钟 proc_running_count （Agent）运行中进程数 该指标用于统计测量对象处于运行状态的进程数。 通过统计/proc/pid/status中Status值获取每个进程的状态，进而统计各个状态进程总数。 ≥0 裸金属服务器 1分钟 proc_idle_count （Agent）空闲进程数 该指标用于统计测量对象处于空闲状态的进程数。 通过统计/proc/pid/status中Status值获取每个进程的状态，进而统计各个状态进程总数。 ≥0 裸金属服务器 1分钟 proc_zombie_count （Agent）僵死进程数 该指标用于统计测量对象处于僵死状态的进程数。 通过统计/proc/pid/status中Status值获取每个进程的状态，进而统计各个状态进程总数。 ≥0 裸金属服务器 1分钟 proc_blocked_count （Agent）阻塞进程数 该指标用于统计测量对象被阻塞的进程数。 通过统计/proc/pid/status中Status值获取每个进程的状态，进而统计各个状态进程总数。 ≥0 裸金属服务器 1分钟 proc_sleeping_count （Agent）睡眠进程数 该指标用于统计测量对象处于睡眠状态的进程数。 通过统计/proc/pid/status中Status值获取每个进程的状态，进而统计各个状态进程总数。 ≥0 裸金属服务器 1分钟 proc_total_count （Agent）系统进程数 该指标用于统计测量对象的总进程数。 通过统计/proc/pid/status中Status值获取每个进程的状态，进而统计各个状态进程总数。 ≥0 裸金属服务器 1分钟

功能说明 本节定义了裸金属服务器上报 云监控服务 的监控指标的命名空间，监控指标列表和维度定义，用户可以通过云监控服务控制台或API接口来检索裸金属服务器产生的监控指标和告警信息。 安装Agent后，您便可以查看裸金属服务器的操作系统监控指标。指标采集周期是1分钟。 “华东-上海一”、“华东-上海二”、“华北-北京一”、“华北-北京四”、“华南-广州”、“华南-深圳”、“西南-贵阳一”、“中国-香港”、“亚太-曼谷”、“亚太-新加坡”、“非洲-约翰内斯堡”区域主机监控Agent采用最新版本的Agent，监控指标更为简洁，详情请参见支持的监控指标（安装Agent，简洁版）。