华为云用户手册

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 监控接口、日志接口和弹性伸缩接口请使用AOM的终端节点，APM接口请使用APM的终端节点，详见终端节点。 resource-path：资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“xxx”区域的Token，则需使用“xxx”区域的Endpoint，并在获取用户Token的URI部分找到resource-path，拼接起来如下所示。 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 notified_histories Array of NotifiedHistoriesResult objects 通知历史列表。 表5 NotifiedHistoriesResult 参数 参数类型 描述 event_sn String 告警流水号 最小长度：19 最大长度：19 notifications Array of Notifications objects 通知结果 数组长度：0 - 100 表6 Notifications 参数 参数类型 描述 action_rule String 告警行动规则名称 最小长度：1 最大长度：100 notifier_channel String 通知类型。SMN：消息通知服务 枚举值： SMN smn_channel SmnResponse object 通知结果详情 表7 SmnResponse 参数 参数类型 描述 sent_time Long 发送时间。 最小值：0 最大值：9999999999 smn_notified_history Array of SmnInfo objects 发送的通知的消息内容。 数组长度：1 - 100 smn_request_id String 请求smn服务的请求id。 最小长度：32 最大长度：32 smn_response_body String 调用smn服务返回的信息。 最小长度：0 最大长度：1024 smn_response_code String 调用smn服务返回的http状态码。 最小长度：3 最大长度：3 smn_topic String smn的主题。 最小长度：1 最大长度：100 表8 SmnInfo 参数 参数类型 描述 smn_notified_content String smn发送消息的内容 最小长度：1 最大长度：9999999 smn_subscription_status String smn的订阅的状态 最小长度：1 最大长度：1 smn_subscription_type String smn的订阅类型 最小长度：1 最大长度：100 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度：13 最大长度：13 error_msg String 响应信息描述。 最小长度：1 最大长度：100 trace_id String 响应id。 最小长度：12 最大长度：12 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：0 最大长度：1024 error_type String 错误类型 最小长度：0 最大长度：128 trace_id String 请求id 最小长度：32 最大长度：32 状态码： 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：0 最大长度：1024 error_type String 错误类型 最小长度：0 最大长度：128 trace_id String 请求id 最小长度：32 最大长度：32 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度：13 最大长度：13 error_msg String 响应信息描述。 最小长度：1 最大长度：100 trace_id String 响应id。 最小长度：12 最大长度：12

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

响应示例 状态码： 200 OK 请求执行完成。 { "samples" : [ { "sample" : { "namespace" : "PAAS.CONTAINER", "metric_name" : "aom_process_cpu_usage", "dimensions" : [ { "name" : "appName", "value" : "aomApp" } ] }, "data_points" : [ { "timestamp" : "1694673300000", "unit" : "Percent", "statistics" : [ { "statistic" : "sum", "value" : "23" } ] } ] } ] } 状态码： 400 BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 { "error_code" : "AOM.04008001", "error_msg" : "please check request param", "error_type" : "BAD_REQUEST" }

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

请求示例 通过namespace，metric_name和dimensions信息查询最近五分钟的监控时序数据。 https://{Endpoint}/v2/{project_id}/samples { "samples": [ { "namespace": "PAAS.CONTAINER", "metric_name": "aom_process_cpu_usage", "dimensions": [ { "name": "appName", "value": "aomApp" } ] } ], "period": 60, "time_range": "-1.-1.5",// 最近5分钟 "statistics": [ "sum" ] }

URI POST /v2/{project_id}/samples 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid，一般为32位字符串。 表2 Query参数 参数 是否必选 参数类型 描述 fill_value 否 String 用于对查询到的时序数据进行断点插值，默认值为-1。-1：断点处使用-1进行表示。0 ：断点处使用0进行表示。null：断点处使用null进行表示。average：断点处使用前后邻近的有效数据的平均值进行表示，如果不存在有效数据则使用null进行表示。

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 samples Array of SampleDataValue objects 时间序列对象列表。 表7 SampleDataValue 参数 参数类型 描述 sample QuerySample object 时间序列对象列表。 data_points Array of MetricDataPoints objects 时序数据。 表8 QuerySample 参数 参数类型 描述 namespace String 时间序列命名空间。取值范围： PAAS.CONTAINER、PAAS.NODE、PAAS.SLA、PAAS.AGGR、CUSTOMMETRICS等。PAAS.CONTAINER：应用时间序列命名空间； PAAS.NODE：节点时间序列命名空间； PAAS.SLA：SLA时间序列命名空间；PAAS.AGGR：集群时间序列命名空间； CUSTOMMETRICS：自定义时间序列命名空间。 dimensions Array of DimensionSeries objects 时间序列维度列表。可通过/v2/{project_id}/series接口中namespace+metric_name，查询当前监控的时间序列名称的时间序列维度列表。 metric_name String 时间序列名称。名称长度取值范围为1~255个字符。取值范围：AOM提供的基础时间序列名称，cpuUsage、cpuCoreUsed等，cpuUsage：cpu使用率；cpuCoreUsed：cpu内核占用；用户上报的自定义时间序列名称。 表9 DimensionSeries 参数 参数类型 描述 name String 维度名称。 value String 维度取值。 表10 MetricDataPoints 参数 参数类型 描述 statistics Array of StatisticValue objects 统计方式。 timestamp Long 时间戳。 unit String 时间序列单位。 表11 StatisticValue 参数 参数类型 描述 statistic String 统计方式。 value Double 统计结果。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 error_type String 错误类型。

响应示例 状态码： 200 请求响应成功，返回任务列表。 { "elements" : [ { "citation_urns" : [ ], "create_by" : "xxxx", "create_time" : 16000000000, "description" : "", "edit_time" : 0, "enterprise_project_id" : "0", "execution_action_rules" : [ "xxxxxxx", "xxxxxxx" ], "execution_permission" : [ "xxxxxxx", "xxxxxx" ], "id" : "xxxxxx", "input" : { "package" : { "cmd_user" : "xxxxx", "software_list" : "[xxxxxxx]", "pre_install_script" : "", "operate_type" : "install", "un_install_script" : "", "version_number" : "1", "time_out" : "7200", "install_script" : "xxxx", "package_version_id" : "xxxxxx", "package_basic_id" : "xxxxxx", "package_name" : "xxxxx", "install_file_dir" : "xxxxx", "plat_form" : "Linux", "group" : "package" }, "project_id" : "xxxxxxx", "approve" : { "need_approve" : "false", "group" : "approve" }, "region_id" : "cn-north-7", "get_instances" : { "frontend_info" : "{xxxxxx}", "ecs_id_list" : "[xxxxxxx]", "type" : "cmdb_manual", "group" : "ecs_instance" }, "rate_control" : { "max" : "0", "timeDelay" : "0", "group" : "rate_control" } }, "is_delete" : false, "last_execute_by" : "xxxxxx", "last_execution_end_time" : 1600000000, "last_execution_id" : "xxxxxx", "last_execution_start_time" : 1600000000, "name" : "xxxxxx", "nodes" : [ { "category" : "service", "description" : "download obs plug and install plug", "id" : "xxxxxx", "ignore_error" : true, "metadata" : { "configuration" : { "func_urn" : "xxxxxxx", "dataOutputPath" : "", "func_app" : "CMS", "dataInputPath" : "", "validator" : true, "func_version" : "latest", "dataResultsPath" : "", "parameters" : [ { "default" : "", "showFormat" : false, "format" : "", "value" : "root", "isEditor" : false, "key" : "properties.cmd_user" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "[xxxxxx]", "isEditor" : false, "key" : "properties.software_list" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "", "isEditor" : false, "key" : "properties.pre_install_script" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "install", "isEditor" : false, "key" : "properties.operate_type" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "", "isEditor" : false, "key" : "properties.un_install_script" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "1", "isEditor" : false, "key" : "properties.version_number" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "7200", "isEditor" : false, "key" : "properties.time_out" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "xxxx", "isEditor" : false, "key" : "properties.install_script" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "xxxxxx", "isEditor" : false, "key" : "properties.package_version_id" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "xxxxxx", "isEditor" : false, "key" : "properties.package_basic_id" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "xxxxx", "isEditor" : false, "key" : "properties.package_name" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "xxxx", "isEditor" : false, "key" : "properties.install_file_dir" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "Linux", "isEditor" : false, "key" : "properties.plat_form" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "package", "isEditor" : false, "key" : "properties.group" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "xxxxxx", "isEditor" : false, "key" : "properties.project_id" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "cn-north-4", "isEditor" : false, "key" : "properties.region_id" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "{xxxxxx}", "isEditor" : false, "key" : "properties.frontend_info" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "[xxxxxx]", "isEditor" : false, "key" : "properties.ecs_id_list" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "cmdb_manual", "isEditor" : false, "key" : "properties.type" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "ecs_instance", "isEditor" : false, "key" : "properties.group" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "0", "isEditor" : false, "key" : "properties.max" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "0", "isEditor" : false, "key" : "properties.timeDelay" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "rate_control", "isEditor" : false, "key" : "properties.group" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "$.executionId", "isEditor" : false, "key" : "properties.executionId" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "xxxxxxx", "isEditor" : false, "key" : "properties.workflowId" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "CMS::ECS::Package", "isEditor" : false, "key" : "properties.cmsTaskName2Distribute" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "xxxxxx", "isEditor" : false, "key" : "properties.cmsAccessPodLb" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "manual", "isEditor" : false, "key" : "properties.workflowType" }, { "default" : "", "showFormat" : false, "format" : "", "value" : "package-manipulation", "isEditor" : false, "key" : "properties.nodeId" } ] }, "type" : "operation" }, "name" : "package", "task_name" : "CMS::ECS::Package" } ], "project_id" : "xxxxxx", "quote" : [ ], "status" : "fail", "steps" : [ ], "tags" : { }, "task_type" : "package", "template_i18n" : { "en-us" : { "name" : "Package", "description" : "download install plug or uninstall plug" }, "zh-cn" : { "name" : "文件管理", "description" : " " } }, "template_id" : "CMS::ECS::Package", "template_name" : "CMS::ECS::Package", "type" : "manual", "update_time" : 1600000000 } ], "total_elements" : 1 } 状态码： 400 BadRequest。非法请求。建议直接修改该请求，不要重试该请求。 { "error_code" : "AOM.31001302", "error_msg" : "Invalid input parameter.", "http_code" : 400 } 状态码： 401 Unauthorized。在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "AOM.31009003", "error_msg" : "auth failed.", "http_code" : 401 } 状态码： 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 { "error_code" : "AOM.31001305", "error_msg" : "workflow internal server error.", "http_code" : 500 }

请求示例 可指定name为xxx、last_execute_by为xxx、status为xxx、task_type为xxx、search_time_start为1600060125000的查询参数用于查询任务列表。 https://{Endpoint}/v1/{project_id}/cms/workflow-list { "search" : "", "tags" : { }, "page" : 0, "size" : 10, "enterprise_project_id" : "0", "create_by" : "xxx", "sort_field" : "update_time", "sort_type" : "DESC", "status" : "xxx", "type" : "manual", "search_time_start" : 160000000000, "search_time_end" : 160000000000 }

响应示例 状态码： 200 环境信息详情 { "creator" : "xxx", "modifier" : "xxx", "region" : "xxx", "create_time" : "2023-02-03 11:17:19", "modified_time" : "2023-02-03 11:17:19", "register_type" : "API", "env_name" : "environment1", "env_id" : "530312e8bd7c4674b0af6d4beb2e23c6", "description" : "环境描述", "component_id" : "28c600be47374b9697404b0f58263d1c", "os_type" : "LINUX", "env_type" : "DEV", "eps_id" : "0", "aom_id" : null, "env_tags" : null }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 aom_id String aomId component_id String 组件Id create_time String 创建时间 creator String 创建者 description String 描述 env_id String 环境Id env_name String 环境名称 env_tags Array of TagNameAndIdVo objects 环境标签 env_type String 环境类型 eps_id String 企业项目Id modified_time String 修改时间 modifier String 修改者 os_type String os类型 region String 区域 register_type String 注册方式 枚举值： API CONSOLE SERVICE_DISCOVERY 表4 TagNameAndIdVo 参数 参数类型 描述 tag_id String 标签Id tag_name String 标签名称 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String AOM.30005001 error_msg String 参数错误 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String AOM.30001005 error_msg String 没有权限

响应示例 状态码： 200 OK 请求响应成功。 { "status" : "success", "data" : [ "__name__", "alarm_level", "adfname", "alertstate", "ammApplicationID", "ammApplicationName", "appID", "appName", "clusterId", "clusterName", "cluster_id", "comparisonOperator", "containerID", "containerName", "nameSpace", "namespace", "netDevice", "nodeIP", "nodeName", "node_ip", "pailId", "pailName", "period_expr", "podID", "podName", "processCmd" ] } 状态码： 400 BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 { "status" : "error", "errorType" : "bad_param", "error" : "param is invalid." } 状态码： 403 Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 { "status" : "error", "errorType" : "auth", "error" : "auth project_id not pass." } 状态码： 422 Unprocessable 表达式无法执行。 { "status" : "error", "errorType" : "excution", "error" : "expression can't be executed." } 状态码： 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。 { "status" : "error", "errorType" : "timeout", "error" : "query timed out in query execution." }

状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 403 Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 422 Unprocessable 表达式无法执行。 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 响应状态。 data Array of objects 标签值信息。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 status String 响应状态。 errorType String 错误类型。 error String 错误信息。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 status String 响应状态。 errorType String 错误类型。 error String 错误信息。 状态码： 422 表6 响应Body参数 参数 参数类型 描述 status String 响应状态。 errorType String 错误类型。 error String 错误信息。 状态码： 503 表7 响应Body参数 参数 参数类型 描述 status String 响应状态。 errorType String 错误类型。 error String 错误信息。

响应示例 状态码： 200 环境信息详情 { "creator" : "xxx", "modifier" : "xxx", "region" : "xxx", "create_time" : "2023-02-03 11:17:19", "modified_time" : "2023-02-03 11:17:19", "register_type" : "API", "env_name" : "environment1", "env_id" : "530312e8bd7c4674b0af6d4beb2e23c6", "description" : "环境描述", "component_id" : "28c600be47374b9697404b0f58263d1c", "os_type" : "LINUX", "env_type" : "DEV", "eps_id" : null, "aom_id" : null, "env_tags" : null }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 aom_id String aomId component_id String 组件Id create_time String 创建时间 creator String 创建者 description String 描述 env_id String 环境Id env_name String 环境名称 env_tags Array of TagNameAndIdVo objects 环境标签 env_type String 环境类型 eps_id String 企业项目Id modified_time String 修改时间 modifier String 修改者 os_type String os类型 region String 区域 register_type String 注册方式 枚举值： API CONSOLE SERVICE_DISCOVERY 表5 TagNameAndIdVo 参数 参数类型 描述 tag_id String 标签Id tag_name String 标签名称 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String AOM.30005001 error_msg String 参数错误 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String AOM.30001005 error_msg String 没有权限

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

响应示例 状态码： 200 OK 请求响应成功。 { "errorCode" : "SVCSTG.INV.2000000", "errorMessage" : null, "id" : [ ], "results" : [ { "name" : "aom_inventory_rules_event", "id" : "b53a5152-****-****-****-302367e04c0b" } ] } 状态码： 400 BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 { "errorCode" : "SVCSTG.INV.4000115", "errorMessage" : "Request param is invalid", "id" : [ ], "results" : [ ] }

请求示例 添加名称为“aom_inventory_rules_event”且用户project_id为“684fc87a79d7xxxx22e62a7da95b”的应用发现规则。 https://{endpoint}/v1/{project_id}/inv/servicediscoveryrules { "appRules" : [ { "createTime" : "1694705766730", "enable" : true, "name" : "ica**nt", "eventName" : "aom_inventory_rules_event", "hostid" : [ ], "id" : "b53a5152-****-****-****-302367e04c0b", "projectid" : "684fc87a79d7xxxx22e62a7da95b", "spec" : { "detectLog" : "true", "editable" : null, "logPathRule" : [ ], "priority" : 9999, "attrList" : [ "cmdLine" ], "nameRule" : { "appNameRule" : [ { "args" : [ "/opt/********* -DNFW=ica**nt" ], "nameType" : "cmdLineHash", "value" : [ "aicagentserver" ] } ], "applicationNameRule" : [ { "args" : [ "/opt/*********** -DNFW=ica**nt" ], "nameType" : "cmdLineHash", "value" : [ "aica**nt" ] } ] }, "appType" : "", "aom_metric_relabel_configs" : null, "logFileFix" : [ "log", "trace", "out" ], "isDetect" : "false", "isDefaultRule" : null, "dataSource" : null, "discoveryRule" : [ { "checkType" : "cmdLine", "checkContent" : [ "-DNFW=ica**nt" ], "checkMode" : "contain" } ] }, "desc" : "自定义描述/User-defined description" } ], "errorMessage" : null, "errorCode" : "SVCSTG.INV.2000000", "id" : [ ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 Content-Type 是 String 指定类型为application/json。 枚举值： application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 appRules 否 Array of AppRules objects 服务参数。 表4 AppRules 参数 是否必选 参数类型 描述 createTime 否 String 规则创建时间(创建时不传，修改时传查询返回的createTime)。 缺省值：1599098476654 enable 是 Boolean true、false 规则是否启用。 eventName 是 String aom_inventory_rules_event规则事件名称，对于服务发现固定为"aom_inventory_rules_event"。 hostid 否 Array of strings 主机ID（暂不使用，传空即可）。 id 是 String 创建时填空，修改时填规则ID。 name 是 String 规则名称。 字符长度为4到63位，以小写字母a-z开头，只能包含0-9/a-z/-，不能以-结尾。 projectid 是 String 租户从IAM申请到的projectid，一般为32位字符串。 spec 是 AppRulesSpec object 规则详情。 desc 否 String 自定义描述信息 表5 AppRulesSpec 参数 是否必选 参数类型 描述 appType 是 String 服务类型，用于标记服务的分类，仅用于规则分类和界面展示。可以填写任意字段,如按技术栈分类可填写Java，Python。按作用分类可填写collector(采集)，database(数据库)等。 attrList 否 Array of strings 属性列表(暂不使用,可不传)。 cmdLine、env detectLog 是 String 是否开启日志采集。 true、false discoveryRule 是 Array of DiscoveryRule objects 规则发现部分，数组中有多个对象时表示需要同时满足所有条件的进程才会被匹配到。checkType为cmdLine时checkMode填contain，checkContent格式为["xxx"]表示进程命令行参数中需要包含xxx。checkType为env时checkMode填contain，checkContent格式为 ["k1","v1"]表示进程环境变量中需要包含名为k1值为v1的环境变量。checkType为scope时checkMode填equals，checkContent格式为节点ID数组["hostId1","hostId2"]，表示规则仅会在这些节点上生效(如果不指定节点范围，规则将下发到该项目所有的节点)。 isDefaultRule 是 String 是否为默认规则。 true、false isDetect 是 String 是否为规则预探测场景（预探测场景不会保存规则,仅用于规则下发之前验证该规则能否有效发现节点上的进程）。true、false logFileFix 是 Array of strings 日志文件的后缀。 log、trace、out logPathRule 否 Array of LogPathRule objects 日志路径配置规则。当cmdLineHash为固定字符串时,指定日志路径或者日志文件。否则只采集进程当前打开的以.log和.trace结尾的文件。nameType取值cmdLineHash时，args格式为["00001"]，value格式为["/xxx/xx.log"]，表示当启动命令是00001时,日志路径为/xxx/xx.log。 nameRule 是 NameRule object 发现上来的服务、应用的命名规则。 priority 是 Integer 规则优先级。1~9999的整数字符串，默认取值为9999 表6 DiscoveryRule 参数 是否必选 参数类型 描述 checkContent 是 Array of strings 匹配值。 checkMode 是 String 匹配条件。contain、equals checkType 是 String 匹配类型。cmdLine、env、scope 表7 LogPathRule 参数 是否必选 参数类型 描述 args 是 Array of strings 命令行。 nameType 是 String 取值类型。 cmdLineHash value 是 Array of strings 日志路径。 表8 NameRule 参数 是否必选 参数类型 描述 appNameRule 是 Array of AppNameRule objects 服务命名部分，数组中有多个对象时表示将每个对象抽取到的字符串拼接作为服务的名称。nameType取值cmdLine时args格式为["start","end"]，表示抽取命令行中start、end之间的字符。nameType取值cmdLine时args格式为["aa"]，表示抽取环境变量名为aa对应的环境变量值。nameType取值str时,args格式为["fix"]，表示服务名称最后拼接固定文字fix。nameType取值cmdLineHash时,args格式为["0001"]，value格式为["ser"]，表示当启动命令是0001时，服务名称为ser。 applicationNameRule 是 Array of ApplicationNameRule objects 应用命名部分。nameType取值cmdLine时args格式为["start","end"]，表示抽取命令行中start、end之间的字符。nameType取值cmdLine时args格式为 ["aa"]，表示抽取环境变量名为aa对应的环境变量值。nameType取值str时，args格式为["fix"]，表示服务名称最后拼接固定文字fix。nameType取值cmdLineHash时，args格式为["0001"]，value格式为["ser"]，表示当启动命令是0001时，应用名称为ser。 表9 AppNameRule 参数 是否必选 参数类型 描述 nameType 是 String 取值类型。从cmdLineHash、cmdLine、env、str里面选取。 args 是 Array of strings 输入值。 value 否 Array of strings 服务名(仅nameType为cmdLineHash时填写)。 表10 ApplicationNameRule 参数 是否必选 参数类型 描述 nameType 是 String 取值类型。 从cmdLineHash、cmdLine、env、str里面选取。 args 是 Array of strings 输入值。 value 否 Array of strings 服务名(仅nameType为cmdLineHash时填写)。

响应示例 状态码： 200 OK 请求执行完成。 { "meta_data" : { "count" : 1, "offset" : null, "total" : 1, "nextToken" : 0 }, "series" : [ { "namespace" : "PAAS.CONTAINER", "metric_name" : "cpuUsage", "unit" : "Percent", "dimensions" : [ { "name" : "appName", "value" : "appValue" } ] } ] } 状态码： 400 BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 { "error_code" : "AOM.04007001", "error_msg" : "please check request param", "error_type" : "BAD_REQUEST" }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 series Array of SeriesQueryItemResult objects 时间序列对象列表。 meta_data MetaDataSeries object 查询结果元数据信息，包括分页信息等。 表7 SeriesQueryItemResult 参数 参数类型 描述 namespace String 命名空间。 dimensions Array of DimensionSeries objects 维度列表。 metric_name String 时间序列名称。 unit String 时间序列单位。 表8 DimensionSeries 参数 参数类型 描述 name String 维度名称。 value String 维度取值。 表9 MetaDataSeries 参数 参数类型 描述 count Integer 当前返回结果条数。 offset Integer 下一个开始的标记，用于分页，null表示无更多数据。 total Integer 总条数。 nextToken Integer 偏移量。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 error_type String 错误类型。

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

URI POST /v2/{project_id}/series 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid，一般为32位字符串。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 用于限制本次返回的结果数据条数。 取值范围(0,1000]，默认值为1000。 offset 否 String 分页查询起始位置，为非负整数。

请求参数 表3 请求Body参数 参数 是否必选 参数类型 描述 series 是 Array of QuerySeriesOptionParam objects 通过该数组传递的参数信息进行时间序列查询。 表4 QuerySeriesOptionParam 参数 是否必选 参数类型 描述 namespace 是 String 时间序列命名空间。取值范围：PAAS.CONTAINER、PAAS.NODE、PAAS.SLA、PAAS.AGGR、CUSTOMMETRICS等。PAAS.CONTAINER：应用时间序列命名空间；PAAS.NODE：节点时间序列命名空间；PAAS.SLA：SLA时间序列命名空间；PAAS.AGGR：集群时间序列命名空间；CUSTOMMETRICS：自定义时间序列命名空间。 metric_name 否 String 时间序列名称，名称长度取值范围为1~255个字符。取值范围：AOM提供的基础时间序列名称，cpuUsage、cpuCoreUsed等：cpuUsage：cpu使用率；cpuCoreUsed：cpu内核占用；用户上报的自定义时间序列名称。 dimensions 否 Array of DimensionSeries objects 时间序列维度列表。可通过/v2/{project_id}/series接口中namespace+metric_name，查询当前监控的时间序列名称的时间序列维度列表。 表5 DimensionSeries 参数 是否必选 参数类型 描述 name 否 String 维度名称。 value 否 String 维度取值。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 meta_data MetaData object 查询结果元数据信息，包括分页信息等。 thresholds Array of QueryAlarmResult objects 阈值规则列表。 表4 MetaData 参数 参数类型 描述 count Integer 当前返回结果条数。 start String 下一个开始的标记，用于分页，null表示无更多数据。 total Integer 总条数。 表5 QueryAlarmResult 参数 参数类型 描述 action_enabled Boolean 是否启用通知。 alarm_actions Array of strings 告警状态通知列表。 alarm_advice String 告警清除建议。 alarm_description String 阈值规则描述。 alarm_level String 告警级别。 alarm_rule_id String 阈值规则ID。 alarm_rule_name String 阈值规则名称。 comparison_operator String 极限条件。 dimensions Array of Dimension objects 时间序列维度。 evaluation_periods Integer 间隔周期。 id_turn_on Boolean 阈值规则是否启用。 insufficient_data_actions Array of strings 数据不足通知列表。 metric_name String 时间序列名称。 namespace String 时间序列命名空间。 ok_actions Array of strings 正常状态通知列表。 period Integer 统计周期。 policy_name String 阈值规则模板名称。 resources Array of strings 资源信息(已废弃)。 state_reason String 原因描述。 state_updated_timestamp String 状态更新时间戳。 state_value String 服务状态。 statistic String 统计方式。 threshold String 临界值。 type String 阈值规则类型。 unit String 阈值单元。 表6 Dimension 参数 参数类型 描述 name String 维度名称。 value String 维度取值。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 error_type String 错误类型。 trace_id String 跟踪编号。主要用于开发人员快速搜索日志，定位问题。当返回的状态码为2xx时，trace_id为空；当返回4xx的状态码时，trace_id不为空。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 meta_data MetaData object 查询结果元数据信息，包括分页信息等。 thresholds Array of QueryAlarmResult objects 阈值规则查询参数。 表5 MetaData 参数 参数类型 描述 count Integer 当前返回结果条数。 start String 下一个开始的标记，用于分页，null表示无更多数据。 total Integer 总条数。 表6 QueryAlarmResult 参数 参数类型 描述 action_enabled Boolean 是否启用通知。 alarm_actions Array of strings 告警状态通知列表。 alarm_advice String 告警清除建议。 alarm_description String 阈值规则描述。 alarm_level String 告警级别。 alarm_rule_id String 阈值规则ID。 alarm_rule_name String 阈值规则名称。 comparison_operator String 极限条件。 dimensions Array of Dimension objects 时间序列维度。 evaluation_periods Integer 间隔周期。 id_turn_on Boolean 阈值规则是否启用。 insufficient_data_actions Array of strings 数据不足通知列表。 metric_name String 时间序列名称。 namespace String 时间序列命名空间。 ok_actions Array of strings 正常状态通知列表。 period Integer 统计周期。 policy_name String 阈值规则模板名称。 resources Array of strings 资源信息(已废弃)。 state_reason String 原因描述。 state_updated_timestamp String 状态更新时间戳。 state_value String 服务状态。 statistic String 统计方式。 threshold String 临界值。 type String 阈值规则类型。 unit String 阈值单元。 表7 Dimension 参数 参数类型 描述 name String 维度名称。 value String 维度取值。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 error_type String 错误类型。 trace_id String 跟踪编号。主要用于开发人员快速搜索日志，定位问题。当返回的状态码为2xx时，trace_id为空；当返回4xx的状态码时，trace_id不为空。

URI GET /v2/{project_id}/alarm-rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid，一般为32位字符串。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 分页信息。 limit 否 Integer 用于限制结果数据条数。 取值范围(0,1000]，默认值为1000。