华为云用户手册

  • 响应示例 状态码: 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 }
  • 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 表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
  • 响应示例 状态码: 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,仅支持字符集:中文字符、英文字母、数字、下划线、中划线、点;应用唯一标识与显示名称至少填写其一
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 Content-Type 是 String 指定类型为application/json,有Body体的情况下必选,没有Body体则无需填写和校验。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 应用描述 最小长度:0 最大长度:255 display_name 否 String 应用名称.字符集长度2-64,仅支持字符集:中文字符、英文字母、数字、下划线、中划线、点 最小长度:2 最大长度:64 eps_id 否 String 应用关联的企业项目id。企业级用户必传 name 是 String 唯一标识.字符集长度2-64,仅支持字符集:英文字母、数字、下划线、中划线、点 register_type 否 String 前端默认是CONSOLE,不需要传参。rest接口无参数是API,有参数只能是:SERVICE_DISCOVERY 枚举值: API CONSOLESERVICE_DISCOVERY
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 Content-Type 是 String 指定类型为application/json,有Body体的情况下必选,没有Body体则无需填写和校验。 表3 请求Body参数 参数 是否必选 参数类型 描述 component_id 是 String 环境关联组件id;id长度不能超过36位,由大小写字母、数字组成。创建环境必传,修改环境时非必选 description 否 String 描述 env_name 是 String 环境名称 env_type 是 String 环境类型,取值:DEV、TEST、PRE、ONLINE,不区分大小写 os_type 是 String OS类型,取值:LINUX、WINDOWS。创建环境必传,不可修改 region 否 String 环境关联region。创建环境必传,不可修改 register_type 否 String 注册类型,取值:API、SERVICE_DISCOVERY、CONSOLE,默认值:API
  • 请求示例 修改环境 https://{Endpoint}/v1/environments/{environment_id} { "component_id" : "4df35ac3a1c34652844d18c3d069f8b2", "description" : "环境描述", "env_name" : "environment1", "env_type" : "DEV", "os_type" : "LINUX", "region" : "xxx", "register_type" : "API" }
  • 调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 422 Unprocessable 表达式无法执行。 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。
  • 响应示例 状态码: 200 OK 请求响应成功。 { "status" : "success", "data" : { "aggregator_openapi_v2_regeneration_count" : [ { "type" : "counter", "help" : "[ALPHA] Counter of OpenAPI v2 spec regeneration count broken down by causing APIService name and reason.", "unit" : "" } ] } } 状态码: 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 表3 响应Body参数 参数 参数类型 描述 status String 响应状态。 data Object 元数据信息。 状态码: 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 错误信息。
  • 查询时序数据 接口相关信息 URI格式:POST /v2/{project_id}/samples 请求示例 POST https://{aom_endpoint}/v2/{project_id}/samples {aom_endpoint}信息请从地区和终端节点获取。 Body: { "samples": [ { "namespace": "PAAS.NODE", "metric_name": "cpuUsage", "dimensions": [ { "name": "clusterId", "value": "4fae3587-0202-11eb-9ba9-0255ac100b02" }, { "name": "hostID", "value": "4100f512-c4e9-4b65-b0dd-2b94ea5e1a84" } ] } ], "period": 60, "time_range": "-1.-1.2", "statistics": [ "maximum", "minimum", "sum" ] } 响应示例 { "samples": [{ "sample": { "namespace": "PAAS.NODE", "metric_name": "cpuUsage", "dimensions": [{ "name": "clusterId", "value": "4fae3587-0202-11eb-9ba9-0255ac100b02" }, { "name": "hostID", "value": "4100f512-c4e9-4b65-b0dd-2b94ea5e1a84" }] }, "data_points": [{ "timestamp": 1608191880000, "unit": "Percent", "statistics": [{ "statistic": "maximum", "value": 14.5 }, { "statistic": "minimum", "value": 14.5 }, { "statistic": "sum", "value": 14.5 }] }, { "timestamp": 1608191940000, "unit": "Percent", "statistics": [{ "statistic": "maximum", "value": 12.0 }, { "statistic": "minimum", "value": 12.0 }, { "statistic": "sum", "value": 12.0 }] }] }] }
  • 状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。
  • 请求示例 向服务端添加一条指标名称为“cpu_util”且维度名称为“instance_id”的监控数据(下述例子中,"collect_time"应填写为最新的时间戳)。 https://{Endpoint}/v1/{project_id}/ams/report/metricdata [ { "metric" : { "namespace" : "NOPAAS.ESC", "dimensions" : [ { "name" : "instance_id", "value" : "instance-101" } ] }, "values" : [ { "unit" : "percent", "metric_name" : "cpu_util", "type" : "int", "value" : 35 } ], "collect_time" : 1467787152000 } ]
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 Content-Type 是 String 指定类型为application/json。 枚举值: application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of MetricDataItem objects 指标参数信息。 表4 MetricDataItem 参数 是否必选 参数类型 描述 collect_time 是 Long 数据收集时间支持过去1天和未来半小时范围内的数据上报。数据收集时间需要满足: 当前UTC时间减去collect_time小于等于24小时或者collect_time减去当前UTC时间小于等于30分钟。 若数据上报时间早于当天8点,则指标监控页面只显示当天8点后的数据。取值范围: UNIX时间戳,单位毫秒。 metric 是 MetricItemInfo object 指标详细信息。 values 是 Array of ValueData objects 指标数据的值。 表5 MetricItemInfo 参数 是否必选 参数类型 描述 dimensions 是 Array of Dimension2 objects 指标维度列表。维度最多允许50个,单个维度为json对象,结构说明如下 dimension.name:长度最短为1,最大为32。 dimension.value:长度最短为1,最大为64。 namespace 是 String 指标命名空间。namespace中不允许存在":"符号,取值范围格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_,总长度最短为3,最大为32,service不能为“PAAS”。 最小长度:3 最大长度:32 表6 Dimension2 参数 是否必选 参数类型 描述 name 是 String 维度名称。 最小长度:1 最大长度:32 value 是 String 维度取值。 最小长度:1 最大长度:64 表7 ValueData 参数 是否必选 参数类型 描述 metric_name 是 String 指标名称。长度1~255。 type 否 String 数据的类型。取值范围只能是"int"或"float"。 枚举值: int float unit 否 String 数据的单位。长度不超过32个字符。 value 是 Double 指标数据的值。取值范围有效的数值类型。 最小值:0
  • 状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
  • 响应示例 状态码: 200 OK 请求响应成功。 { "action_rules" : [ { "create_time" : 1665991889597, "notification_template" : "aom.built-in.template.zh", "project_id" : "2xxxxxxxxxxxxxxxxxxxxxf", "rule_name" : "1112222", "smn_topics" : [ { "display_name" : "", "name" : "gcmtest", "push_policy" : 0, "status" : 0, "topic_urn" : "urn:smn:xxx:2xxxxxxxxxxxxxxxxxxxxxf:gcmtest" } ], "time_zone" : "xxx", "type" : "1", "update_time" : 1665991889597, "user_name" : "kxxxxxt" } ] } 状态码: 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" : "" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 action_rules Array of ActionRule objects 告警行动规则列表 数组长度:0 - 1000 表4 ActionRule 参数 参数类型 描述 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 表5 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 表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
  • 状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
  • URI PUT /v1/{project_id}/cms/workflow/{workflow_id}/trigger/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 workflow_id 是 String 任务id,待修改任务的id。 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 action 是 String 启动或暂停任务的定时执行。enable为开启定时任务,disable为关闭定时任务 最小长度:1 最大长度:10 枚举值: enable disable
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 响应码。 最小长度:1 最大长度:64 error_msg String 调用失败响应信息描述。 最小长度:1 最大长度:1024 http_code Integer http返回码 最小值:0 最大值:999 状态码: 401 表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
  • 响应示例 状态码: 200 任务启停操作成功 {"success"} 状态码: 400 BadRequest。非法请求。建议直接修改该请求,不要重试该请求。 { "error_code" : "AOM.31001302", "error_msg" : "Invalid param", "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 }
  • 响应参数 状态码: 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 没有权限
  • 请求示例 创建环境 https://{Endpoint}/v1/environments { "component_id" : "28c600be47374b9697404b0f58263d1c", "description" : "环境描述", "env_name" : "environment1", "env_type" : "DEV", "os_type" : "LINUX", "region" : "xxx", "register_type" : "API" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 Content-Type 是 String 指定类型为application/json,有Body体的情况下必选,没有Body体则无需填写和校验。 表2 请求Body参数 参数 是否必选 参数类型 描述 component_id 是 String 环境关联组件id;id长度不能超过36位,由大小写字母、数字组成。创建环境必传,修改环境时非必选 description 否 String 描述 env_name 是 String 环境名称 env_type 是 String 环境类型,取值:DEV、TEST、PRE、ONLINE,不区分大小写 os_type 是 String OS类型,取值:LINUX、WINDOWS。创建环境必传,不可修改 region 否 String 环境关联region。创建环境必传,不可修改 register_type 否 String 注册类型,取值:API、SERVICE_DISCOVERY、CONSOLE,默认值:API
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:自定义策略中授权项定义的内容即为权限。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见IAM与企业管理的区别。 AOM支持自定义策略授权项如下所示: 告警:包括所有告警相关接口对应的授权项,例如查询事件告警信息接口。 监控:包括所有监控相关接口对应的授权项,例如查询指标接口。 prometheus监控:包括所有prometheus监控相关接口对应的授权项,例如区间数据查询接口。 日志:包括所有日志相关接口对应的授权项,例如查询日志接口。 应用资源管理:包括所有应用资源相关接口对应的授权项,例如新增应用接口。 自动化运维:包括所有自动化运维相关接口对应的授权项,例如创建任务接口。
  • 状态码 状态码 描述 200 OK 请求响应成功。 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 NotFound 所请求的资源不存在。建议直接修改该请求,不要重试该请求。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 503 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。
  • 响应示例 状态码: 200 OK 请求响应成功。 { "errorCode" : "SVCSTG.INV.2000000", "errorMessage" : null, "id" : [ ] } 状态码: 400 BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 { "errorCode" : "SVCSTG.INV.4000118", "errorMessage" : "Request param is invalid", "id" : [ ] } 状态码: 404 NotFound 所请求的资源不存在。建议直接修改该请求,不要重试该请求。 { "errorCode" : "SVCSTG.INV.4040000", "errorMessage" : "Inventory does not exists", "id" : [ ] } 状态码: 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 { "error_code" : "APM.00000500", "error_msg" : "Internal Server Error", "trace_id" : "" }
共100000条