-
概述 SLA(服务等级协议,Service Level Agreement)在业界常用于衡量服务质量,它定义了服务的质量标准、交付方式和可接受的性能水平。云运维中心COC的SLA管理功能为客户提供了工单时效管理能力,当工单触发某SLA规则时,COC会记录工单SLA触发详情,并通知客户及时跟进和处理。 SLA功能概要如下: 支持客户自定义SLA,或使用COC预置的公共SLA规则。 支持事件单/告警单/待办任务/问题单4类工单。 支持设定SLA目标(工单需要在指定时间内完结某状态),当工单触发规则后,按指定方式通知指定的人员,且支持持续通知。 支持设定SLA预警目标,即将打破SLA时,提前指定时间发送通知。 支持查看SLA记录,包含工单ID,SLA状态,SLA规则等关键信息。 创建或修改SLA后,将对新进入SLA流程的工单开始生效,对已处于SLA流程中的工单不会生效。 自定义SLA优先级高于公共SLA,部分应用优先级高于全部应用。 父主题: SLA管理
-
概述 SLA(服务等级协议,Service Level Agreement)在业界常用于衡量服务质量,云运维中心COC的SLA管理功能为客户提供了工单时效管理能力,当工单触发某SLA规则时,COC会记录工单SLA触发详情,并通知客户及时跟进和处理。 SLA功能概要如下: 支持客户自定义SLA,或使用COC预置的公共SLA规则。 支持事件单/告警单/待办任务/问题单4类工单。 支持设定SLA目标(工单需要在指定时间内完结某状态),当工单触发规则后,按指定方式通知指定的人员,且支持持续通知。 支持设定SLA预警目标,即将打破SLA时,提前指定时间发送通知。 支持查看SLA记录,包含工单ID,SLA状态,SLA规则等关键信息。 创建或修改SLA后,将对新进入SLA流程的工单开始生效,对已处于SLA流程中的工单不会生效。 自定义SLA优先级高于公共SLA,部分应用优先级高于全部应用。 父主题: SLA管理
-
响应示例 返回状态码为200:返回SLA服务列表信息。 HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"errorCode": 0,
"errorMsg": "快速诊断成功",
"sessionId": "10020591"
} 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为403:URL鉴权。 HTTP/1.1 403 Forbidden
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为404:rest接口没找到。 HTTP/1.1 404 Not Found
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为406:流控限流。 HTTP/1.1 406 Not Acceptable
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:默认ServiceException异常码,应用内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为502:网关错误。 HTTP/1.1 502 Bad Gateway
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为503:服务不可用。 HTTP/1.1 503 Service Unavailable
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为504:表示时间超时,总线超时时间300s。 HTTP/1.1 504 Gateway Timeout
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为888:服务摘机,不提供服务。 HTTP/1.1 888 888
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应参数 返回状态码为200:返回SLA服务列表信息。 表4 QuickDiagnosisResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - 0 错误码。0:成功;1000:失败;1001:参数错误。 - errorMsg string - - 错误消息 - sessionId string - - 任务ID - 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为403:URL鉴权。 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为406:流控限流。 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误。 详细信息请参见实际响应消息体。 返回状态码为502:网关错误。 详细信息请参见实际响应消息体。 返回状态码为503:服务不可用。 详细信息请参见实际响应消息体。 返回状态码为504:表示时间超时,总线超时时间300s。 详细信息请参见实际响应消息体。 返回状态码为888:服务摘机,不提供服务。 详细信息请参见实际响应消息体。
-
请求示例 cURL的示例 curl -k -s -L -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-AUTH-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/netslaservice/v1/quick-diagnosis' -d '{
"serviceId" : "11",
"sourceNeDn" : "NE=40000038",
"targetAddress" : "127.0.0.1",
"icmpEchoParam" : {
"vrfName" : "test",
"probeCount" : 3,
"interval" : 4,
"timeout" : 3,
"packetDataSize" : 500,
"packetData" : "test",
"maxTTL" : 30,
"tos" : 0,
"byPassRouteTable" : 2,
"sourceAddressType" : 1,
"sourceAddress" : "127.0.0.1",
"ifIndex" : ""
}
}' HTTP的示例 POST /rest/openapi/netslaservice/v1/quick-diagnosis HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AUTH-TOKEN: x-yyyyyy
{
"serviceId" : "11",
"sourceNeDn" : "NE=40000038",
"targetAddress" : "127.0.0.1",
"icmpEchoParam" : {
"vrfName" : "test",
"probeCount" : 3,
"interval" : 4,
"timeout" : 3,
"packetDataSize" : 500,
"packetData" : "test",
"maxTTL" : 30,
"tos" : 0,
"byPassRouteTable" : 2,
"sourceAddressType" : 1,
"sourceAddress" : "127.0.0.1",
"ifIndex" : ""
}
}
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 quickDiagnosisCondition 是 REFERENCE 详细请参见表2。 SLA任务诊断条件。 - 表2 QuickDiagnosisCondition对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 serviceId 是 string 0~30个字符。 - 服务类型。"11":ICMP Echo "11" sourceNeDn 是 string 1~64个字符。 - 设备Dn号。 "NE=40000038" targetAddress 是 string 1~64个字符。 - 目的IP,当前只支持IPV4 "127.0.0.1" icmpEchoParam 是 REFERENCE 详细请参见表3。 - - 表3 IcmpEchoParam对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vrfName 否 string 0~31个字符。 - 关联的VRF的名称 "test" probeCount 是 int32 [1-15] - 探测次数 3 interval 是 int32 [1-60] - 发包间隔(s) 4 timeout 是 int32 [1-60] - 超时时间(s) 3 packetDataSize 否 int32 [0-8100] - 报文填充大小(byte) 500 packetData 是 string 1~25个字符。满足正则表达[0-9a-zA-Z]*。 - 报文填充内容 "test" maxTTL 是 int32 [1-255] - 报文最大TTL 30 tos 否 int32 [0-255] - 报文TOS值 0 byPassRouteTable 是 int32 [1-2] - 绕过路由表选项,"1":是,"2":否。 2 sourceAddressType 否 int32 [1-1] - 源地址类型。1:IPV4地址 1 sourceAddress 否 string 1~64个字符。 - 源地址。当前只支持IPV4,缺省为设备发送接口IP。如果源地址类型为1,则必填。 "127.0.0.1" ifIndex 否 int32 - - 源接口索引 -
-
响应示例 返回状态码为200:返回SLA服务列表信息。 HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"errorCode": 0,
"errorMsg": "获取诊断结果成功",
"sessionId": "10010936",
"serviceId": "11",
"icmpEchoResult": {
"errorCode": 0,
"connectStatus": 1,
"lostPacketRatio": 0,
"rttAvg": 1,
"rttMax": 1,
"timeoutCount": 0
}
} 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为403:URL鉴权。 HTTP/1.1 403 Forbidden
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为404:rest接口没找到。 HTTP/1.1 404 Not Found
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为406:流控限流。 HTTP/1.1 406 Not Acceptable
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:默认ServiceException异常码,应用内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为502:网关错误。 HTTP/1.1 502 Bad Gateway
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为503:服务不可用。 HTTP/1.1 503 Service Unavailable
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为504:表示时间超时,总线超时时间300s。 HTTP/1.1 504 Gateway Timeout
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为888:服务摘机,不提供服务。 HTTP/1.1 888 888
Date: Sat,30 Mar 2019 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应参数 返回状态码为200:返回SLA服务列表信息。 表2 QuickDiagnosisResultResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 任务状态码。0:成功;1:部分成功;2:失败;1000:执行中或sessionid过期 - errorMsg string - - 错误消息 - sessionId string - - 任务ID - serviceId string - - 服务类型 - icmpEchoResult REFERENCE 详细请参见表3。 - - 表3 IcmpEchoResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 错误码,0成功,1默认错误,2设备离线或SNMP参数错误,3任务超时,4SNMP参数错误,5测试用例不存在,6参数设置错误 - connectStatus int32 - - 连通状态码,0未知错误,1成功,2失败 - lostPacketRatio int32 [0-100] - 丢包率(%) - rttAvg int32 - - 往返时延平均值(ms) - rttMax int32 - - 往返时延最大值(ms) - timeoutCount int32 - - 超时次数 - 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为403:URL鉴权。 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为406:流控限流。 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误。 详细信息请参见实际响应消息体。 返回状态码为502:网关错误。 详细信息请参见实际响应消息体。 返回状态码为503:服务不可用。 详细信息请参见实际响应消息体。 返回状态码为504:表示时间超时,总线超时时间300s。 详细信息请参见实际响应消息体。 返回状态码为888:服务摘机,不提供服务。 详细信息请参见实际响应消息体。
-
请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-AUTH-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/netslaservice/v1/quick-diagnosis/{session-id}/results' HTTP的示例 GET /rest/openapi/netslaservice/v1/quick-diagnosis/{session-id}/results HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AUTH-TOKEN: x-yyyyyy