华为云用户手册

响应消息 响应参数 响应参数如表3所示。 表3 响应参数 参数名称 类型 描述 errorCode String 响应码。 errorMessage String 响应信息描述。 alarmId Integer 阈值规则编码 响应示例 { "errorCode": "SVCSTG.AMS.2000", "errorMessage": "success", "alarmId": 12345678 }

响应消息 响应参数 响应参数如表3所示。 表3 响应参数 参数名称 类型 描述 errorCode String 响应码。 errorMessage String 响应信息描述。 alarmId Integer 阈值规则编码 响应示例 { "errorCode": "SVCSTG.AMS.2000", "errorMessage": "success", "alarmId": 12345678}

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

错误码 表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. 请联系技术支持工程师解决。

请求消息 请求参数 请求参数如表1所示。 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 project_id 是 String - 租户从IAM申请到的projectid，一般为32位字符串。 statistic 是 String "maximum"，"minimum"，"average"， "sum"，"sampleCount" 统计方式 namespace 是 String - 命名空间，此参数在后台将以添加阈值规则时传入的值保存，此处传入的值不能将其修改。 metricName 是 String 取值满足表达式[a-zA-Z_:][a-zA-Z0-9_:]*，即首字符为必须为字母_:，其他字符为字母数字_:，长度为1~255个字符。 指标名称，此参数在后台将以添加阈值规则时传入的值保存，此处传入的值不能将其修改。 period 是 Integer - 统计周期 alarmLevel 是 Integer - 告警级别 evaluationPeriods 是 Integer - 连续周期 comparisonOperator 是 String - 阈值条件表达式 threshold 是 String - 阈值 alarmName 是 String - 阈值名称 dimensions 是 String - 指标维度，此参数在后台将以添加阈值规则时传入的值保存，此处传入的值不能将其修改。 unit 是 String - 指标单位，此参数在后台将以添加阈值规则时传入的值保存，此处传入的值不能将其修改。 actionEnabled 否 Boolean - 告警是否启用 alarmActions 否 Array - 告警动作 alarmAdvice 否 String - 告警建议，请传入空字符串。 alarmDescription 否 String - 阈值规则描述 insufficientDataActions 否 Array - 数据不足动作 okActions 否 Array - 恢复动作 Header说明 请求消息头（Header）如表2所示。 表2 Header说明 名称 是否必选 说明 X-Auth-Token 是 从IAM服务获取的用户Token。 Content-Type 是 指定类型为application/json。

请求消息 请求消息头 请求消息头如表2所示。 表2 请求消息头 参数 描述 是否为必选 示例 ResourceType 资源类型 必选 默认为app，app表示给应用查询策略组属性 Content-Type 内容类型。 该字段内容填为“application/json;charset=utf-8”。 必选 application/json;charset=utf-8 Cluster-Id 集群ID 必选 - Namespace 命名空间 必选 - Deployment-Name 应用名称 必选 -

响应消息 响应参数 响应参数如表3所示。 表3 响应参数 参数名称 参数类型 描述 errorCode String 错误码 errorMessage String 详细信息 config 参见表4 策略组属性集合 表4 config数据结构说明 参数名称 参数类型 描述 id String 策略组属性ID max_instances Integer 最大实例个数 min_instances Integer 最小实例个数 cooldown_time Integer 冷却时间，单位：秒 响应示例 { "errorCode": "SVCSTG.PE.0", "errorMessage": "", "config": { "id":"f9c7f57e-b1dc-4ef0-a009-ff2848776803", "max_instances": 100,//最大实例数，表示扩容最大限制 "min_instances": 1,//最小实例数，表示扩容最小限制 "cooldown_time": 60//冷却时间，应用的策略执行完后必须冷却该时间后才能继续执行下条策略 }}

响应消息 响应参数 响应参数如表2所示。 表2 响应参数 参数名称 类型 描述 errorCode String 错误码 errorMessage String 详细信息 policy 参见表3 修改后的策略详细信息 表3 policy数据结构说明 参数名称 参数类型 描述 id String 策略ID name String 策略名称 policy_type String 策略类型 rule 参见表4 触发策略的规则 create_time String 创建时间 update_time String 更新时间 status String 状态 表4 rule字段数据结构说明 参数名称 参数类型 描述 name string 策略名称 conditions 参见表5 匹配条件具体内容。 actions 参见表6 指定策略匹配成功后执行的动作。 表5 conditions字段数据结构说明 参数名称 参数类型 描述 metric_namespace String 命名空间 metric_name String 指标名称 metric_unit String 单位 period Integer 统计周期，单位：秒 evaluation_periods Integer 连续周期数 statistic String 统计方式 metric_operation String 指标操作符 metric_threshold Float 阈值条件 表6 actions字段数据结构说明 参数名称 参数类型 描述 type String 扩缩容：含有k8s的表示容器应用，含有vm的表示进程应用 parameters 参见表7 包含扩缩容的实例数 表7 parameters字段数据结构说明 参数名称 参数类型 描述 scale_unit Integer 扩缩容实例数 响应示例 { "errorCode" : "SVCSTG.PE.0", "errorMessage" : "", "policy" : { "id" : "8accffb6-e0ed-4433-b216-ccf6960eb1ad", "name" : "alarm", "group_id" : "77c37e1f-aa0c-438d-8445-39b3997786a2", "policy_type" : "ALARM", "rule" : { "name" : "", "conditions" : [{ "metric_namespace" : "PAAS.CONTAINER", "metric_name" : "cpuCoreLimit", "metric_unit" : "Percent", "period" : 60, "evaluation_periods" : 1, "statistic" : "average", "metric_operation" : "\u003e", "metric_threshold" : 100, "metric_dimensions" : null } ], "actions" : [{ "type" : "scale_out_k8s", "parameters" : { "scale_unit" : 1 } } ] }, "create_time" : "2017-12-21T09:13:42Z", "update_time" : "2017-12-21T09:13:42Z", "status" : "enabled" }}

错误码 表9 错误码 错误码 错误信息 处理措施 SVCSTG.PE.4001101 Invalid parameter. 请检查对应的参数是否符合要求。 SVCSTG.PE.4031012 Failed to verify the project ID. 请检查对应的参数是否符合要求。 SVCSTG.PE.4033008 Failed to update the scheduled or periodic policy. 请检查对应的参数是否符合要求。 SVCSTG.PE.5001201 Failed to insert or update data in the background. 请联系技术支持工程师解决。 SVCSTG.PE.5001203 Query error. 请联系技术支持工程师解决。 SVCSTG.PE.5003007 Failed to update the threshold rule. 请联系技术支持工程师解决。

错误码 表5 错误码 错误码 错误信息 处理措施 SVCSTG.PE.4001101 Invalid parameter. 请检查对应的参数是否符合要求。 SVCSTG.PE.4031012 Failed to verify the project ID. 请检查对应的参数是否符合要求。 SVCSTG.PE.5001201 Failed to insert or update data in the background. 请联系技术支持工程师解决。 SVCSTG.PE.5001203 Query error. 请联系技术支持工程师解决。

请求消息 请求消息头 请求消息头如表2所示。 表2 请求消息头 参数 描述 是否为必选 示例 ResourceType 资源类型 必选 默认值为app，app表示给应用修改策略组属性 Cluster-Id 集群ID 必选 - Namespace 命名空间 必选 - Deployment-Name 应用名称 必选 - 请求参数 请求参数如表3所示。 表3 请求参数 参数名称 参数类型 描述 max_instances Integer 最大实例个数 min_instances Integer 最小实例个数 cooldown_time Integer 冷却时间，单位：秒 deployment_name String 微服务名称 cluster_id String 集群ID namespace String 命名空间 请求示例 { "max_instances": 100,//最大实例数，表示扩容最大限制 "min_instances": 1,//最小实例数，表示扩容最小限制 "cooldown_time": 60 //冷却时间，应用的策略执行完后必须冷却该时间后才能继续执行下条策略}

错误码 表8 错误码 错误码 错误信息 处理措施 SVCSTG.PE.4001101 Invalid parameter. 请检查对应的参数是否符合要求。 SVCSTG.PE.4031012 Failed to verify the project ID. 请检查对应的参数是否符合要求。 SVCSTG.PE.5001201 Failed to insert or update data in the background. 请联系技术支持工程师解决。

响应消息 响应参数 响应参数如表7所示。 表7 响应参数 参数名称 参数类型 描述 errorCode String 错误码 errorMessage String 详细信息 policy_id String 策略ID 响应示例 { "errorCode": 0, "errorMessage": "", "policy_id": "1b9994f0-847a-45e4-aeee-e8b604dddb34" }

响应消息 响应参数 响应参数如表2所示。 表2 响应参数 参数名称 类型 描述 errorCode String 错误码 errorMessage String 详细信息 policy 参见表3 修改后的策略详细信息 表3 policy数据结构说明 参数名称 参数类型 描述 id String 策略ID。 name String 策略名称。 policy_type String 策略类型。 rule 参见表4 触发策略的规则 create_time String 创建时间 update_time String 更新时间 status String 状态 表4 rule字段数据结构说明 参数名称 参数类型 描述 name String 策略名称。 conditions 参见表5 匹配条件具体内容。 actions 参见表6 指定策略匹配成功后执行的动作。 表5 conditions字段数据结构说明 参数名称 参数类型 描述 metric_namespace String 命名空间 metric_name String 指标名称 metric_unit String 单位 period Integer 统计周期，单位：秒 evaluation_periods Integer 连续周期数 statistic String 统计方式 metric_operation String 指标操作符 metric_threshold Float 阈值条件 表6 actions字段数据结构说明 参数名称 参数类型 描述 type String 扩缩容：含有k8s的表示容器应用，含有vm的表示进程应用 parameters 参见表7 包含扩缩容的实例数 表7 parameters字段数据结构说明 参数名称 参数类型 描述 scale_unit Integer 扩缩容实例数 响应示例 { "errorCode" : "SVCSTG.PE.0", "errorMessage" : "", "policies" : [{ "id" : "8accffb6-e0ed-4433-b216-ccf6960eb1ad", "name" : "alarm", "group_id" : "77c37e1f-aa0c-438d-8445-39b3997786a2", "policy_type" : "ALARM", "rule" : { "name" : "", "conditions" : [{ "metric_namespace" : "PAAS.CONTAINER", "metric_name" : "cpuCoreLimit", "metric_unit" : "Percent", "period" : 60, "evaluation_periods" : 1, "statistic" : "average", "metric_operation" : "\u003e", "metric_threshold" : 100, "metric_dimensions" : null } ], "actions" : [{ "type" : "scale_out_k8s", "parameters" : { "scale_unit" : 1 } } ] }, "create_time" : "2017-12-21T09:13:42Z", "update_time" : "2017-12-21T09:13:42Z", "status" : "enabled" }, { "id" : "9aafbd3d-eac4-4a92-a342-5b6f8d60fff2", "name" : "dingshi2", "group_id" : "77c37e1f-aa0c-438d-8445-39b3997786a2", "policy_type" : "SCHEDULED", "rule" : { "name" : "", "conditions" : [{ "launch_time" : "2017-12-22T06:30Z", "recurrence_type" : "", "recurrence_value" : "", "start_time" : "", "end_time" : "" } ], "actions" : [{ "type" : "scale_set_k8s", "parameters" : { "scale_unit" : 1 } } ] }, "create_time" : "2017-12-21T09:14:00Z", "update_time" : "2017-12-21T09:14:00Z", "status" : "enabled" } ]}

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://Endpoint/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

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不同，使用时请注意。

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xx-xxxxxx-1",...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "errorCode": "SVCSTG_AMS_4000001", "errorMessage": "Request param invalid" } 其中，errorCode表示错误码，errorMessage表示错误信息。

概述 欢迎使用应用运维管理服务（Application Operations Management，简称AOM）。应用运维管理（Application Operations Management，简称AOM）是云上应用的一站式立体化运维管理平台，提供一站式可观测性分析和自动化运维方案，支持快速从云端、本地采集指标、日志和性能数据，帮助用户及时发现故障，全面掌握应用、资源及业务的实时运行状况，提升企业海量运维的自动化能力和效率。 您可以使用本文档提供的API对应用运维管理服务进行相关操作，例如创建、删除、查询等。支持的全部操作请参见API概览。 在调用应用运维管理服务API之前，请确保已经充分了解应用运维管理服务相关概念。 父主题： 使用前必读

自动化运维 “√”表示支持，“x”表示暂不支持。 表1 自动化运维 权限 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 创建任务 POST /v1/{project_id}/cms/workflow cms:workflow:create √ × 更新任务 PUT /v1/{project_id}/cms/workflow/{workflow_id}/trigger/action cms:workflow:update √ × 对暂停中的任务进行操作 POST /v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/operation cms:execution:create √ × 获取工作流执行中的执行详情 GET /v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/status cms:execution:get √ × 终止任务执行 POST /v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/terminate cms:execution:create √ × 脚本查询 POST /v1/{project_id}/cms/script/list cms:script:list √ × 脚本版本查询 POST /v1/{project_id}/cms/script-version-list cms:script:list √ × 作业管理主页模糊查询 POST /v1/{project_id}/cms/job/list cms:job:list √ × 根据作业id查询方案(自定义模板)列表 POST /v1/{project_id}/cms/template-list/{job_id} cms:template:list √ × 获取方案信息 GET /v1/{project_id}/cms/template/{template_id} cms:template:get √ × 查询任务列表 POST /v1/{project_id}/cms/workflow-list cms:workflow:list √ × 获取任务执行历史 GET /v1/{project_id}/cms/workflow/{workflow_id}/executions cms:execution:get √ × 执行工作流 POST /v1/{project_id}/cms/workflow/{workflow_id}/executions cms:execution:create √ × 父主题： 权限策略和授权项

告警 “√”表示支持，“x”表示暂不支持。 表1 告警 权限 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 新增一条事件类告警规则 POST /v2/{project_id}/event2alarm-rule aom:event2AlarmRule:create √ × 查询事件类告警规则列表 GET /v2/{project_id}/event2alarm-rule aom:event2AlarmRule:list √ × 更新事件类告警规则 PUT /v2/{project_id}/event2alarm-rule aom:event2AlarmRule:set √ × 删除事件类告警规则 DELETE /v2/{project_id}/event2alarm-rule aom:event2AlarmRule:delete √ × 获取告警发送结果 GET /v2/{project_id}/alarm-notified-histories aom:alarm:list √ × 删除静默规则 DELETE /v2/{project_id}/alert/mute-rules aom:muteRule:delete √ √ 新增静默规则 POST /v2/{project_id}/alert/mute-rules aom:muteRule:create √ √ 修改静默规则 PUT /v2/{project_id}/alert/mute-rules aom:muteRule:update √ √ 获取静默规则列表 GET /v2/{project_id}/alert/mute-rules aom:muteRule:list √ √ 通过规则名称获取告警行动规则 GET /v2/{project_id}/alert/action-rules/{rule_name} aom:actionRule:get √ √ 新增告警行动规则 POST /v2/{project_id}/alert/action-rules aom:actionRule:create √ √ 删除告警行动规则 DELETE /v2/{project_id}/alert/action-rules aom:actionRule:delete √ √ 修改告警行动规则 PUT /v2/{project_id}/alert/action-rules aom:actionRule:update √ √ 获取告警行动规则列表 GET /v2/{project_id}/alert/action-rules aom:actionRule:list √ √ 查询事件告警信息 POST /v2/{project_id}/events aom:alarm:list √ × 统计事件告警信息 POST /v2/{project_id}/events/statistic aom:alarm:list √ × 上报事件告警信息 PUT /v2/{project_id}/push/events aom:alarm:put √ × 父主题： 权限策略和授权项

应用资源管理 “√”表示支持，“x”表示暂不支持。 表1 应用资源管理 权限 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 新增应用 POST /v1/applications aom:cmdbApplication:create √ × 删除应用 DELETE /v1/applications/{application_id} aom:cmdbApplication:delete √ × 查询应用详情 GET /v1/applications/{application_id} aom:cmdbApplication:get √ × 修改应用 PUT /v1/applications/{application_id} aom:cmdbApplication:update √ × 新增组件 POST /v1/components aom:cmdbComponent:create √ × 删除组件 DELETE /v1/components/{component_id} aom:cmdbComponent:delete √ × 查询组件详情 GET /v1/components/{component_id} aom:cmdbComponent:get √ × 修改组件 PUT /v1/components/{component_id} aom:cmdbComponent:update √ × 创建环境 POST /v1/environments aom:cmdbEnvironment:create √ × 删除环境 DELETE /v1/environments/{environment_id} aom:cmdbEnvironment:delete √ × 查询环境详情 GET /v1/environments/{environment_id} aom:cmdbEnvironment:get √ × 修改环境 PUT /v1/environments/{environment_id} aom:cmdbEnvironment:update √ × 查询绑定在节点上的资源列表 POST /v1/resource/{rf_resource_type}/type/{type}/ci-relationships aom:cmdbResources:list √ × 查询应用详情 GET /v1/applications aom:cmdbApplication:get √ × 查询环境详情 GET /v1/environments/name/{environment_name} aom:cmdbEnvironment:get √ × 查询组件详情 GET /v1/components/application/{application_id}/name/{component_name} aom:cmdbComponent:get √ × 父主题： 权限策略和授权项

监控 “√”表示支持，“x”表示暂不支持。 表1 监控 权限 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 查询时间序列 POST /v2/{project_id}/series aom:metric:list √ × 查询时序数据 POST /v2/{project_id}/samples aom:metric:list √ × 查询指标 POST /v1/{project_id}/ams/metrics aom:metric:get √ × 查询监控数据 POST /v1/{project_id}/ams/metricdata aom:metric:get √ × 添加或修改服务发现规则 PUT /v1/{project_id}/inv/servicediscoveryrules aom:discoveryRule:set √ × 删除服务发现规则 DELETE /v1/{project_id}/inv/servicediscoveryrules aom:discoveryRule:delete √ × 查询系统中已有服务发现规则 GET /v1/{project_id}/inv/servicediscoveryrules aom:discoveryRule:list √ × 添加阈值规则 POST /v2/{project_id}/alarm-rules aom:alarmRule:create √ × 查询阈值规则列表 GET /v2/{project_id}/alarm-rules aom:alarmRule:get √ × 修改阈值规则 PUT /v2/{project_id}/alarm-rules aom:alarmRule:set √ × 删除阈值规则 DELETE /v2/{project_id}/alarm-rules/{alarm_rule_id} aom:alarmRule:delete √ × 查询单条阈值规则 GET /v2/{project_id}/alarm-rules/{alarm_rule_id} aom:alarmRule:get √ × 批量删除阈值规则 POST /v2/{project_id}/alarm-rules/delete aom:alarmRule:delete √ × 父主题： 权限策略和授权项

prometheus监控 “√”表示支持，“x”表示暂不支持。 表1 prometheus监控 权限 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 区间数据查询 GET /v1/{project_id}/aom/api/v1/query_range aom:metric:list √ √ 区间数据查询 POST /v1/{project_id}/aom/api/v1/query_range aom:metric:list √ √ 瞬时数据查询 GET /v1/{project_id}/aom/api/v1/query aom:metric:list √ √ 瞬时数据查询 POST /v1/{project_id}/aom/api/v1/query aom:metric:list √ √ 查询标签值 GET /v1/{project_id}/aom/api/v1/label/{label_name}/values aom:metric:list √ √ 获取标签名列表 GET /v1/{project_id}/aom/api/v1/labels aom:metric:list √ √ 获取标签名列表 POST /v1/{project_id}/aom/api/v1/labels aom:metric:list √ √ 元数据查询 GET /v1/{project_id}/aom/api/v1/metadata aom:metric:list √ √ 父主题： 权限策略和授权项

修订记录 表1 修订记录 发布日期 修订记录 2023-05-30 新增以下接口： 告警相关接口 应用资源管理相关接口 自动化运维相关接口 2023-02-20 优化错误码页面的描述。 2021-06-04 新增以下接口： 查询事件告警信息 统计事件告警信息 上报事件告警信息 2020-08-11 不再展示APM相关的接口，APM接口请参考APM帮助中心。 2019-09-26 查询日志接口支持分页查询。 增加调用API获取项目ID。 2018-12-4 新增添加或修改服务发现规则、查询系统中已有服务发现规则和删除服务发现规则接口。 2018-09-13 新增权限策略和授权项，支持细粒度授权功能。 2018-06-28 第一次正式发布。

公共请求消息头 表1 公共请求消息头 名称 描述 是否必选 示例 X-Auth-Token 用户Token。 使用Token认证时必选 - Content-Type 内容类型。 该字段内容填为“application/json;charset=utf8”。 必选 application/json;charset=utf8 x-sdk-date 请求的发生时间 格式为(YYYYMMDD'T'HHMMSS'Z')。取值为当前系统的GMT时间 使用AK/SK认证时必选 20160629T101459Z Authorization 签名认证信息 该值来源于请求签名结果。 使用AK/SK认证时必选 - Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443 使用AK/SK认证时必选 - 父主题： 附录

公共响应消息头 响应的消息报头在大多数情况下含有下面报头： 表1 响应消息头 名称 描述 示例 Date HTTP协议标准报头。表示消息发送的时间，时间的描述格式由rfc822定义。 Mon，12 Nov 2007 15:55:01 GMT Server HTTP协议标准报头。包含了服务器用来处理请求的软件信息。 Apache Content-Length HTTP协议标准报头。用于指明实体正文的长度，以字节方式存储的十进制数字来表示。 xxx Content-Type HTTP协议标准报头。用于指明发送给接收者的实体正文的媒体类型。 application/json 父主题： 附录

状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 200 OK 请求响应成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Long 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 execution_id String 工作流执行id。 最小长度：1 最大长度：64 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度：1 最大长度：64 error_msg String 调用失败响应信息描述。 最小长度：1 最大长度：1024 http_code Integer http返回码 最小值：0 最大值：999 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度：1 最大长度：64 error_msg String 调用失败响应信息描述。 最小长度：1 最大长度：1024 http_code Integer http返回码 最小值：0 最大值：999

请求示例 快速执行脚本可指定脚本类型、执行用户、名称为 name的脚本、脚本参数 script_args，指定的执行机器列表 ecs_id_list来快速下发脚本在对应的机器上。 https://{Endpoint}/v1/{project_id}/cms/fast-execute-script{ "script_type" : "SHELL", "cmd_user" : "root", "name" : "12avvvs", "script_args" : "arg1 arg2", "ecs_id_list" : "[\"a6c58afe6d4b4017b12e8205159f1045\",\"608856d0e88a444ca4a6e2afa9120685\"]", "script_content" : "cd / && ls", "project_id" : "2axxx75bxxxx"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 最小长度：1 最大长度：40960 Content-Type 是 String 指定类型为application/json。 最小长度：1 最大长度：32 表3 请求Body参数 参数 是否必选 参数类型 描述 script_type 是 String 脚本类型。SHELL BAT PYTHON POWER_SHELL 最小长度：1 最大长度：20 cmd_user 是 String 执行脚本的ECS机器用户。 最小长度：1 最大长度：1024 script_content 是 String 脚本内容。 最小长度：1 最大长度：10000 ecs_id_list 是 String 执行的机器列表。 最小长度：1 最大长度：10000 name 是 String 任务名称。 最小长度：1 最大长度：1024 project_id 是 String 项目ID。 最小长度：32 最大长度：32 script_args 否 String 任务参数，多个参数以空格分隔。 最小长度：1 最大长度：10000