华为云用户手册

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 DSC.00000001 The project ID is not in the trust list Project ID不在白名单列表中! 请重试或联系技术支持。 400 DSC.00000002 Internal service error 内部错误! 请重试或联系技术支持。 400 DSC.00000003 Failed to read the upload file 读取文件错误! 请检查文件类型和大小。 400 DSC.00000004 Invalid parameter 参数错误! 请传递正确的参数。 400 DSC.00000005 Invalid project id Project ID长度错误! 请重试或联系技术支持。 400 DSC.00000006 File size exceeds maximum limit 上传文件超过最大限制! 请检查文件的大小。 400 DSC.00000007 File format error 文件格式错误! 请检查文件的格式。 400 DSC.00000008 Upload file is empty 上传文件为空! 请检查文件内容是否为空。 400 DSC.00000009 There are many tasks at present. Please try again later 当前任务较多，请稍后再试！ 请重试或联系技术支持。 400 DSC.00000010 Image watermark file is empty 文档图形水印文件为空! 请添加图形文件。 400 DSC.00000011 Image watermark file exceeds maximum limit 文档图形水印文件超过最大限制! 请限制图形文件大小。 400 DSC.00000012 Invalid project image watermark file type 文档图形水印类型错误! 请上传.png或.jpg格式的文件。 400 DSC.00000013 Invalid Auth 认证失败! 请使用有效token。 400 DSC.00000014 Order DSC prossional version 请订购DSC专业版本! 请订购DSC专业版本。 400 mask.20000001 Unknown error 未知错误! 请重试或联系技术支持。 400 mask.20000002 Internal service error 内部错误! 请重试或联系技术支持。 400 mask.20000003 Invalid parameter 参数错误！ 请传递正确的参数 400 mask.20000004 Mask data failed 数据脱敏失败! 请传递正确的参数 400 watermark.10000001 Unknown error 未知错误！ 请重试或联系技术支持。 400 watermark.10000002 Internal service error 内部错误！ 请重试或联系技术支持。 400 watermark.10000003 Failed to read the upload file 读取文件错误！ 请检查文件类型和大小 400 watermark.10000004 Invalid parameter 参数错误！ 请传递正确的参数 400 watermark.10000005 Watermark not found 该文件的水印未找到！ 请检查该文件是否加过水印。 400 watermark.10000006 File size exceeds maximum limit 上传文件超过最大限制！ 请检查文件的大小。 400 watermark.10000007 File format error 文件格式错误！ 请检查文件的格式。 400 watermark.10000008 Upload file is empty 上传文件为空！ 请检查文件内容是否为空。 400 watermark.10000009 Wrong password 密码错误！ 请检查文件的密码是否正确。 400 watermark.10000010 The ".doc" format file does not support the watermark feature currently .doc格式文件暂不支持水印功能！ 请检查文件的格式。 400 watermark.10000011 The ".xls" format file does not support the visible watermark feature currently .xls格式文件暂不支持明水印功能！ 请检查文件的格式。 400 watermark.10000012 The ".ppt" format file does not support the visible watermark feature currently .ppt格式文件暂不支持明水印功能！ 请检查文件的格式。 400 watermark.10000013 No watermark specified 没有指定水印内容！ 请检查水印参数是否传递。 400 watermark.10000014 There are many tasks at present. Please try again later 当前任务较多，请稍后再试！ 请重试或联系技术支持。 400 watermark.10000015 Blind watermark already exists 盲水印已经存在！ 请检查文件是否已存在盲水印。 400 watermark.10000016 There is not enough channel capacity to embed the watermark 文件解压后超过最大限制！ 请检查文件大小。 400 watermark.10000017 Image channel capacity is too small to embed watermark 图像信道容量过小，不能嵌入水印! 请重试或联系技术支持。 400 watermark.10000018 Currently does not support embedding watermark to image below 512 pixels 当前不支持给低于512像素的图片添加水印！ 请输入大于512像素的图片，或联系技术支持。 父主题： 附录

请求样例 { "mask_strategies": [ { "name": "col1", "algorithm": "KEYWORD", "parameters": { "key": "关键字", "target": "目标字符串" } } ], "data": [ { "col1": "关键字" } ]}

请求样例 { "mask_strategies": [ { "name": "col1", "algorithm": "MASKXY", "parameters": { "type": "CHAR", "x": 1, "y": 1, "method": "*" } } ], "data": [ { "col1": "test" } ]}或：{ "mask_strategies": [ { "name": "col1", "algorithm": "MASKXY", "parameters": { "type": "RAND", "x": 1, "y": 1, "method": "CHAR" } } ], "data": [ { "col1": "test" } ]}

请求参数 表1 请求参数 参数 是否必选 参数类型 描述 algorithm 是 String 算法类型，MASKXY parameters 是 parameters Object 脱敏算法参数 表2 parameters 参数 是否必选 参数类型 描述 type 是 String 掩盖字符串的方式，取值为： CHAR：字符掩盖 RAND：随机掩盖 method 是 String 掩盖参数，若type字段为“RAND”时，method取值只能为： CHAR：替换为字母 DIGITAL：替换为数字 BOTH：数字与字母混合替换 x 是 Int 掩盖字符的开始位置 y 是 Int 掩盖字符的结束位置

日志管理 通过授权对象存储服务（Object Storage Service，OBS）存储态势感知日志，帮助用户轻松应对安全日志存储、导出场景，满足日志存储180天及集中审计的要求。 表11 日志管理功能说明 功能模块 功能详情 日志管理 通过OBS存储日志，满足SA日志审计和容灾需求。 为应对SA日志的容灾恢复，将存储到OBS桶的日志，通过数据接入服务（Data Ingestion Service）传输到线下SIEM系统，恢复和离线管理SA日志数据。同时，可将线下SIEM系统日志数据，通过DIS重新传输上云进行分析和存储。 DIS支持通过以下几种方式上传和下载数据：Kafka Adapter、DIS Agent、DIS Flume Plugin、DIS Flink Connector、DIS Spark Streaming、DIS Logstash Plugin等，详细说明请参见使用DIS。

产品集成 通过集成安全防护产品，接入安全产品检测数据，管理检测结果的数据来源。 表12 产品集成功能说明 功能模块 功能详情 安全产品集成 通过集成安全防护产品，接入安全产品检测数据，管理检测结果的数据来源，支持查看传输数据量，管理数据上报健康状态。 已接入的华为云产品/服务 企业主机安全（HSS）、Web应用防火墙（WAF）、AntiDDoS流量清洗（AntiDDoS）、云堡垒机（CBH）、容器安全服务（CGS）、漏洞扫描服务（VSS）。 企业主机安全（HSS）支持接入主机告警、主机基线、主机漏洞类型的检测数据。 支持接入数据源产品 华为产品、第三方服务商产品、线下自有产品等。 支持威胁情报溯源 安天威胁情报综合分析平台（TID）

威胁告警事件 默认“实时监控”并上报威胁告警事件，支持检测和呈现8大类威胁告警事件，包括DDoS、暴力破解、Web攻击、后门木马、僵尸主机、异常行为、漏洞攻击和命令与控制。 表6 威胁告警事件说明 告警名称 威胁告警说明 DDoS “实时检测”华为云、非华为云及IDC的互联网主机的DDoS攻击。 共支持检测100+种子类型DDoS威胁。 网络层攻击 NTP Flood攻击、CC攻击等。 传输层攻击 SYN Flood攻击、ACK Flood攻击等。 会话层攻击 SSL连接攻击等。 应用层攻击 HTTP Get Flood攻击、HTTP Post Flood攻击等。 暴力破解 “实时检测”入侵资产的行为和主机资产内部的风险，检测SSH、RDP、FTP、SQL Server、MySQL等账户是否遭受的口令破解攻击，以及检测资产账户是否被破解异常登录。 共支持检测22种子类型的暴力破解威胁。 支持检测的暴力破解威胁 包括SSH暴力破解（2种）、RDP暴力破解、MSSQL暴力破解、MySQL暴力破解、FTP暴力破解、SMB暴力破解（3种）、HTTP暴力破解（4种）、Telnet暴力破解。 接入的HSS服务上报的告警事件 包括SSH暴力破解、RDP暴力破解、FTP暴力破解、MySQL暴力破解、IRC暴力破解、Webmin暴力破解、其他端口被暴力破解、系统被成功爆破事件。 Web攻击 “实时检测”Web恶意扫描器、IP、网马等威胁。 共支持检测38种子类型的Web攻击威胁。 支持检测的Web攻击威胁 包括Webshell攻击（3种）、跨站脚本攻击、代码注入攻击（7种）、SQL注入攻击（9种）、命令注入攻击。 接入的HSS服务上报的告警事件 包括Webshell攻击、Linux网页篡改、Windows网页篡改。 接入的WAF服务上报的告警事件 包括跨站脚本攻击、命令注入攻击、SQL注入攻击、目录遍历攻击、本地文件包含、远程文件包含、远程代码执行、网站后门、网站信息泄露、漏洞攻击、IP信誉库、恶意爬虫、网页防篡改、网页防爬虫。 后门木马 “实时检测”资产系统是否存在后门木马风险，以及被后门木马程序入侵后的恶意请求行为。 共支持检测5种子类型的后门木马威胁。 检测主机资产上Web目录中的PHP、JSP等后门木马文件类型。 检测资产被植入木马特性 检测内容包括资产系统存在win32/ramnit checkin木马、被入侵后执行wannacry勒索病毒相关的DNS解析请求、被入侵后尝试下载木马程序，被入侵后访问HFS下载服务器等。 僵尸主机 “实时检测”资产被入侵后对外发起攻击的威胁。 共支持检测7种子类型的僵尸主机威胁。 对外发起SSH暴力破解 对外发起RDP暴力破解 对外发起Web暴力破解 对外发起MySQL暴力破解 对外发起SQLServer暴力破解 对外发起DDoS攻击 被入侵后安装挖矿程序 异常行为 “实时检测”资产系统异常变更和操作行为。 共支持检测21种子类型的异常行为威胁。 支持检测的异常行为威胁 包括文件系统被扫描、CMS V1.0漏洞、敏感文件被访问。 接入的HSS服务上报的告警事件 包括系统成功登录审计事件、文件目录变更监测事件、混杂模式网卡、异常权限用户、反弹Shell、异常Shell、高危命令执行、异常自启动、文件提权、进程提权、Rootkit程序。 接入的WAF服务上报的告警事件 包括自定义规则、白名单、黑名单、地理访问控制、扫描器爬虫、IP黑白名单、非法访问。 接入的MTD服务上报的告警事件 包括暴力破解、恶意攻击、渗透、挖矿攻击等恶意活动和未经授权行为。 漏洞攻击 “实时检测”资产被尝试使用漏洞进行攻击。 共支持检测2种子类型的漏洞攻击威胁。 SMBv1漏洞攻击 WebCMS漏洞攻击 命令控制 “实时检测”资产可能被命令与控制服务器（C&C，Command and Control Server）远程控制，访问与恶意软件或建立与恶意软件之间的链接。 共支持检测3种子类型的命令控制威胁。 监控主机存在访问DGA域名行为 监控主机存在访问恶意C&C域名行为 监控主机存在恶意C&C通道行为

漏洞管理 通过实时获取业界热点安全漏洞讯息，同步主机漏洞扫描和网站漏洞扫描结果，全面掌握云上资产漏洞风险状况，并提供相应漏洞修复建议。 表7 漏洞管理功能说明 功能模块 功能详情 主机漏洞 通过授权主机，并一键扫描主机漏洞，呈现主机漏洞扫描检测信息，支持查看漏洞详情，并提供相应漏洞修复建议。 Linux软件漏洞扫描 通过比对国际通用漏洞库，检测系统和官方软件（非绿色版、非自行编译安装版，例如：SSH、OpenSSL、Apache、MySQL等）存在的漏洞，识别Linux系统存在的漏洞风险。 Windows软件漏洞扫描 通过同步国际通用补丁源，识别并告警提醒Windows系统潜在漏洞风险。 Web-CMS漏洞扫描 通过对Web目录和文件进行检测，识别出Web-CMS漏洞，提升Web服务安全性。 网站漏洞 通过自动同步VSS漏洞扫描结果，分类呈现网站漏洞扫描详情，支持查看漏洞详情列表、不同类型漏洞分布和不同漏洞等级分布，并提供相应漏洞修复建议。 Web常规漏洞扫描 提供OWASP TOP10和WASC的漏洞检测能力，支持扫描30多种常见漏洞。包括XSS、SQL注入等。 网站弱密码扫描 全方位的OS连接，涵盖90%的中间件，支持标准Web业务弱密码检测、操作系统、数据库等弱口令检测；比对丰富的弱密码匹配库，模拟黑客对各场景进行弱口令探测。 网站端口扫描 扫描服务器端口的开放状态，检测出容易被黑客发现的端口。 CVE网站漏洞扫描 同步国际通用漏洞库，扫描网站安全状况。 网页内容合规检测 对网站文字和图片规范性进行检测。 网站挂马检测 检测网站是否被上传木马，避免网站运行时自动执行木马程序，而被黑客控制。 网站链接健康检测 检测网站的链接地址健康性状态，避免网站出现死链、暗链、恶意链接。 应急漏洞公告 针对业界披露的热点安全漏洞，支持每5分钟抓取一次安全漏洞讯息，获取最新应急漏洞公告详情。

基线检查 通过执行云服务基线扫描，检查基线配置风险状态，告警提示存在安全隐患的配置，并提供基线加固建议。 表8 基线检查功能说明 功能模块 功能详情 云服务基线 通过一键扫描或设置定期扫描，分类呈现云服务配置检测结果，提示不合格检测项，并提供相应配置加固建议和帮助指导。 支持检测“安全上云合规检查1.0”、“等保2.0三级要求”、“护网检查”风险类别，了解云服务风险配置的所在范围和风险配置数目。 安全上云合规检查 针对上云用户服务产品身份与访问管理、检测、基础设施防护、数据保护、事件响应风险检查。 护网检查 云战区产品团队安全风险排查及加固指导。 等保2.0三级要求 国家2.0等保通用三级合规检查。

安全报告 为统计全局安全攻击态势，通过开启安全报告，态势感知以邮件形式向指定的收件人发送安全报告，反映阶段性安全概况、安全风险趋势。 表10 安全报告功能说明 功能模块 功能详情 分析报告 安全分析报告支持以多种报告形式呈现报告内容，支持选择自动或手动触发发送报告，并支持管理报告列表和历史报告。 报告内容 包括安全评分、资产风险、威胁告警、基线风险、资产漏洞，以及可自定义小结。 报告形式 周期报告：按一定周期（按月或按周），自动生成并发送报告，包括周报和月报。 单次报告：可自选时间范围编辑报告内容，生成一次性报告，可生成季度报、周报、日报等形式。 报告发送方式 包括自动发送和手动触发发送。

威胁告警 “实时监控”云上威胁攻击，提供告警通知和监控，记录近180天告警事件详情，分析威胁攻击情况，并针对典型威胁事件预置策略实施防御手段。 目前，支持检测和呈现8大类威胁告警事件，包括DDoS、暴力破解、Web攻击、后门木马、僵尸主机、异常行为、漏洞攻击和命令与控制，详细说明请参见威胁告警事件。 表5 威胁告警功能说明 功能模块 功能详情 告警列表 列表呈现威胁告警事件统计信息，支持查看告警事件和受威胁资产详情，并支持导出全部告警事件。 威胁分析 支持从“攻击源”或“被攻击资产”查询威胁攻击，统计威胁攻击次数或资产被攻击次数。 告警监控 自定义监控的威胁名单、告警类型、告警级别等，选择性呈现关注的威胁告警。 通知告警 自定义威胁告警通知，支持设置每日定时告警通知和实时告警通知，通过接收消息通知及时了解威胁风险。

业务分析 业务分析全面展示云上资产的安全状态和存在的安全风险。 表3 业务分析功能说明 功能模块 功能详情 HSS专项分析 关联HSS云主机资产防护服务，分析并呈现主机的安全状态和存在的安全风险，需先购买HSS服务。 WAF专项分析 关联WAF网络应用防火墙服务，分析并呈现网络应用的安全状态和存在的安全风险，需先购买WAF服务。 DBSS专项分析 关联DBSS数据库安全服务，分析并呈现数据的安全状态和存在的安全风险，需先购买DBSS审计服务。

综合大屏 利用AI技术将海量云安全数据的分析并分类，通过综合大屏将数据可视化展示，集中呈现云上实时动态，云上关键风险一目了然，掌握云上安全态势更简单，更直观，更高效。 综合大屏功能为额外购买的功能，在购买专业版时为选购付费项目。 表4 综合大屏功能说明 功能模块 功能详情 综合态势感知 大屏集中展示云上综合安全态势，支持查看以下组件内容： 全网安全地图 将攻击源和受威胁资产具象化，投射到全球区域地图，动态呈现全网受威胁资产区域和攻击来源地。 全网威胁度 统计全网资产受威胁数目。 今日威胁雷达图 呈现当日检测出的威胁事件数目。 威胁事件趋势 呈现近7天的威胁事件数目的变化趋势。 受威胁资产数量趋势 呈现近7天的受威胁资产数量的变化趋势。 威胁类型分布 呈现不同威胁类型的分布状况。 受攻击资产区域分布 呈现受威胁主机的区域分布状况。 威胁源主机TOP5 呈现攻击次数前五的攻击源主机信息。 主机安全态势 大屏集中呈现华为云主机安全态势，支持查看以下组件内容： 风险主机地图 将风险主机具象化，投射到各区域，动态呈现当日总主机风险数量、Windows系统主机风险数量、Linux系统主机风险数量。 主机安全事件统计 呈现5类威胁事件发生次数，以及受威胁资产数量，主要包括暴力破解、异地登录、恶意程序、网站后门和文件变更。 资产统计 呈现当前华为云Windows系统主机和Linux系统主机数量。 近7天暴力破解趋势 呈现近7天暴力破解攻击次数的变化趋势。 近7天风险主机趋势 呈现近7天风险主机被攻击次数的变化趋势。 TOP5风险云主机 呈现被攻击次数前五的风险主机信息。 暴力破解类型 呈现5类暴力破解攻击主机的次数，以及不同类型暴力破解分布情况。 漏洞检测 呈现当日检测出的Windows漏洞和Linux漏洞个数，以及所占比例。 基线检测 呈现云服务基线检测出的风险数。

资源管理 态势感知支持呈现云上资产实时安全状态。 表2 资源管理功能说明 功能模块 功能详情 资源管理 同步当前帐号中所有资源的安全状态统计信息。 支持查看资源的名称、所属服务、所属区域、安全状况等，帮助您快速定位安全风险问题并提供解决方案。 目前支持查看以下资源的安全状况： 弹性云服务器 ECS、虚拟私有云 VPC、对象存储服务 OBS、弹性公网IP EIP、云解析服务 DNS、弹性负载均衡 ELB、云数据库 RDS、裸金属服务器 BMS、云容器引擎 CCE、云容器实例 CCI、Web应用防火墙 WAF、SSL证书管理 SCM、云硬盘 EVS

攻击类型 DDoS攻击 分布式拒绝服务（Distributed Denial of Service，简称DDoS）攻击是指攻击者使用网络上多个被攻陷的电脑作为攻击机器，向特定的目标发动DoS攻击。DoS（Denial of Service）攻击也称洪水攻击，是一种网络攻击手法，其目的在于使目标电脑的网络或系统资源耗尽，服务暂时中断或停止，导致合法用户不能够访问正常网络服务的行为。 暴力破解 暴力破解法是一种密码分析方法，基本原理是在一定条件范围内对所有可能结果进行逐一验证，直到找出符合条件的结果为止。攻击者通常使用暴力破解的方式猜测远程登录的用户名和密码，一旦破解成功，即可实施攻击和控制。 Web攻击 Web攻击是针对用户上网行为或网站服务器等设备进行攻击的行为。常见的Web攻击方式包括SQL注入攻击、跨站脚本攻击、跨站请求伪造攻击等。 后门木马 后门木马又称特洛伊木马（Trojan Horse），是一种后门程序。后门木马具有很高的伪装性，通常表现为一个正常的应用程序或文件，以获得广泛的传播和目标用户的信任。当目标用户执行后门木马程序后，攻击者即可对用户的主机进行破坏或盗取敏感数据，如各种账户、密码、保密文件等。在黑客进行的各种攻击行为中，后门木马基本上都起到了先导作用，为进一步的攻击打下基础。 僵尸主机 僵尸主机亦称傀儡机，是由攻击者通过木马蠕虫感染的主机，大量僵尸主机可以组成僵尸网络（Botnet）。攻击者通过控制信道向僵尸网络内的大量僵尸主机下达指令，令其发送伪造包或垃圾数据包，使攻击目标瘫痪并“拒绝服务”，这就是常见的DDoS攻击。此外，随着虚拟货币（如比特币）价值的持续增长，以及挖矿成本的逐渐增高，攻击者也开始利用僵尸主机进行挖矿和牟利。 异常行为 异常行为主要指在主机中发生了一些不应当出现的事件。例如，某用户在非正常时间成功登录了系统，一些文件目录发生了计划外的变更，进程出现了非正常的行为等。这些异常的行为事件很多是有恶意程序在背后作乱。所以在发生这类异常行为时，应当引起重视。态势感知中的异常行为数据主要来源于主机安全服务。 漏洞攻击 漏洞是指计算机系统安全方面的缺陷，可导致系统或应用数据遭受保密性、完整性、可用性等方面的威胁。攻击者利用漏洞获取计算机权限、盗取敏感数据、破坏软硬件系统等行为均可称为漏洞攻击。 命令与控制 域名生成算法（Domain Generation Algorithm，简称DGA）是一种利用随机字符生成命令与控制（Command and Control，简称C&C）域名的技术，常被用于逃避域名黑名单功能的检测。 攻击者利用DGA生产恶意域名后，选择部分域名进行注册并指向C&C服务器。当受害者运行恶意程序后，主机将通过恶意域名连接至C&C服务器，攻击者即可远程操控主机。

漏洞风险通报 随着企业业务的不断上云，为避免漏洞被成功利用，需尽可能多的找出并修复漏洞。 态势感知通过采集云上应急安全通告，能够实时披露新发现的漏洞，通报突发安全漏洞事件和预警潜在漏洞；同时通过集成漏洞扫描结果，能够定期进行漏洞扫描，集中管理主机漏洞和网站漏洞，对系统、软件和网站进行检测，检测出系统、软件和网站存在的漏洞，针对检测到的漏洞提供修复建议。 集中的云上漏洞管理，快速帮助用户识别关键风险，发现攻击者可能感兴趣的资产，帮助用户快速弥补安全短板。

计费项 态势感知基础版免费体验。标准版、专业版按选购的资产配额数和综合大屏计费，其中综合大屏功能为可选增值项目。 表1 计费项说明 版本 计费项 计费说明 基础版 无 免费体验，不计费。 标准版 资产配额 按购买的资产配额数计费，包括主机资产配额数和网站资产配额数。 按包周期购买计费 提供包月和包年的购买模式。 专业版 资产配额 按购买的资产配额数计费，包括主机资产配额数和网站资产配额数。 综合大屏（可选） 增值项。若有大屏展示需求，您需在已购买资产配额基础上，额外付费购买。 按包周期购买计费 提供包月和包年的购买模式。 按需购买计费 即开即停，按小时结算。

变更配置 变更计费模式 当您对当前按需计费资源有长期使用需求，可选择将按需变更为包周期。在转包周期过程将生成新的订单，支付订单后，包周期资源则立即生效。 变更资产配额 当您的资产数量增加，可在当前计费模式内增加资产配额数，不支持减少配额数。 开通综合大屏功能 当您需要态势大屏展示，可在原有资产配额基础上，追加综合大屏功能。 退订 若购买态势感知后，需停止使用，请执行退订操作。 基础版不支持退订。 标准版不支持直接升级到专业版，且专业版也不支持直接变更到标准版。如需使用对应版本，需退订当前版本后再进行购买。 标准版仅支持通过包周期计费模式进行购买。 不支持部分配额购买标准版，部分配额购买专业版。 综合大屏为专业版额外选购付费项目，如需使用综合大屏，请先购买专业版。

续费 包周期购买的版本到期后，您可以单击右上角“续费”，跳转至续费管理页面完成续费，延长使用期。 为避免版本到期未及时续费，导致安全风险，建议开通自动续费。开通自动续费后，系统将根据配置自动续费，无需手动操作。 按需计费是按小时计费，请确保账户余额充足，及时为账户充值。在账户余额充足的前提下，将持续为您提供防护服务，不影响使用。 更多续费信息（例如自动续费、导出续费清单、变更资费等），请参见续费管理。

获取指定告警行动规则的详细信息 接口相关信息 URI格式：GET /v2/{project_id}/alert/action-rules/{rule_name} 请求示例 GET https://{Endpoint}/v2/{project_id}/alert/action-rules/{rule_name} {aom_endpoint}信息请通过地区和终端节点获取。 响应示例 {"create_time": 1665991889597,"notification_template": "aom.built-in.template.zh","project_id": "2xxxxxxxxxxxxxxxxxxxxxxf","rule_name": "1112222","smn_topics": [{"display_name": "","name": "gxxxxxt","push_policy": 0,"status": 0,"topic_urn": "urn:smn:xxxx:2xxxxxxxxxxxxxxxxxxxxxxf:gxxxxxt"}],"time_zone": "Asia/Shanghai","type": "1","update_time": 1665991889597,"user_name": "kxxxxxxxt"}

状态码 正常 状态码如表5所示。 表5 状态码 状态码 编码 描述 200 OK 请求响应成功。 异常 状态码如表6所示。更多状态码请见状态码。 表6 状态码 状态码 编码 描述 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。

URI POST /v1/{project_id}/ams/metricdata?fillValue=xx 替换接口请参考查询监控数据。 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 取值范围 描述 project_id 是 String - 租户从IAM申请到的projectid，一般为32位字符串。 fillValue 否 String -1、0、null、average 用于对查询到的监控数据进行断点插值，默认值为-1。 -1：断点处使用-1进行表示。 0 ：断点处使用0进行表示。 null：断点处使用null进行表示。 average：断点处使用前后邻近的有效数据的平均值进行表示，如果不存在有效数据则使用null进行表示。

请求消息 请求参数 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 取值范围 描述 metrics 是 Array JSON数组大小不超过20 指标列表 namespace 是 String PAAS.CONTAINER、PAAS.NODE、PAAS.SLA、PAAS.AGGR、CUSTOMMETRICS 指标命名空间 metricName 是 String 名称长度为1~255个字符 指标名称 dimensions 是 Array 数组不能为空，同时数组中任何一个dimension对象name和value属性的值也不能为空。 指标维度 dimensions.name：维度名称，如应用名称为appName。 dimensions.value：维度取值，如应用名称具体的值。 period 是 Integer 枚举值，取值范围： 60，1分钟粒度 300，5分钟粒度 900，15分钟粒度 3600，1小时粒度 监控数据粒度。 timerange 是 String 格式：开始时间UTC毫秒.结束时间UTC毫秒.时间范围分钟数。开始和结束时间为-1时，表示最近N分钟，N为时间范围分钟取值。 查询时间段，如最近五分钟可以表示为-1.-1.5，固定的时间范围（2017-08-01 08:00:00到2017-08-02 08:00:00）可以表示为1501545600000.1501632000000.1440。 说明： timerange/period≤1440 计算时，timerange和period需换算为相同的单位。 statistics 是 Array maximum，minimum，sum，average，sampleCount 统计方式 Header说明 请求消息头（Header）如表3所示。 表3 Header说明 名称 是否必选 说明 X-Auth-Token 是 从IAM服务获取的用户Token。 Content-Type 是 指定类型为application/json。 请求示例 { "metrics": [ { "namespace": "abc", "metricName": "def", "dimensions": [ { "name": "instance_id", "value": "demo1" } ] } ], "period": 60, "timerange": "-1.-1.5",// 最近5分钟 "statistics": [ "maximum", "minimum", "sum" ] }

错误码 表7 错误码 错误码 错误信息 处理措施 SVCSTG_AMS_4000101 Projectid is left blank. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000102 The metric data parameter is null. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000103 Invalid period. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000104 Invalid statistics. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000105 Invalid metrics. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000106 Invalid time range. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000107 The number of data points in a time range exceeds 1440. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000110 Invalid fillValue. 请检查对应的参数是否符合要求。 SVCSTG_AMS_5000000 Internal server error. 请联系技术支持工程师解决。

响应消息 响应参数 响应参数如表4所示。 表4 响应参数 参数名称 类型 描述 errorCode String 响应码。 errorMessage String 响应信息描述。 metrics Object - 响应示例 { "errorCode": "SVCSTG.AMS.2000", "errorMessage": "success", "metrics": [{ "metric": { "namespace": "abc", "metricName": "def", "dimensions": [{ "name": "ghi", "value": "lmn" }] }, "dataPoints": [{ "timestamp": 1467892800000, "unit": "Percent", "statistics": [{ "statistic": "maximum", "value": 23 }] }] }] }

状态码 正常 状态码如表4所示。 表4 状态码 状态码 编码 描述 200 OK 请求响应成功。 异常 状态码如表5所示。更多状态码请见状态码。 表5 状态码 状态码 编码 描述 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。

错误码 表6 错误码 错误码 错误信息 处理措施 SVCSTG_AMS_4000109 Invalid project ID. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000110 Invalid limit. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000111 Invalid start. 请检查对应的参数是否符合要求。 SVCSTG_AMS_5030001 The Cassandra session is null. 请联系技术支持工程师解决。 SVCSTG_AMS_5030002 The Cassandra execution is abnormal. 请联系技术支持工程师解决。

请求消息 请求参数 请求参数如表1所示。 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 project_id 是 String - 租户从IAM申请到的projectid，一般为32位字符串。 limit 否 Integer (0,1000] 取值范围(0,1000]，默认值为1000。 用于限制结果数据条数。 start 否 String - 分页信息 Header说明 请求消息头（Header）如表2所示。 表2 Header说明 名称 是否必选 说明 X-Auth-Token 是 从IAM服务获取的用户Token。 Content-Type 是 指定类型为application/json。

错误码 表6 错误码 错误码 错误信息 处理措施 SVCSTG_AMS_4000101 Invalid alarm name. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000102 The threshold rule name already exists. 阈值名称已存在，请更换名称再次创建。 SVCSTG_AMS_4000103 Invalid alarm description. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000104 Invalid alarm threshold. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000105 Invalid alarm period. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000106 Invalid email list. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000107 The maximum number of threshold rules has been reached. 请联系技术支持工程师扩容。 SVCSTG_AMS_4000108 Invalid time range for alarm queries. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000109 Invalid project ID. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000115 Invalid request parameter. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000118 Invalid number of consecutive periods. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000119 Invalid alarm statistic. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000120 Invalid alarm comparison operator. 请检查对应的参数是否符合要求。 SVCSTG_AMS_4000121 The alarm does not exist. 请在界面上查看对应的阈值规则是否存在。 SVCSTG_AMS_5000000 Internal server error. 请联系技术支持工程师解决。

状态码 正常 状态码如表4所示。 表4 状态码 状态码 编码 描述 200 OK 请求响应成功。 异常 状态码如表5所示。更多状态码请见状态码。 表5 状态码 状态码 编码 描述 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。