华为云用户手册

  • 状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 422 Unprocessable 表达式无法执行。 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。
  • URI GET /v1/{project_id}/aom/api/v1/query_range 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串。 表2 Query参数 参数 是否必选 参数类型 描述 query 是 String PromQL表达式(参考https://prometheus.io/docs/prometheus/latest/querying/basics/)。 start 是 String 起始时间戳(Unix时间戳格式,单位:秒)。 end 是 String 结束时间戳(Unix时间戳格式,单位:秒)。 step 是 String 查询时间步长,时间区内每step秒执行一次。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 status String 响应状态。 data Object 响应数据。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 status String 响应状态。 errorType String 错误类型。 error String 错误信息。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 status String 响应状态。 errorType String 错误类型。 error String 错误信息。 状态码: 422 表7 响应Body参数 参数 参数类型 描述 status String 响应状态。 errorType String 错误类型。 error String 错误信息。 状态码: 503 表8 响应Body参数 参数 参数类型 描述 status String 响应状态。 errorType String 错误类型。 error String 错误信息。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 对象id 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String AOM.30005001 error_msg String 参数错误 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String AOM.30001005 error_msg String 没有权限
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 Content-Type 是 String 指定类型为application/json,有Body体的情况下必选,没有Body体则无需填写和校验。 表2 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 组件描述 model_id 是 String 应用Id、子应用Id,id长度不能超过36位,由大小写字母、数字组成 model_type 是 String 应用、子应用,取值:APPLICATION、SUB_APPLICATION ,不区分大小写 name 是 String 组件名称
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 aom_id String aomId app_id String 应用id create_time String 创建时间 creator String 创建者 description String 描述 id String 组件Id modified_time String 修改时间 modifier String 修改者 name String 组件名称 register_type String 注册方式 枚举值: API CONSOLE SERVICE_DISCOVERY sub_app_id String 子应用id 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String AOM.30005001 error_msg String 参数错误 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String AOM.30001005 error_msg String 没有权限
  • 响应示例 状态码: 200 组件详情信息 { "creator" : "xxx", "modifier" : "xxx", "name" : "component1", "description" : null, "create_time" : "2023-02-03 10:47:38", "modified_time" : "2023-02-03 10:47:38", "register_type" : "API", "id" : "28c600be47374b9697404b0f58263d1c", "app_id" : "9616a75c75af4bcdacf38d77ff72a88e", "aom_id" : null, "sub_app_id" : null }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 alarm_rule_id Long 阈值规则id。 状态码: 400 表6 响应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 OK 请求响应成功。 { "alarm_rule_id" : 1134050083814244400 } 状态码: 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.04001001", "error_msg" : "please check request param", "error_type" : "BAD_REQUEST" }
  • 响应示例 状态码: 200 请求响应成功,返回脚本基本信息列表。 { "elements" : [ { "approve_info" : { "need_approve" : false }, "create_by" : "chenkaiyuan", "create_time" : 1600076223389, "description" : "fassfa", "enterprise_project_id" : "0", "id" : "xxxxxxxxxxxxxxxxxxx", "name" : "awffawsafws", "online_exist_status" : false, "project_id" : "xxxxxxxxxxxxxxxxxxx", "rate_control" : { "have_rate_control" : false, "max" : 0, "time_delay" : 0 }, "script_language" : "SHELL", "update_by" : "xxxx", "update_time" : 1600076223389 } ], "total_elements" : 1 } 状态码: 400 BadRequest。非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.31002002", "error_message" : "Invalid script parameter.", "http_code" : 400 } 状态码: 401 Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "AOM.31009011", "error_msg" : "auth failed.", "http_code" : 401 } 状态码: 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 { "error_code" : "AOM.31002005", "error_msg" : "script internal server error.", "http_code" : 500 }
  • 请求示例 获取指定名称为“xxx”,排序为"DESC"的脚本列表。 https://{endpoint}/v1/{project_id}/cms/script/list { "name" : "xxx", "create_by" : "user1", "enterprise_project_id" : "", "page_num" : 1, "page_size" : 10, "is_default" : "default", "order_by_column" : "create_time", "sort_order" : "DESC", "script_id" : "" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 最小长度:1 最大长度:40960 Content-Type 是 String 指定类型为application/json。 最小长度:1 最大长度:32 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 查询接收的参数,版本管理时,name为脚本名称(版本管理查询时name不能为空),脚本管理页面查询时,name为接收模糊查询的参数,name是null,表示查询所有默认脚本。 最小长度:0 最大长度:128 is_default 否 String 查询规则,如果是类型为default,则为模糊查询和脚本管理主页展示,no_default为版本管理。 最小长度:0 最大长度:16 create_by 否 String 创建人,默认按照创建人搜索脚本。 最小长度:1 最大长度:64 script_id 是 String 版本管理时需要查询的脚本id。 最小长度:1 最大长度:64 page_num 否 Integer page_num为正整数。 最小值:1 最大值:100 page_size 否 Integer 每页显示的条数,默认值是10。 最小值:1 最大值:1000 project_id 否 String 项目id。 最小长度:32 最大长度:32 order_by_column 是 String 需要排序的字段(默认为更新时间),支持字段有name,create_time和update_time。 最小长度:1 最大长度:16 sort_order 是 String 排序规则(默认降序) 传入升序或降序,升序:ASC,降序:DESC。 最小长度:1 最大长度:16 enterprise_project_id 否 String 企业项目id,根据企业项目id搜索。 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 elements Array of Script objects 查询结果集合。 数组长度:0 - 9999999 total_elements Integer 查询到的结果数量。 最小值:0 最大值:99999999 表5 Script 参数 参数类型 描述 approve_info ApproveInfo object 审批信息 create_by String 创建人,比如为:张三 最小长度:1 最大长度:64 create_time Long 创建时间 最小值:0 最大值:9999999999999 description String 脚本描述,脚本描述,对脚本进行描述,最大长度为1000 最小长度:0 最大长度:1000 enterprise_project_id String 企业项目id 最小长度:1 最大长度:64 id String 脚本id,根据UUID.randomUUID生成。 最小长度:1 最大长度:64 name String 脚本名称,支持数字,下划线,大小写字母 ,中文 最小长度:1 最大长度:64 online_exist_status Boolean 脚本中是否有已上线的版本,true表示有已上线的版本,false表示没有已上线的版本 online_id String 已上线版本id 最小长度:1 最大长度:64 project_id String 租户从IAM申请到的projectid,一般为32位字符串 最小长度:32 最大长度:32 rate_control RateControl object 执行策略 script_language String 脚本语言,目前支持四种,分别是:SHELL BAT PYTHON POWER_SHELL 最小长度:1 最大长度:16 update_by String 修改人 最小长度:1 最大长度:64 update_time Long 实体的最后更新时间戳。 注意:执行创建/修改/删除操作时,update_time将更新。 最小值:0 最大值:9999999999999 表6 ApproveInfo 参数 参数类型 描述 topic_selected String 审批人主题选择。 最小长度:1 最大长度:2048 need_approve Boolean 是否审核,默认是不审核,true,false。 smn_urn_list String 审批主题urn集合。 最小长度:1 最大长度:2048 表7 RateControl 参数 参数类型 描述 have_rate_control Boolean 是否分批发布,默认值是false。 time_delay Integer 每批间隔。 最小值:1 最大值:60 max Integer 每批支持的最大实例数。 最小值:0 最大值:100 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:32 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer Http返回码 最小值:1 最大值:999 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:32 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer Http返回码 最小值:1 最大值:999 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:32 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer Http返回码 最小值:1 最大值:999
  • 状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
  • 响应示例 状态码: 200 OK 请求响应成功。 [ { "create_time" : 1668147671966, "desc" : "", "match" : [ [ { "key" : "event_severity", "operate" : "EQUALS", "value" : [ "Info" ] } ] ], "mute_config" : { "ends_at" : 86399, "scope" : [ ], "starts_at" : 0, "type" : "DAILY" }, "name" : "32255", "timezone" : "xxx", "update_time" : 1668147671966, "user_id" : "2a473356cca5487f8373be891bffc1cf" } ] 状态码: 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.08005001", "error_msg" : "bad request", "trace_id" : "" } 状态码: 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "SVCSTG.AMS.2000051", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED" } 状态码: 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED" } 状态码: 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 { "error_code" : "AOM.08005500", "error_msg" : "SC_INTERNAL_SERVER_ERROR", "trace_id" : "" }
  • 状态码 状态码 描述 204 OK 添加成功 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
  • 响应示例 状态码: 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.08002001", "error_msg" : "bad request", "trace_id" : "" } 状态码: 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "SVCSTG.AMS.2000051", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED" } 状态码: 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED" } 状态码: 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 { "error_code" : "AOM.08002500", "error_msg" : "SC_INTERNAL_SERVER_ERROR", "trace_id" : "" }
  • 响应参数 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:13 最大长度:13 error_msg String 响应信息描述。 最小长度:1 最大长度:100 trace_id String 响应id。 最小长度:12 最大长度:12 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:0 最大长度:1024 error_type String 错误类型 最小长度:0 最大长度:128 trace_id String 请求id 最小长度:32 最大长度:32 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:0 最大长度:1024 error_type String 错误类型 最小长度:0 最大长度:128 trace_id String 请求id 最小长度:32 最大长度:32 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:13 最大长度:13 error_msg String 响应信息描述。 最小长度:1 最大长度:100 trace_id String 响应id。 最小长度:12 最大长度:12
  • 请求示例 新增一条名称为"32255",用户id为"2xxxxxxxxxxxxxxxxxxxxxxxxxcf"的静默规则 https://{Endpoint}/v2/{project_id}/alert/mute-rules { "create_time" : 1668147671966, "desc" : "", "match" : [ [ { "key" : "event_severity", "operate" : "EQUALS", "value" : [ "Info" ] } ] ], "mute_config" : { "ends_at" : 86399, "scope" : [ ], "starts_at" : 0, "type" : "DAILY" }, "name" : "32255", "timezone" : "xxx", "update_time" : 1668147671966, "user_id" : "2xxxxxxxxxxxxxxxxxxxxxxxxxcf" }
  • 请求示例 查询指标名称"aom_process_cpu_usage"且所属命名空间为"PAAS.CONTAINER"的指标在最近5分钟的监控数据。 https://{Endpoint}/v1/{project_id}/ams/metricdata { "metrics" : [ { "dimensions" : [ { "name" : "appName", "value" : "aomApp" } ], "metricName" : "aom_process_cpu_usage", "namespace" : "PAAS.CONTAINER" } ], "period" : 60, "statistics" : [ "maximum", "minimum", "sum" ], "timerange" : "-1.-1.5" }
  • 状态码 状态码 描述 200 OK 请求执行完成。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。
  • 响应示例 状态码: 200 OK 请求执行完成。 { "errorCode" : "SVCSTG.AMS.2000", "errorMessage" : "success", "metrics" : [ { "metric" : { "namespace" : "PAAS.CONTAINER", "metricName" : "aom_process_cpu_usage", "dimensions" : [ { "name" : "appName", "value" : "aomApp" } ] }, "dataPoints" : [ { "timestamp" : "1467892800000", "unit" : "Percent", "statistics" : [ { "statistic" : "maximum", "value" : "23" } ] } ] } ] }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 errorCode String 响应码。 errorMessage String 响应信息描述。 metrics Array of MetricDataValue objects 指标对象列表。 表8 MetricDataValue 参数 参数类型 描述 dataPoints Array of MetricDataPoints objects 重点指标。 metric MetricQueryMeritcParam object 查询参数集 表9 MetricDataPoints 参数 参数类型 描述 statistics Array of StatisticValue objects 统计方式。 timestamp Long 时间戳。 unit String 时间序列单位。 表10 StatisticValue 参数 参数类型 描述 statistic String 统计方式。 value Double 统计结果。 表11 MetricQueryMeritcParam 参数 参数类型 描述 dimensions Array of Dimension objects 指标维度列表。取值范围:数组不能为空,同时数组中任何一个dimension对象name和value属性的值也不能为空。 metricName String 指标名称。名称长度取值范围为1~255个字符。取值范围:AOM提供的基础指标,cpuUsage、cpuCoreUsed等cpuUsage:cpu使用率;cpuCoreUsed:cpu内核占用;用户上报的自定义指标名称。 namespace String 指标命名空间。取值范围:PAAS.CONTAINER:组件指标、实例指标、进程指标和容器指标的命名空间,PAAS.NODE: 主机指标、网络指标、磁盘指标和文件系统指标的命名空间,PAAS.SLA:SLA指标的命名空间,PAAS.AGGR:集群指标的命名空间,CUSTOMMETRICS:默认的自定义指标的命名空间。 表12 Dimension 参数 参数类型 描述 name String 维度名称。 value String 维度取值。
  • URI POST /v1/{project_id}/ams/metricdata 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串。 表2 Query参数 参数 是否必选 参数类型 描述 fillValue 否 String 用于对查询到的监控数据进行断点插值,默认值为-1。 -1:断点处使用-1进行表示。 0 :断点处使用0进行表示。 null:断点处使用null进行表示。 average:断点处使用前后邻近的有效数据的平均值进行表示,如果不存在有效数据则使用null进行表示。 缺省值:-1 枚举值: -1 0 null average
  • 错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 200 SVCSTG.INV.2000000 null 请求正常执行 请求执行完成无需处理。 300 AOM.08001300 The maximum number of rules has been reached. 当前创建规则条数已达到最大值 请删除规则条数后再添加。 400 AOM.02001101 Invalid rule name. 阈值规则名称不合法 请检查对应的参数是否符合要求。 400 AOM.02001102 The rule name already exists. 阈值规则名称已存在 请检查对应的参数是否符合要求。 400 AOM.02001103 Invalid description. 描述不合法 请检查对应的参数是否符合要求。 400 AOM.02001104 Invalid threshold. 告警阈值不合法 请检查对应的参数是否符合要求。 400 AOM.02001105 Invalid period. 告警周期不合法 请检查对应的参数是否符合要求。 400 AOM.02001106 Invalid email. 邮件格式错误 请检查对应的参数是否符合要求。 400 AOM.02001107 The maximum number of rules has been reached. 当前创建的阈值规则条数已达到最大值 请检查对应的参数是否符合要求。 400 AOM.02001108 Invalid time range. 时间段不合法 请检查对应的参数是否符合要求。 400 AOM.02001109 Threshold [xxx] is not exist 阈值规则xxx不存在 请检查对应的参数是否符合要求。 400 AOM.02001110 Invalid limit. limit参数不合法 请检查对应的参数是否符合要求。 400 AOM.02001111 Invalid offset. offset参数不合法 请检查对应的参数是否符合要求。 400 AOM.02001112 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02001115 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02001118 Invalid number of consecutive periods. 连续周期不合法 请检查对应的参数是否符合要求。 400 AOM.02001119 Invalid statistic. 统计方式参数不合法 请检查对应的参数是否符合要求。 400 AOM.02001120 Invalid comparison operator. 操作符不合法 请检查对应的参数是否符合要求。 400 AOM.02001121 The rule does not exist. 阈值规则不存在 请检查对应的参数是否符合要求。 400 AOM.02001400 Bad request. 请求错误 请检查对应的参数是否符合要求。 400 AOM.02002101 Invalid rule. 阈值规则不合法 请检查对应的参数是否符合要求。 400 AOM.02002102 The rule name already exists. 阈值规则名称已存在 请检查对应的参数是否符合要求。 400 AOM.02002103 Invalid description. 描述不合法 请检查对应的参数是否符合要求。 400 AOM.02002104 Invalid threshold. 告警阈值不合法 请检查对应的参数是否符合要求。 400 AOM.02002105 Invalid period. 告警周期不合法 请检查对应的参数是否符合要求。 400 AOM.02002106 Invalid email. 邮件格式错误 请检查对应的参数是否符合要求。 400 AOM.02002107 The maximum number of rules has been reached. 当前创建的阈值规则条数已达到最大值 请检查对应的参数是否符合要求。 400 AOM.02002108 Invalid time range. 时间段不合法 请检查对应的参数是否符合要求。 400 AOM.02002109 Invalid project ID. 项目ID无效 请检查对应的参数是否符合要求。 400 AOM.02002110 Invalid limit. limit参数不合法 请检查对应的参数是否符合要求。 400 AOM.02002111 Invalid offset. offset参数不合法 请检查对应的参数是否符合要求。 400 AOM.02002112 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02002115 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02002118 Invalid number of consecutive periods. 连续周期不合法 请检查对应的参数是否符合要求。 400 AOM.02002119 Invalid statistic. 统计方式参数不合法 请检查对应的参数是否符合要求。 400 AOM.02002120 Invalid comparison operator. 操作符不合法 请检查对应的参数是否符合要求。 400 AOM.02002121 The rule does not exist. 阈值规则不存在 请检查对应的参数是否符合要求。 400 AOM.02002400 Bad request. 请求错误 请检查对应的参数是否符合要求。 400 AOM.02003101 Invalid rule. 阈值规则不合法 请检查对应的参数是否符合要求。 400 AOM.02003102 The rule name already exists. 阈值规则名称已存在 请检查对应的参数是否符合要求。 400 AOM.02003103 Invalid description. 描述不合法 请检查对应的参数是否符合要求。 400 AOM.02003104 Invalid threshold. 告警阈值不合法 请检查对应的参数是否符合要求。 400 AOM.02003105 Invalid period. 告警周期不合法 请检查对应的参数是否符合要求。 400 AOM.02003106 Invalid email. 邮件格式错误 请检查对应的参数是否符合要求。 400 AOM.02003107 The maximum number of rules has been reached. 当前创建的阈值规则条数已达到最大值 请检查对应的参数是否符合要求。 400 AOM.02003108 Invalid time range. 时间段不合法 请检查对应的参数是否符合要求。 400 AOM.02003109 Invalid project ID. 项目ID无效 请检查对应的参数是否符合要求。 400 AOM.02003110 Invalid limit. limit参数不合法 请检查对应的参数是否符合要求。 400 AOM.02003111 Invalid offset. offset参数不合法 请检查对应的参数是否符合要求。 400 AOM.02003112 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02003115 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02003118 Invalid number of consecutive periods. 连续周期不合法 请检查对应的参数是否符合要求。 400 AOM.02003119 Invalid statistic. 统计方式参数不合法 请检查对应的参数是否符合要求。 400 AOM.02003120 Invalid comparison operator. 操作符不合法 请检查对应的参数是否符合要求。 400 AOM.02003121 The rule does not exist. 阈值规则不存在 请检查对应的参数是否符合要求。 400 AOM.02003400 Bad request. 请求错误 请检查对应的参数是否符合要求。 400 AOM.02004101 Invalid rule. 阈值规则不合法 请检查对应的参数是否符合要求。 400 AOM.02004102 The rule name already exists. 阈值规则名称已存在 请检查对应的参数是否符合要求。 400 AOM.02004103 Invalid description. 描述不合法 请检查对应的参数是否符合要求。 400 AOM.02004104 Invalid threshold. 告警阈值不合法 请检查对应的参数是否符合要求。 400 AOM.02004105 Invalid period. 告警周期不合法 请检查对应的参数是否符合要求。 400 AOM.02004106 Invalid email. 邮件格式错误 请检查对应的参数是否符合要求。 400 AOM.02004107 The maximum number of rules has been reached. 当前创建的阈值规则条数已达到最大值 请检查对应的参数是否符合要求。 400 AOM.02004108 Invalid time range. 时间段不合法 请检查对应的参数是否符合要求。 400 AOM.02004109 Invalid project ID. 项目ID无效 请检查对应的参数是否符合要求。 400 AOM.02004110 Invalid limit. limit参数不合法 请检查对应的参数是否符合要求。 400 AOM.02004111 Invalid offset. offset参数不合法 请检查对应的参数是否符合要求。 400 AOM.02004112 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02004115 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02004118 Invalid number of consecutive periods. 连续周期不合法 请检查对应的参数是否符合要求。 400 AOM.02004119 Invalid statistic. 统计方式参数不合法 请检查对应的参数是否符合要求。 400 AOM.02004120 Invalid comparison operator. 操作符不合法 请检查对应的参数是否符合要求。 400 AOM.02004121 The rule does not exist. 阈值规则不存在 请检查对应的参数是否符合要求。 400 AOM.02004400 Bad request. 请求错误 请检查对应的参数是否符合要求。 400 AOM.02005101 Invalid rule. 阈值规则不合法 请检查对应的参数是否符合要求。 400 AOM.02005102 The rule name already exists. 阈值规则名称已存在 请检查对应的参数是否符合要求。 400 AOM.02005103 Invalid description. 描述不合法 请检查对应的参数是否符合要求。 400 AOM.02005104 Invalid threshold. 告警阈值不合法 请检查对应的参数是否符合要求。 400 AOM.02005105 Invalid period. 告警周期不合法 请检查对应的参数是否符合要求。 400 AOM.02005106 Invalid email. 邮件格式错误 请检查对应的参数是否符合要求。 400 AOM.02005107 The maximum number of rules has been reached. 当前创建的阈值规则条数已达到最大值 请检查对应的参数是否符合要求。 400 AOM.02005108 Invalid time range. 时间段不合法 请检查对应的参数是否符合要求。 400 AOM.02005109 Invalid project ID. 项目ID无效 请检查对应的参数是否符合要求。 400 AOM.02005110 Invalid limit. limit参数不合法 请检查对应的参数是否符合要求。 400 AOM.02005111 Invalid offset. offset参数不合法 请检查对应的参数是否符合要求。 400 AOM.02005112 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02005115 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.02005118 Invalid number of consecutive periods. 连续周期不合法 请检查对应的参数是否符合要求。 400 AOM.02005119 Invalid statistic. 统计方式参数不合法 请检查对应的参数是否符合要求。 400 AOM.02005120 Invalid comparison operator. 操作符不合法 请检查对应的参数是否符合要求。 400 AOM.02005121 The rule does not exist. 阈值规则不存在 请检查对应的参数是否符合要求。 400 AOM.02005400 Bad request. 请求错误 请检查对应的参数是否符合要求。 400 AOM.04007101 Invalid namespace. namespace参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007102 Invalid inventory ID. inventory ID参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007103 The project ID cannot be left blank. 项目ID为空 请检查对应的参数是否符合要求。 400 AOM.04007104 Invalid type. type参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007105 Invalid limit. limit参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007106 Invalid offset. offset参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007107 Invalid parent inventory ID. inventory父ID参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007108 Invalid type and relation. type和relation参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007109 Invalid metric name. 指标名称不合法 请检查对应的参数是否符合要求。 400 AOM.04007110 Invalid relation. relation参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007111 The type and relation cannot be left blank. type和relation参数不能为空 请检查对应的参数是否符合要求。 400 AOM.04007112 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007115 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007118 Invalid number of consecutive periods. 连续周期不合法 请检查对应的参数是否符合要求。 400 AOM.04007119 Invalid statistic. 统计方式参数不合法 请检查对应的参数是否符合要求。 400 AOM.04007120 Invalid comparison operator. 操作符不合法 请检查对应的参数是否符合要求。 400 AOM.04007400 Bad request. 请求错误 请检查对应的参数是否符合要求。 400 AOM.04008101 Invalid namespace. namespace参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008102 Invalid inventory ID. inventory ID参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008103 The project ID cannot be left blank. 项目ID为空 请检查对应的参数是否符合要求。 400 AOM.04008104 Invalid type. type参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008105 Invalid limit. limit参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008106 Invalid offset. offset参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008107 Invalid parent inventory ID. inventory父ID参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008108 Invalid type and relation. type和relation参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008109 Invalid metric name. 指标名称不合法 请检查对应的参数是否符合要求。 400 AOM.04008110 Invalid relation. relation参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008111 The type and relation cannot be left blank. type和relation参数不能为空 请检查对应的参数是否符合要求。 400 AOM.04008112 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008115 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008118 Invalid number of consecutive periods. 连续周期不合法 请检查对应的参数是否符合要求。 400 AOM.04008119 Invalid statistic. 统计方式参数不合法 请检查对应的参数是否符合要求。 400 AOM.04008120 Invalid comparison operator. 操作符不合法 请检查对应的参数是否符合要求。 400 AOM.04008400 Bad request. 请求错误 请检查对应的参数是否符合要求。 400 AOM.07001400 Invalid parameter. 参数错误 请检查对应的参数是否符合要求。 400 SVCSTG.INV.4000115 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000001 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000002 Invalid namespace. namespace参数不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000003 Dimensions cannot be left blank. Dimensions不能为空 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000005 Invalid metric data type. 指标数据类型错误 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000006 The metric data value cannot be left blank. 指标数据不能为空 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000007 Invalid dimension. dimension不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000008 The request exceeds 40 KB. 请求不能大于40KB 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000009 The number of elements in the dimension array exceeds the allowed limit. dimension数组长度超长 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000010 Invalid collection time. 收集时间不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000101 The namespace or alarm name is invalid, or the project ID is left blank. 命名空间无效、项目ID为空或者告警名称无效 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000102 The inventory ID is invalid, the metric data value is left blank, or the threshold rule name already exists. 无效的inventory ID、指标数据参数为空或阈值规则名称已存在 请检查对应的参数是否符合要求或者请更换阈值规则名称再次创建 400 SVCSTG_AMS_4000103 Invalid range or alarm description. 无效的区间或者告警描述无效 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000104 Invalid statistics or alarm threshold. 无效的统计信息或者告警阈值 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000105 Invalid limit, metric, or alarm period. 无效的限制、指标或者告警周期 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000106 Invalid offset, time range, or email. 无效的偏移量、时间范围或者电子邮件 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000107 The number of data points in a time range exceeds 1440 or the maximum number of threshold rules has been reached. 时间范围内的数据点数超过1440个或者已达到阈值规则的最大数量 请检查对应的参数是否符合要求或者请联系技术支持工程师扩容。 400 SVCSTG_AMS_4000108 Invalid time range. 时间范围不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000109 Invalid metric name or project ID. 指标名称无效或者项目ID无效 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000110 Invalid filled value or limit. 无效的填充值或者限制 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000111 Invalid offset. offset参数不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000115 Invalid request parameter. 请求参数不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000118 Invalid number of consecutive periods. 连续周期不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000119 Invalid statistic. 统计方式不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000120 Invalid comparison operator. 操作符不合法 请检查对应的参数是否符合要求。 400 SVCSTG_AMS_4000121 The rule does not exist. 阈值规则不存在 请在界面上查看对应的阈值规则是否存在。 401 AOM.02001401 Unauthorized. 未经授权 请联系技术支持工程师解决。 401 AOM.02002401 Unauthorized. 未经授权 请联系技术支持工程师解决。 401 AOM.02003401 Unauthorized. 未经授权 请联系技术支持工程师解决。 401 AOM.02004401 Unauthorized. 未经授权 请联系技术支持工程师解决。 401 AOM.02005401 Unauthorized. 未经授权 请联系技术支持工程师解决。 401 AOM.04007401 Request unauthorized. 请求未经授权 请联系技术支持工程师解决。 401 AOM.04008401 Request unauthorized. 请求未经授权 请联系技术支持工程师解决。 403 AOM.02001403 Forbidden. 禁止 请联系技术支持工程师解决。 403 AOM.02002403 Forbidden. 禁止 请联系技术支持工程师解决。 403 AOM.02003403 Forbidden. 禁止 请联系技术支持工程师解决。 403 AOM.02004403 Forbidden. 禁止 请联系技术支持工程师解决。 403 AOM.02005403 Forbidden. 禁止 请联系技术支持工程师解决。 403 AOM.04007403 Request forbidden. 请求被禁止 请联系技术支持工程师解决。 403 AOM.04008403 Request forbidden. 请求被禁止 请联系技术支持工程师解决。 403 AOM.07001403 Insufficient permissions. 用户无权限 请检查用户权限是否符合要求。 403 SVCSTG.INV.4030000 Insufficient permissions. 权限不足 请更换有权限的账号。 429 AOM.07001429 The traffic has been restricted. 该用户已被限流 请减少该接口请求的频率。 429 AOM.08001429 Too many requests. 请求太多 请检查对应的参数是否符合要求。 500 AOM.02001500 Internal server error. 内部服务器错误 请联系技术支持工程师解决。 500 AOM.02001501 The Cassandra session is null. Cassandra会话为空 请联系技术支持工程师解决。 500 AOM.02001502 The Cassandra execution is abnormal. Cassandra执行异常 请联系技术支持工程师解决。 500 AOM.02002500 Internal server error. 内部服务器错误 请联系技术支持工程师解决。 500 AOM.02002501 The Cassandra session is null. Cassandra会话为空 请联系技术支持工程师解决。 500 AOM.02002502 The Cassandra execution is abnormal. Cassandra执行异常 请联系技术支持工程师解决。 500 AOM.02003500 Internal server error. 内部服务器错误 请联系技术支持工程师解决。 500 AOM.02003501 The Cassandra session is null. Cassandra会话为空 请联系技术支持工程师解决。 500 AOM.02003502 The Cassandra execution is abnormal. Cassandra执行异常 请联系技术支持工程师解决。 500 AOM.02004500 Internal server error. 内部服务器错误 请联系技术支持工程师解决。 500 AOM.02004501 The Cassandra session is null. Cassandra会话为空 请联系技术支持工程师解决。 500 AOM.02004502 The Cassandra execution is abnormal. Cassandra执行异常 请联系技术支持工程师解决。 500 AOM.02005500 Internal server error. 内部服务器错误 请联系技术支持工程师解决。 500 AOM.02005501 The Cassandra session is null. Cassandra会话为空 请联系技术支持工程师解决。 500 AOM.02005502 The Cassandra execution is abnormal. Cassandra执行异常 请联系技术支持工程师解决。 500 AOM.04007500 Internal server error. 内部服务器错误 请联系技术支持工程师解决。 500 AOM.04007501 The Cassandra session is null. Cassandra会话为空 请联系技术支持工程师解决。 500 AOM.04007502 The Cassandra execution is abnormal. Cassandra执行异常 请联系技术支持工程师解决。 500 AOM.04008500 Internal server error. 内部服务器错误 请联系技术支持工程师解决。 500 AOM.04008501 The Cassandra session is null. Cassandra会话为空 请联系技术支持工程师解决。 500 AOM.04008502 The Cassandra execution is abnormal. Cassandra执行异常 请联系技术支持工程师解决。 500 SVCSTG.INV.5000001 The Elasticsearch session is null. Elasticsearch会话为空 请联系技术支持工程师解决。 500 SVCSTG.INV.5000002 The Elasticsearch execution is abnormal. Elasticsearch执行异常 请联系技术支持工程师解决。 500 SVCSTG.INV.5000003 The ICMgr invocation is abnormal. 调用ICMGR异常 请联系技术支持工程师解决。 500 SVCSTG.INV.5000006 The rule name already exists. 应用规则名称已存在 请修改规则名称。 500 SVCSTG.INV.5000007 The maximum number of rules has been reached. 已达到最大规则数 请删除不需要的规则后重新添加规则。 500 SVCSTG_AMS_5000000 Internal server error. 内部服务器错误 请联系技术支持工程师解决。 503 AOM.02001503 Server unavailable. 服务器不可用 请联系技术支持工程师解决。 503 AOM.02002503 Server unavailable. 服务器不可用 请联系技术支持工程师解决。 503 AOM.02003503 Server unavailable. 服务器不可用 请联系技术支持工程师解决。 503 AOM.02004503 Server unavailable. 服务器不可用 请联系技术支持工程师解决。 503 AOM.02005503 Server unavailable. 服务器不可用 请联系技术支持工程师解决。 503 AOM.04007503 Server unavailable. 服务器不可用 请联系技术支持工程师解决。 503 AOM.04008503 Server unavailable. 服务器不可用 请联系技术支持工程师解决。 503 AOM.07001503 Service error. 服务异常 请检查后台服务是否正常。 503 SVCSTG_AMS_5030001 The Cassandra session is null. Cassandra会话为空 请联系技术支持工程师解决。 503 SVCSTG_AMS_5030002 The Cassandra execution is abnormal. Cassandra执行异常 请联系技术支持工程师解决。 父主题: 附录
  • 基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用该用户进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域 区域指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 父主题: 使用前必读
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 公有云API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见AK/SK认证。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 POST https://Endpoint/v3/auth/tokens Content-Type: application/json
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://Endpoint/v3/auth/tokens
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的ID,获取方法请参见获取账号ID和项目ID。 scope参数定义了Token的作用域,上面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个账号下所有资源或账号的某个project下的资源。 POST https://Endpoint/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
共100000条