云服务告警查询

功能

查询云服务告警。

注意事项

无

调用方法

GET

URI

/rest/dataapi/homs/open-api/v1/CloudServiceAlarm/info

路径参数

无

查询参数

请求

• 请求header参数

  参数	是否必选	类型	值域	说明
  X-APIG-Appcode	是	string	无	由SRE分配的AppCode。
  x-auth-token	是	string	无	调用方APIG的IAM认证token。
  x-hcso-domainid	是（HCSO场景） 否（其他场景）	string	无	接入的租户ID。
  x-hcso-appcode	是	string	无	由SRE分配的AppCode

• 请求body参数

  无

• 请求示例

  GET /rest/dataapi/homs/open-api/v1/CloudServiceAlarm/info HTTP/1.1 
  Host: example.com 
  Content-Type: application/json 
  Accept: application/json
  X-APIG-Appcode: xxx 
  x-auth-token: xxx 
  x-hcso-domainid：xxx 
  x-hcso-appcode：xxx

响应

• 响应参数
  • 响应状态码200：返回Data对象。Data对象包含如下属性：

    参数	是否必选	类型	值域	说明
    total	是	int32	无	数据总数量。
    list	是	List<Item>	无	流程对象。

    Item对象包含如下属性：

    参数	是否必选	类型	值域	说明
    csn	是	string	无	告警流水号。
    alarm_name	是	string	无	告警名称。
    alarm_id	是	int32	无	告警id。
    severity	是	string	无	告警级别：1-紧急、2-重要、3-次要、4-提示。
    event_type	是	string	无	事件类型。
    origin_system_type	是	string	无	来源系统类型。
    origin_system_name	是	string	无	来源系统名称。
    moi	是	string	无	对象标识，告警定位信息。
    additional_information	是	string	无	附加信息。
    latest_occur_utc	是	string	无	告警最后发生的UTC时间。
    first_occur_utc	是	string	无	告警首次发生的UTC时间。
    meName	是	string	无	告警对应的对象名称。
    count	是	string	无	告警发生次数。
    probable_cause	是	string	无	可能原因描述。
    region	是	string	无	区域名称。
    dc_name	是	string	无	数据中心名称。
    res_pool_name	是	string	无	告警上报的POD信息。
    azone_name	是	string	无	可用分区名称。
    tenant	是	string	无	所属租户名称。
    nativeMeDn	是	string	无	告警IP地址。
    moc	是	string	无	对象类型。
    cleared	是	string	无	告警是否清除。
    clear_category	是	string	无	可自动清除。
    clear_utc	是	string	无	告警清除UTC时间。
    clear_user	是	string	无	清除人员。
    clear_type	是	string	无	告警清除类型。
    acked	是	string	无	告警确认状态:0-未确认、1-已确认。
    ack_user	是	string	无	确认人员。
    ack_utc	是	string	无	确认utc时间。
    merge_key	是	string	无	合并key。
    me_category	是	string	无	产生告警的云服务。
    me_type	是	string	无	产生告警的服务。
    product_name	是	string	无	产生告警的微服务。
    LogicalRegionId	是	string	无	区域Code。
    serviceAffectedType	是	string	无	影响业务标识。
    affectedService	是	string	无	告警所影响的业务名称。
    meDn	是	string	无	告警对应的对象标识。

• 响应示例

  HTTP/1.1 200 OK 
  Date:Tue,18 Jul 2023 09:58:01 GMT
  Server: example.com
  Content-Type: application/json;charset=UTF8 
  { 
      "total": "总数", 
      "list": [ 
               { 
               "csn": "12346578", 
               "alarm_name": "告警名称", 
               "alarm_id": "告警id", 
               "severity": "告警级别：1-紧急、2-重要、3-次要、4-提示", 
               "event_type": "事件类型", 
               "origin_system_type": "来源系统类型", 
               "origin_system_name": "来源系统名称", 
               "moi": "对象标识，告警定位信息", 
               "additional_information": "附加信息", 
               "latest_occur_utc": "告警最后发生的UTC时间", 
               "first_occur_utc": "告警首次发生的UTC时间", 
               "meName": "告警对应的对象名称", 
               "count": "告警发生次数", 
               "probable_cause": "可能原因描述", 
               "region": "区域名称", 
               "dc_name": "数据中心名称", 
               "res_pool_name": "告警上报的POD信息", 
               "azone_name": "可用分区名称", 
               "tenant": "所属租户名称", 
               "nativeMeDn": "告警IP地址", 
               "moc": "对象类型", 
               "cleared": "告警是否清除", 
               "clear_category": "可自动清除", 
               "clear_utc": "告警清除UTC时间", 
               "clear_user": "清除人员", 
               "clear_type": "告警清除类型", 
               "acked": "告警确认状态:0-未确认、1-已确认", 
               "ack_user": "确认人员", 
               "ack_utc": "确认utc时间", 
               "merge_key": "合并key", 
               "me_category": "产生告警的云服务", 
               "me_type": "产生告警的服务", 
               "product_name": "产生告警的微服务", 
               "LogicalRegionId": "cn-north-201", 
               "serviceAffectedType": "影响业务标识", 
               "affectedService": "告警所影响的业务名称", 
               "meDn": "告警对应的对象标识" 
                } 
              ] 
  }

状态码

操作危险级别

Minor