华为云用户手册

  • 响应示例 状态码: 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : " AOM .08004001", "error_msg" : "bad request", "trace_id" : "" } 状态码: 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "SV CS TG.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.08004500", "error_msg" : "SC_INTERNAL_SERVER_ERROR", "trace_id" : "" }
  • 状态码 状态码 描述 204 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 最小长度:1 最大长度:40960 Content-Type 是 String 指定类型为application/json。 枚举值: application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 rule_name 是 String 规则名称 只含有汉字数字、字母、下划线,不能以下划线等特殊符号开头和结尾,长度为 1 - 100 最小长度:1 最大长度:100 project_id 是 String 项目ID 最小长度:32 最大长度:32 user_name 是 String 子账号名称 最小长度:1 最大长度:100 desc 否 String 规则描述。规则描述长度为0到1024个字符,并且只能是数字、字母、特殊字符(_*)、空格和中文组成,不能以下划线开头和结尾。 最小长度:0 最大长度:1024 type 是 String 规则类型。"1":通知,"2":用户 最小长度:1 最大长度:1 枚举值: 1 2 notification_template 是 String 消息模板 最小长度:1 最大长度:100 create_time 否 Long 创建时间 最小值:0 最大值:9999999999999 update_time 否 Long 修改时间 最小值:0 最大值:9999999999999 time_zone 否 String 时区 最小长度:1 最大长度:100 smn_topics 是 Array of smn_topics objects SMN 主题信息,不能大于5 数组长度:1 - 5 表4 smn_topics 参数 是否必选 参数类型 描述 display_name 否 String Topic的显示名,推送邮件消息时,作为邮件发件人显示。显示名的长度为192byte或64个中文。默认值为空。 最小长度:1 最大长度:64 name 是 String 创建topic的名字。Topic名称只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度为1到255个字符。 最小长度:1 最大长度:255 push_policy 是 Integer SMN消息推送策略。取值为0或1 最小值:0 最大值:1 status 否 Integer topic中订阅者的状态。0:主题已删除或主题下订阅列表为空。1:主题下的订阅列表存在状态为“已订阅”的订阅信息。2:主题下的订阅信息状态处于“未订阅”或“已取消”。 枚举值: 0 1 2 topic_urn 是 String Topic的唯一的资源标识。 最小长度:1 最大长度:100
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:13 最大长度:13 error_msg String 响应信息描述。 最小长度:1 最大长度:100 trace_id String 响应id。 最小长度:12 最大长度:12 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:0 最大长度:1024 error_type String 错误类型 最小长度:0 最大长度:128 trace_id String 请求id 最小长度:32 最大长度:32 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:0 最大长度:1024 error_type String 错误类型 最小长度:0 最大长度:128 trace_id String 请求id 最小长度:32 最大长度:32 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:13 最大长度:13 error_msg String 响应信息描述。 最小长度:1 最大长度:100 trace_id String 响应id。 最小长度:12 最大长度:12
  • 状态码 状态码 描述 204 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
  • 响应示例 状态码: 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.08004001", "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.08004500", "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”、时区为“xxx”和用户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" }
  • 响应示例 状态码: 200 响应成功,返回作业列表。 { "elements" : [ { "approve_info" : { "need_approve" : false }, "create_by" : "xxxxxx", "create_time" : 1600015045074, "description" : "", "enterprise_project_id" : "0", "id" : "xxxxxx", "is_latest_version" : true, "name" : "xxxxxx", "parameters" : [ { "default_value" : "xxxxx", "description" : "", "encryption" : false, "hint" : "", "id" : "xxxxxxx", "param_group" : "", "param_name" : "xxxxx", "param_type" : "STRING", "quote_param" : false, "required" : true }, { "default_value" : "xxxx", "description" : "", "encryption" : false, "hint" : "", "id" : "xxxxxxxx", "param_group" : "", "param_name" : "xxxxx", "param_type" : "STRING", "quote_param" : false, "required" : true }, { "default_value" : "{xxxxxxx}", "description" : "", "encryption" : false, "hint" : "", "id" : "xxxxxxxxxx", "param_group" : "ecs_instance", "param_name" : "xxxxx", "param_type" : "HOST", "quote_param" : false, "required" : true } ], "project_id" : "xxxxxxxxx", "rate_control" : { "have_rate_control" : false, "max" : 0, "time_delay" : 0 }, "steps" : [ { "description" : "", "id" : "xxxxxxxxxxx", "ignore_error" : false, "input" : { "script_param" : "{xxxxxxx}", "get_instances" : "{xxxxxxx}" }, "name" : "xxx", "type" : "script" }, { "description" : "", "id" : "xxxxxxxxxxxx", "ignore_error" : false, "input" : { "package" : "{xxxx}", "get_instances" : "{xxxx}" }, "name" : "file1", "type" : "package" } ], "update_by" : "xxxx", "update_time" : 1600015045074, "version_number" : 1 } ], "total_elements" : 1 } 状态码: 400 BadRequest。非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.31003202", "error_msg" : "job parameter invalid.", "http_code" : 400 } 状态码: 401 Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "AOM.31009019", "error_message" : "auth failed.", "http_code" : "401" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 最小长度:1 最大长度:40960 Content-Type 是 String 指定类型为application/json。 最小长度:1 最大长度:32 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String name为作业名称。 最小长度:1 最大长度:64 page_num 否 Integer 当前页,查询的当前页,page_num为正整数,不能是0和负数,当输入参数为负数,0和大于1000,自动修正参数为1,默认值是1(用户不传,值是1)。 最小值:1 最大值:1000 page_size 否 Integer 每页显示的条数,每页查询的总条数,page_size为正整数,不能是0和负数,当输入参数为负数,0和大于101,自动修正参数为10,默认值是10(用户不传时,值是10)。 最小值:1 最大值:100 order_by_column 是 String 需要排序的字段(默认为更新时间),支持字段有name,create_time,update_time。 最小长度:1 最大长度:32 sort_order 是 String 排序规则(默认降序) 传入升序或降序,升序:ASC,降序:DESC。 最小长度:1 最大长度:32 enterprise_project_id 否 String 企业项目id 最小长度:0 最大长度:64
  • 请求示例 查询name为"xxx"、排序规则"order_by_column"为"create_time"的作业列表。 POST https://{Endpoint}/v1/{project_id}/cms/job/list { "name" : "xxx", "enterprise_project_id" : "", "page_num" : 1, "page_size" : 10, "order_by_column" : "create_time", "sort_order" : "DESC" }
  • 响应示例 状态码: 200 应用详情 { "creator" : "xxx", "modifier" : "xxx", "name" : "exampleSW", "create_time" : "2023-02-03 10:35:00", "modified_time" : "2023-02-03 10:35:00", "register_type" : "API", "display_name" : "exampleSW", "app_id" : "9616a75c75af4bcdacf38d77ff72a88e", "eps_id" : "0" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 aom_id String aomId,如果为空则不显示 app_id String 应用ID create_time String 创建时间 creator String 创建人 description String 描述 display_name String 应用名称 eps_id String 企业项目id modified_time String 修改时间 modifier String 修改人 name String 唯一标识 register_type String 注册方式 枚举值: API CONSOLE SERVICE_DISCOVERY 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String AOM.30005001 error_msg String 参数错误 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String AOM.30001005 error_msg String 没有权限
  • 响应示例 状态码: 200 OK 请求响应成功。 { "series" : [ { "event_severity" : "Minor", "values" : [ 0, 0, 0, 0, 0, 0 ] }, { "event_severity" : "Info", "values" : [ 0, 0, 0, 0, 0, 0 ] } ], "step" : 60000, "timestamps" : [ 1642820700000, 1642820760000, 1642820820000, 1642820880000, 1642820940000, 1642821000000 ] } 状态码: 400 BadRequest。非法请求。 建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.0400", "error_message" : "param error", "error_type" : "SC_BAD_REQUEST" } 状态码: 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "AOM.0401", "error_message" : "you dont have permission", "error_type" : "SC_UNAUTHORIZED" } 状态码: 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.0403", "error_message" : "you dont have permission", "error_type" : "SC_FORBIDDEN" } 状态码: 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 { "error_code" : "AOM.0500", "error_message" : "SC_INTERNAL_SERVER_ERROR", "error_type" : "SC_INTERNAL_SERVER_ERROR" } 状态码: 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.0503", "error_message" : "SC_NOT_IMPLEMENTED", "error_type" : "SC_NOT_IMPLEMENTED" }
  • 状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest。非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。
  • URI POST /v2/{project_id}/events/statistic 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串。 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 查询类型。type=active_alert代表查询活动告警,type=history_alert代表查询历史告警。不传或者传其他值则返回指定查询条件的所有信息。 枚举值: history_alert active_alert
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 step Long 统计步长。毫秒数,例如一分钟则填写为60000。 timestamps Array of longs 统计结果对应的时间序列。 series Array of EventSeries objects 事件或者告警不同级别相同时间序列对应的统计结果。 表8 EventSeries 参数 参数类型 描述 event_severity String 事件或者告警级别枚举类型。 枚举值: Critical Major Minor Info values Array of integers 事件或者告警统计结果。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 响应码。 枚举值: AOM.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId error_type String 调用失败类型。 枚举值: Forbidden 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码。 枚举值: AOM.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId error_type String 调用失败类型。 枚举值: Forbidden 状态码: 403 表11 响应Body参数 参数 参数类型 描述 error_code String 响应码。 枚举值: AOM.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId error_type String 调用失败类型。 枚举值: Forbidden 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码。 枚举值: AOM.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId error_type String 调用失败类型。 枚举值: Forbidden 状态码: 503 表13 响应Body参数 参数 参数类型 描述 error_code String 响应码。 枚举值: AOM.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId error_type String 调用失败类型。 枚举值: Forbidden
  • 状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 422 Unprocessable 表达式无法执行。 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。
  • URI GET /v1/{project_id}/aom/api/v1/query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串。 表2 Query参数 参数 是否必选 参数类型 描述 query 是 String PromQL表达式(参考https://prometheus.io/docs/prometheus/latest/querying/basics/)。 time 否 String 指定用于计算 PromQL 的时间戳,(Unix时间戳格式,单位:秒)。
  • 响应参数 状态码: 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 OK 请求响应成功。 { "status" : "success", "data" : { "resultType" : "vector", "result" : [ ] } } 状态码: 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 终止任务执行成功。 { "result" : "success" } 状态码: 400 BadRequest。非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.31001418", "error_msg" : "The task does not support the current operation.", "http_code" : 400 } 状态码: 401 Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "AOM.31009004", "error_msg" : "auth failed.", "http_code" : 401 } 状态码: 404 待终止的任务不存在。 { "error_code" : "AOM.31001306", "error_msg" : "Execution not exist. recordInfo is not exist.", "http_code" : 404 } 状态码: 500 内部错误。 { "error_code" : "AOM.31001405", "error_msg" : "workflow internal server error.", "http_code" : 500 }
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:64 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer http返回码 最小值:0 最大值:999 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:64 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer http返回码 最小值:0 最大值:999 状态码: 404 表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
  • URI POST /v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/terminate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 workflow_id 是 String 任务id,从工作流命令列表中获取的工作流id。 最小长度:1 最大长度:64 execution_id 是 String 任务执行id。 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 execution_id String 执行ID 最小长度:1 最大长度:64 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:64 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer http返回码 最小值:0 最大值:999 状态码: 404 表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
  • URI POST /v1/{project_id}/cms/workflow/{workflow_id}/executions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 workflow_id 是 String 任务id,从工作流命令列表中获取的工作流id。 最小长度:1 最大长度:64
  • 响应示例 状态码: 200 请求响应成功,下发任务成功。 { "execution_id" : "xxxxxxxx" } 状态码: 401 Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 { "error_code" : "AOM.31009004", "error_msg" : "auth failed.", "http_code" : 401 } 状态码: 404 BadRequest。非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.31001306", "error_msg" : "workflow not exist.", "http_code" : 404 } 状态码: 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 { "error_code" : "AOM.31001405", "error_msg" : "execution internal server error.", "http_code" : 500 }
  • 响应示例 状态码: 200 应用详情 { "creator" : "xxx", "modifier" : "xxx", "name" : "exampleSW12", "description" : "应用信息", "create_time" : "2023-02-03 10:35:00", "modified_time" : "2023-02-03 10:41:49", "register_type" : "API", "display_name" : "exampleSW12", "app_id" : "9616a75c75af4bcdacf38d77ff72a88e", "eps_id" : "0" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 aom_id String aomId,如果为空则不显示 app_id String 应用ID create_time String 创建时间 creator String 创建人 description String 描述 display_name String 应用名称 eps_id String 企业项目id modified_time String 修改时间 modifier String 修改人 name String 唯一标识 register_type String 注册方式 枚举值: API CONSOLE SERVICE_DISCOVERY 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String AOM.30005001 error_msg String 参数错误 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String AOM.30001005 error_msg String 没有权限
  • URI GET /v1/applications 表1 Query参数 参数 是否必选 参数类型 描述 name 否 String 应用唯一标识;字符集长度2-64,仅支持字符集:英文字母、数字、下划线、中划线、点;应用唯一标识与显示名称至少填写其一 display_name 否 String 实体的显示名称;字符集长度2-64,仅支持字符集:中文字符、英文字母、数字、下划线、中划线、点;应用唯一标识与显示名称至少填写其一
共100000条