自定义监控接口
创建名字空间
接口描述
创建一个自定义的名字空间,在该空间下可以创建自定义监控
请求结构
1POST /csm/api/v1/userId/{userId}/custom/namespaces/create HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 路径参数 |
namespace | Namespace | 自定义空间 | 是 | 请求体参数 |
Namespace
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
name | String | 名字空间名称 | 是 |
namespaceAlias | String | 空间别名 | 否 |
userId | String | 用户Id | 是 |
comment | String | 说明 | 是 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/create
2// request body
3{
4 // 自定义空间名称
5 "name":"Test01",
6 // 自定义空间别名
7 "namespaceAlias":"test",
8 // 自定义空间描述
9 "comment":"自定义监控测试",
10 // 账号ID
11 "userId":"453bf9588c9e488f9ba2c9841290xxxx"
12}
响应示例
1// success
2http的返回码为200
3
4// failure
5{
6 //请求ID
7 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
8 // 错误代码
9 "code": "AUTHORIZATION_ERROR",
10 // 错误原因
11 "message": "Forbidden"
12}
删除名字空间
接口描述
删除自定义的名字空间
请求结构
1POST /csm/api/v1/userId/{userId}/custom/namespaces/delete HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 说明 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 路径参数 |
names | BatchNames | 空间名称集合 | 是 | 请求体参数 |
BatchNames
名称 | 类型 | 说明 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
names | List< Stirng > | 名字空间名称 | 是 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/delete
2// request body
3{
4 // 账号ID
5 "userId":"453bf9588c9e488f9ba2c9841290xxxx",
6 // 名字空间名称
7 "names":[
8 "Test01",
9 "Test02"
10 ]
11}
响应示例
1// success
2http的返回码为200
3
4// failure
5{
6 //请求ID
7 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
8 // 错误代码
9 "code": "AUTHORIZATION_ERROR",
10 // 错误原因
11 "message": "Forbidden"
12}
编辑名字空间
接口描述
编辑某个自定义的名字空间
请求结构
1PUT /csm/api/v1/userId/{userId}/custom/namespaces/update HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 路径参数 |
namespace | Namespace | 自定义空间 | 是 | 请求体参数 |
Namespace
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
name | String | 名字空间名称 | 是 |
namespaceAlias | String | 空间别名 | 否 |
userId | String | 用户Id | 是 |
comment | String | 说明 | 是 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/update
2// request body
3{
4 "name":"Test01",
5 "namespaceAlias":"test",
6 "comment":"自定义监控测试update",
7 "userId":"453bf9588c9e488f9ba2c9841290xxxx"
8}
响应实例
1// success
2http的返回码为200
3
4// failure
5{
6 //请求ID
7 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
8 // 错误代码
9 "code": "AUTHORIZATION_ERROR",
10 // 错误原因
11 "message": "Forbidden"
12}
获取(搜索)名字空间
接口描述
获取或者搜索自定义的名字空间列表
请求结构
1GET /csm/api/v1/userId/{userId}/custom/namespaces/list HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 路径参数 |
name | String | 名字空间名称(模糊搜索时需要传递的参数) | 否 | 请求参数 |
pageNo | int | 页号 | 是 | 请求参数 |
pageSize | int | 页大小 | 是 | 请求参数 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1GET /csm/api/v1/userId/38bffb7f9dc0435390b0c24656cb734d/custom/namespaces/list?pageNo=1&pageSize=10
响应实例
1// success
2{
3 // 页号
4 "pageNo": 1,
5 // 每页大小
6 "pageSize": 10,
7 // 总数
8 "totalCount": 2,
9 "result": [
10 {
11 // 空间名称
12 "name": "Test01",
13 // 空间别名
14 "namespaceAlias": "test",
15 // 空间描述
16 "comment": "自定义监控测试",
17 // 账号ID
18 "userId": "453bf9588c9e488f9ba2c9841290xxxx",
19 // 指标
20 "metrics": [
21 {
22 // 指标名称
23 "name": "test",
24 // 指标别名
25 "alias": "ccc"
26 }
27 ],
28 // 事件
29 "eventConfigs": [
30 {
31 // 事件名称
32 "name": "cdcd",
33 // 事件别名
34 "alias": "ccc"
35 }
36 ]
37 },
38 {
39 "name": "Test02",
40 "namespaceAlias": "test",
41 "comment": "test",
42 "userId": "453bf9588c9e488f9ba2c9841290xxxx",
43 "metrics": [],
44 "eventConfigs": []
45 }
46 ]
47}
48
49// failure
50{
51 //请求ID
52 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
53 // 错误代码
54 "code": "AUTHORIZATION_ERROR",
55 // 错误原因
56 "message": "Forbidden"
57}
创建指标
接口描述
在某个自定义空间创建自定义的指标
请求结构
1POST /csm/api/v1/userId/{userId}/custom/namespaces/{namespace}/metrics/create HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 路径参数 |
namespace | String | 名字空间 | 是 | 路径参数 |
metricConfig | MetricConfig | 请求体参数 | 是 | 请求体参数 |
MetricConfig
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
namespace | String | 名字空间 | 是 |
metricName | Stirng | 指标名称 | 是 |
metricAlias | String | 指标别名 | 否 |
unit | String | 指标单位 | 否 |
cycle | int | 采集周期 | 是 |
userId | String | 用户Id | 是 |
dimensions | List< MetricDimension > | 维度 | 否 |
MetricDimension
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
name | String | 维度名称 | 是 |
alias | String | 维度别名 | 否 |
order | int | 维度序号 | 是 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/Test01/metrics/create
2// request body
3{
4 // 空间名称
5 "namespace":"Test06",
6 // 指标名称
7 "metricName":"TestMetric01",
8 // 指标别名
9 "metricAlias":"metric",
10 // 指标单位
11 "unit":"个",
12 // 指标采集周期
13 "cycle":60,
14 // 账号ID
15 "userId":"453bf9588c9e488f9ba2c9841290xxxx",
16 // 指标维度
17 "dimensions":[
18 {
19 // 维度序号
20 "order":0,
21 // 维度名称
22 "name":"clusterId",
23 // 维度别名
24 "alias":"clusterId"
25 }
26 ]
27}
响应实例
1// success
2http的返回码为200
3
4// failure
5{
6 //请求ID
7 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
8 // 错误代码
9 "code": "AUTHORIZATION_ERROR",
10 // 错误原因
11 "message": "Forbidden"
12}
删除(批量删除)指标
接口描述
在某个自定义空间删除自定义指标
请求结构
1POST /csm/api/v1/userId/{userId}/custom/namespaces/{namespace}/metrics/delete HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 路径参数 |
namespace | String | 名字空间 | 是 | 路径参数 |
ids | BatchIds | 指标ID集合对象 | 是 | 请求体参数 |
BatchIds
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
namespace | String | 名字空间 | 是 |
ids | List< Long > | 指标ID集合 | 是 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/Test01/metrics/delete
2// request body
3{
4 // 账号ID
5 "userId":"453bf9588c9e488f9ba2c9841290xxxx",
6 // 空间名称
7 "namespace":"Test01",
8 // 指标ID集合,可以通过指标详情或者指标列表接口获取
9 "ids":[
10 3129,
11 3128
12 ]
13}
响应实例
1// success
2http的返回码为200
3
4// failure
5{
6 //请求ID
7 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
8 // 错误代码
9 "code": "AUTHORIZATION_ERROR",
10 // 错误原因
11 "message": "Forbidden"
12}
编辑指标
接口描述
在某个自定义空间编辑自定义的指标
请求结构
1PUT /csm/api/v1/userId/{userId}/custom/namespaces/{namespace}/metrics/{metricName} HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 路径参数 |
namespace | String | 名字空间 | 是 | 路径参数 |
metricConfig | MetricConfig | 指标配置 | 是 | 请求体参数 |
MetricConfig
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
namespace | String | 名字空间 | 是 |
metricName | Stirng | 指标名称 | 是 |
metricAlias | String | 指标别名 | 否 |
unit | String | 指标单位 | 否 |
cycle | int | 采集周期 | 是 |
userId | String | 用户Id | 是 |
dimensions | List< MetricDimension > | 维度 | 否 |
MetricDimension
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
name | String | 维度名称 | 是 |
alias | String | 维度别名 | 否 |
order | int | 维度序号 | 是 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/Test01/metrics/TestMetric01
2// request body
3{
4 // 空间名称
5 "namespace":"Test01",
6 // 指标名称
7 "metricName":"TestMetric01",
8 // 指标别名
9 "metricAlias":"metric01",
10 // 指标单位
11 "unit":"个",
12 // 指标采集周期
13 "cycle":60,
14 // 账号ID
15 "userId":"453bf9588c9e488f9ba2c9841290xxxx",
16 // 指标维度
17 "dimensions":[
18 {
19 // 维度序号
20 "order":0,
21 // 维度名称
22 "name":"clusterId",
23 // 维度别名
24 "alias":"clusterId"
25 }
26 ]
27}
响应实例
1// success
2http的返回码为200
3
4// failure
5{
6 //请求ID
7 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
8 // 错误代码
9 "code": "AUTHORIZATION_ERROR",
10 // 错误原因
11 "message": "Forbidden"
12}
获取(搜索)指标
接口描述
获取或者搜索某个自定义的名字空间的指标列表
请求结构
1GET /csm/api/v1/userId/{userId}/custom/namespaces/metrics HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 路径参数 |
namespace | String | 名字空间 | 是 | 请求参数 |
metricName | String | 指标名称(模糊搜索时使用) | 否 | 请求参数 |
metricAlias | String | 指标别名(模糊搜索时使用) | 否 | 请求参数 |
pageNo | int | 页号 | 是 | 请求参数 |
pageSize | int | 页大小 | 是 | 请求参数 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/metrics?metricName=&metricAlias=&pageNo=1&pageSize=10&namespace=Test01
响应实例
1// success
2{
3 // 页号
4 "pageNo": 1,
5 // 每页大小
6 "pageSize": 10,
7 // 总数
8 "totalCount": 2,
9 "result": [
10 {
11 // 指标ID
12 "id": 3131,
13 // 空间名称
14 "namespace": "Test01",
15 // 指标名称
16 "metricName": "TestMetric01",
17 // 指标别名
18 "metricAlias": "test01",
19 // 指标单位
20 "unit": "个",
21 // 采集周期
22 "cycle": 60,
23 // 账号ID
24 "userId": "453bf9588c9e488f9ba2c9841290xxxx",
25 "dimensions": [
26 {
27 // 维度名称
28 "name": "ClusrerId",
29 // 维度别名
30 "alias": "集群id",
31 // 维度序号
32 "order": 0
33 }
34 ]
35 },
36 {
37 "id": 3130,
38 "namespace": "Test01",
39 "metricName": "TestMetric02",
40 "metricAlias": "test",
41 "unit": "个",
42 "cycle": 60,
43 "userId": "453bf9588c9e488f9ba2c9841290xxxx",
44 "dimensions": []
45 }
46 ]
47}
48
49// failure
50{
51 //请求ID
52 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
53 // 错误代码
54 "code": "AUTHORIZATION_ERROR",
55 // 错误原因
56 "message": "Forbidden"
57}
指标详情
接口描述
获取某个自定义名字空间的指标详情
请求结构
1GET /csm/api/v1/userId/{userId}/custom/namespaces/{namespace}/metrics/{metricName} HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 路径参数 |
namespace | String | 名字空间 | 是 | 路径参数 |
metricName | String | 指标名称 | 是 | 路径参数 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1Get /csm/api/v1/userId/38bffb7f9dc0435390b0c24656cb734d/custom/namespaces/Test06/metrics/Test02
响应实例
1// success
2{
3 // 指标ID
4 "id": 3131,
5 // 空间名称
6 "namespace": "Test01",
7 // 指标名称
8 "metricName": "TestMetric01",
9 // 指标别名
10 "metricAlias": "test01",
11 // 指标单位
12 "unit": "个",
13 // 采集周期
14 "cycle": 60,
15 // 账号ID
16 "userId": "453bf9588c9e488f9ba2c9841290xxxx",
17 "dimensions": [
18 {
19 // 维度名称
20 "name": "ClusrerId",
21 // 维度别名
22 "alias": "集群id",
23 // 维度序号
24 "order": 0
25 }
26 ]
27}
28
29// failure
30{
31 //请求ID
32 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
33 // 错误代码
34 "code": "AUTHORIZATION_ERROR",
35 // 错误原因
36 "message": "Forbidden"
37}
创建事件
接口描述
在某个自定义空间创建自定义的事件
请求结构
1POST /csm/api/v1/custom/event/configs/create HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
eventConfig | EventConfig | 事件配置 | 是 | 请求体参数 |
EventConfig
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
namespace | String | 名字空间 | 是 |
eventName | String | 事件名称 | 是 |
eventNameAlias | String | 事件别名 | 否 |
eventLevel | EventLevel | 事件级别 | 是 |
comment | String | 描述 | 否 |
EventLevel
值 | 描述 |
---|---|
NOTICE | 通知事件级别 |
MAJOR | 预警事件级别 |
WARNING | 警告事件级别 |
CRITICAL | 故障事件级别 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1POST /csm/api/v1/custom/event/configs/create
2// request body
3{
4 // 账号ID
5 "userId":"453bf9588c9e488f9ba2c9841290xxxx",
6 // 空间名称
7 "namespace":"Test01",
8 // 事件名称
9 "eventName":"TestEvent01",
10 // 事件别名
11 "eventNameAlias":"test",
12 // 事件等级
13 "eventLevel":"WARNING",
14 // 事件描述
15 "comment":"这是一个事件"
16}
响应实例
1// success
2http的返回码为200
3
4// failure
5{
6 //请求ID
7 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
8 // 错误代码
9 "code": "AUTHORIZATION_ERROR",
10 // 错误原因
11 "message": "Forbidden"
12}
删除(批量删除)事件
接口描述
在某个自定义空间删除自定义事件
请求结构
1POST /csm/api/v1/custom/event/configs/delete HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
names | BatchNames | 事件集合 | 是 | requestBody |
BatchNames
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
namespace | String | 名字空间 | 是 |
names | List< String > | 事件名称 | 是 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1POST /csm/api/v1/custom/event/configs/delete
2// request body
3{
4 // 账号ID
5 "userId":"453bf9588c9e488f9ba2c9841290xxxx",
6 // 空间名称
7 "namespace":"Test01",
8 // 事件名称集合
9 "names":[
10 // 事件名称
11 "TestEvent01",
12 "TestEvent02"
13 ]
14}
响应实例
1// success
2http的返回码为200
3
4// failure
5{
6 //请求ID
7 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
8 // 错误代码
9 "code": "AUTHORIZATION_ERROR",
10 // 错误原因
11 "message": "Forbidden"
12}
编辑事件
接口描述
在某个自定义空间编辑自定义的事件
请求结构
1POST /csm/api/v1/custom/event/configs/update HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
eventConfig | EventConfig | 事件配置 | 是 | 请求体参数 |
EventConfig
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户Id | 是 |
namespace | String | 名字空间 | 是 |
eventName | String | 事件名称 | 是 |
eventNameAlias | String | 事件别名 | 否 |
eventLevel | EventLevel | 事件级别 | 是 |
comment | String | 描述 | 否 |
EventLevel
值 | 描述 |
---|---|
NOTICE | 通知事件级别 |
MAJOR | 预警事件级别 |
WARNING | 警告事件级别 |
CRITICAL | 故障事件级别 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1POST /csm/api/v1/custom/event/configs/update
2// request body
3{
4 // 账号ID
5 "userId":"453bf9588c9e488f9ba2c9841290xxxx",
6 // 空间名称
7 "namespace":"Test01",
8 // 事件名称
9 "eventName":"TestEvent01",
10 // 事件别名
11 "eventNameAlias":"test01",
12 // 事件等级
13 "eventLevel":"WARNING",
14 // 事件描述
15 "comment":"这是一个事件"
16}
响应实例
1// success
2http的返回码为200
3
4// failure
5{
6 //请求ID
7 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
8 // 错误代码
9 "code": "AUTHORIZATION_ERROR",
10 // 错误原因
11 "message": "Forbidden"
12}
获取(搜索)事件
接口描述
获取或者搜索某个自定义名字空间的事件列表
请求结构
1GET /csm/api/v1/custom/event/configs/list HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 请求参数 |
namespace | String | 名字空间 | 是 | 请求参数 |
name | String | 事件名称(模糊搜索时使用) | 否 | 请求参数 |
eventLevel | EventLevel | 报警级别(按报警级别筛选) | 否 | 请求参数 |
pageNo | int | 页号 | 是 | 请求参数 |
pageSize | int | 页大小 | 是 | 请求参数 |
EventLevel
值 | 描述 |
---|---|
NOTICE | 通知事件级别 |
MAJOR | 预警事件级别 |
WARNING | 警告事件级别 |
CRITICAL | 故障事件级别 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1GET /csm/api/v1/custom/event/configs/list?userId=453bf9588c9e488f9ba2c9841290xxxx&namespace=Test01&pageNo=1&pageSize=10
响应实例
1// success
2{
3 // 页号
4 "pageNo": 1,
5 // 每页大小
6 "pageSize": 10,
7 // 总数
8 "totalCount": 2,
9 "result": [
10 {
11 // 账号ID
12 "userId":"453bf9588c9e488f9ba2c9841290xxxx",
13 // 空间名称
14 "namespace":"Test01",
15 // 事件名称
16 "eventName":"TestEvent01",
17 // 事件别名
18 "eventNameAlias":"test01",
19 // 事件等级
20 // 通知 NOTICE
21 // 预警 MAJOR
22 // 警告 WARNING
23 // 故障 CRITICAL
24 "eventLevel":"WARNING",
25 // 事件描述
26 "comment":"这是一个事件"
27 },
28 {
29 "userId": "453bf9588c9e488f9ba2c9841290xxxx",
30 "namespace": "Test01",
31 "eventName": "TestEvent02",
32 "eventNameAlias": "test02",
33 "eventLevel": "WARNING",
34 "comment": "这是一个事件"
35 }
36 ]
37}
38
39// failure
40{
41 //请求ID
42 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
43 // 错误代码
44 "code": "AUTHORIZATION_ERROR",
45 // 错误原因
46 "message": "Forbidden"
47}
事件详情
接口描述
获取某个自定义名字空间的事件详情
请求结构
1GET /csm/api/v1/custom/event/configs/detail HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
接口描述
除公共头域外,无其它特殊头域
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | 请求参数 |
namespace | String | 名字空间 | 是 | 请求参数 |
eventName | String | 事件名称 | 是 | 请求参数 |
响应头域
除公共头域外,无其它特殊头域
请求示例
1GET /csm/api/v1/custom/event/configs/detail?userId=453bf9588c9e488f9ba2c9841290xxxx&namespace=Test01&eventName=TestEvent01
响应实例
1// success
2{
3 // 账号ID
4 "userId":"453bf9588c9e488f9ba2c9841290xxxx",
5 // 空间名称
6 "namespace":"Test01",
7 // 事件名称
8 "eventName":"TestEvent01",
9 // 事件别名
10 "eventNameAlias":"test01",
11 // 事件等级,
12 // 通知 NOTICE
13 // 预警 MAJOR
14 // 警告 WARNING
15 // 故障 CRITICAL
16 "eventLevel":"WARNING",
17 // 事件描述
18 "comment":"这是一个事件"
19}
20
21// failure
22{
23 //请求ID
24 "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
25 // 错误代码
26 "code": "AUTHORIZATION_ERROR",
27 // 错误原因
28 "message": "Forbidden"
29}
创建策略
请求结构体
- Method:Post
- Url:/csm/api/v1/custom/alarm/configs/create
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | requestBody |
actionEnabled | Boolean | 是否启动 | 是 | requestBody |
okActions | List< String > | 异常恢复报警动作 | 否 | requestBody |
alarmActions | List< String > | 异常报警动作 | 否 | requestBody |
insufficientActions | List< String > | 数据不足报警动作 | 否 | requestBody |
region | String | 地区 | 否 | requestBody |
namespace | String | 名字空间 | 是 | requestBody |
alarmName | String | 策略名称 | 是 | requestBody |
level | String | 报警级别,NOTICE:通知 WARNING:警告 CRITICAL:严重 MAJOR:重要。 | 是 | requestBody |
insufficientCycle | int | 无数据报警判断周期 | 否 | requestBody |
rules | List< CustomAlarmRule > | 报警规则 | 是 | requestBody |
policyEnabled | Boolean | 策略是否生效 | 否 | requestBody |
callbackUrl | String | 报警回调地址 | 否 | requestBody |
callbackToken | String | 报警回调token | 否 | requestBody |
repeatAlarmCycle | Int | 重复提醒周期 | 否 | requestBody |
maxRepeatCount | Int | 重复提醒次数 | 否 | requestBody |
CustomAlarmRule
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
metricName | String | 指标名称 | 是 |
cycle | int | 报警判断周期 | 是 |
statistics | String | 值类型,平均值,最大值,最小值,和值 | 是 |
threshold | String | 阈值 | 是 |
comparisonOperator | String | 比较符 | 是 |
count | int | 异常发生次数 | 是 |
function | String | THRESHOLD | 是 |
index | int | 报警规则序号 | 是 |
dimensions | List |
指标纬度 | 否 |
请求示例
1
2Post /csm/api/v1/custom/alarm/configs/create
3{
4 "userId":"38bffb7f9dc0435390b0c24656cb734d",
5 "actionEnabled":true,
6 "alarmActions":[
7 "e3b8e777-4f35-48ed-abf6-bfcf6316ae2c"
8 ],
9 "okActions":[
10
11 ],
12 "insufficientActions":[
13
14 ],
15 "callbackUrl":"http://www.baidu.com",
16 "callbackToken":"tXMWIhPonbFqdWjDxBKz",
17 "region":"bj",
18 "namespace":"Test06",
19 "alarmName":"policytest",
20 "level":"MAJOR",
21 "insufficientCycle":0,
22 "rules":[
23 {
24 "dimensions":[
25
26 ],
27 "metricName":"Test01",
28 "cycle":60,
29 "statistics":"average",
30 "threshold":"1",
31 "comparisonOperator":">",
32 "count":1,
33 "function":"THRESHOLD",
34 "index":1
35 }
36 ]
37}
响应实例
无响应参数,根据响应状态判断即可
删除(批量删除)策略
请求结构体
- Method:Post
- Url: /csm/api/v1/custom/alarm/configs/delete
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
customAlarmList | List<AlarmPolicyBatch> | 批量报警策略 | 是 | requestBody |
AlarmPolicyBatch
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
userId | String | 用户 Id | 是 |
scope | String | 名字空间 | 是 |
alarmName | List |
策略名称 | 是 |
请求示例
1Post /csm/api/v1/custom/alarm/configs/delete
2{
3 "customAlarmList": [
4 {
5 "scope": "cyn-928",
6 "userId": "453bf9588c9e488f9ba2c984129090dc",
7 "alarmName": [
8 "test-113017"
9 ]
10 }
11 ]
12}
响应实例
无响应参数,根据响应状态判断即可
编辑策略
请求结构体
- Method: Put
- Url: /csm/api/v1/custom/alarm/configs/update
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | requestBody |
actionEnabled | Boolean | 是否启动 | 是 | requestBody |
okActions | List< String > | 异常恢复报警动作 | 否 | requestBody |
alarmActions | List< String > | 异常报警动作 | 否 | requestBody |
insufficientActions | List< String > | 数据不足报警动作 | 否 | requestBody |
region | String | 地区 | 否 | requestBody |
namespace | String | 名字空间 | 是 | requestBody |
alarmName | String | 策略名称 | 是 | requestBody |
level | String | 报警级别,NOTICE:通知 WARNING:警告 CRITICAL:严重 MAJOR:重要。 | 是 | requestBody |
insufficientCycle | int | 无数据报警判断周期 | 否 | requestBody |
rules | List< CustomAlarmRule > | 报警规则 | 是 | requestBody |
policyEnabled | Boolean | 策略是否生效 | 否 | requestBody |
callbackUrl | String | 报警回调地址 | 否 | requestBody |
callbackToken | String | 报警回调token | 否 | requestBody |
repeatAlarmCycle | Int | 重复提醒周期 | 否 | requestBody |
maxRepeatCount | Int | 重复提醒次数 | 否 | requestBody |
CustomAlarmRule
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
metricName | String | 指标名称 | 是 |
cycle | int | 报警判断周期 | 是 |
statistics | String | 值类型,平均值,最大值,最小值,和值 | 是 |
threshold | String | 阈值 | 是 |
comparisonOperator | String | 比较符 | 是 |
count | int | 异常发生次数 | 是 |
function | String | THRESHOLD | 是 |
index | int | 报警规则序号 | 是 |
dimensions | List <MetricDimensions> | 指标纬度 | 否 |
请求示例
1Put /csm/api/v1/custom/alarm/configs/update
2{
3 "userId":"38bffb7f9dc0435390b0c24656cb734d",
4 "actionEnabled":true,
5 "alarmActions":[
6 "e3b8e777-4f35-48ed-abf6-bfcf6316ae2c"
7 ],
8 "okActions":[
9
10 ],
11 "insufficientActions":[
12
13 ],
14 "callbackUrl":"http://www.baidu.com",
15 "callbackToken":"yfaCqfTkQTeWxdDYLyBk",
16 "region":"bj",
17 "namespace":"Test06",
18 "alarmName":"Polict2",
19 "level":"MAJOR",
20 "insufficientCycle":0,
21 "rules":[
22 {
23 "dimensions":[
24
25 ],
26 "metricName":"Test01",
27 "cycle":60,
28 "statistics":"average",
29 "threshold":"1",
30 "comparisonOperator":">",
31 "count":1,
32 "function":"THRESHOLD",
33 "index":1
34 },
35 {
36 "dimensions":[
37
38 ],
39 "metricName":"Test01",
40 "cycle":60,
41 "statistics":"average",
42 "threshold":"2",
43 "comparisonOperator":">",
44 "count":1,
45 "function":"THRESHOLD",
46 "index":2
47 }
48 ]
49}
响应实例
无响应参数,根据响应状态判断即可
获取(搜索)策略
请求结构体
- Method:Get
- Url: /csm/api/v1/custom/alarm/configs/list
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
alarmName | String | 策略名称, 模糊搜索使用 | 否 | Query |
namespace | String | 名字空间 | 否 | Query |
actionEnabled | Boolean | 是否开启 | 否 | Query |
pageNo | int | 是 | Query | |
pageSize | int | 是 | Query |
请求示例
1Get /csm/api/v1/custom/alarm/configs/list?namespace=Test06&userId=38bffb7f9dc0435390b0c24656cb734d&pageNo=1&pageSize=10&alarmName=&actionEnabled=
响应实例
1{
2 "orderBy": "",
3 "order": "",
4 "pageNo": 1,
5 "pageSize": 10,
6 "totalCount": 1,
7 "result": [
8 {
9 "comment": "",
10 "userId": "38bffb7f9dc0435390b0c24656cb734d",
11 "alarmName": "Polict2",
12 "namespace": "Test06",
13 "level": "MAJOR",
14 "actionEnabled": true,
15 "policyEnabled": true,
16 "alarmActions": [
17 "scs报警"
18 ],
19 "okActions": [],
20 "insufficientActions": [],
21 "insufficientCycle": 0,
22 "rules": [
23 {
24 "id": null,
25 "index": 1,
26 "metricName": "Test01",
27 "dimensions": [],
28 "statistics": "average",
29 "threshold": "1",
30 "comparisonOperator": ">",
31 "cycle": 60,
32 "count": 1,
33 "function": "THRESHOLD"
34 },
35 {
36 "id": null,
37 "index": 2,
38 "metricName": "Test01",
39 "dimensions": [],
40 "statistics": "average",
41 "threshold": "2",
42 "comparisonOperator": ">",
43 "cycle": 60,
44 "count": 1,
45 "function": "THRESHOLD"
46 }
47 ],
48 "region": "bj",
49 "callbackUrl": "http://www.baidu.com",
50 "callbackToken": "yfaCqfTkQTeWxdDYLyBk",
51 "tag": ""
52 "repeatAlarmCycle": 0,
53 "maxRepeatCount": 0
54 }
55 ]
56}
策略详情
请求结构体
- Method:Get
- Url: /csm/api/v1/custom/alarm/configs/detail
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
namespace | String | 名字空间 | 是 | Query |
alarmName | String | 策略名称 | 是 | Query |
请求示例
1Get /csm/api/v1/custom/alarm/configs/detail?namespace=Test06&alarmName=Polict2&userId=38bffb7f9dc0435390b0c24656cb734d
响应实例
1{
2 "comment": "",
3 "userId": "38bffb7f9dc0435390b0c24656cb734d",
4 "alarmName": "Polict2",
5 "namespace": "Test06",
6 "level": "MAJOR",
7 "actionEnabled": true,
8 "policyEnabled": true,
9 "alarmActions": [
10 "e3b8e777-4f35-48ed-abf6-bfcf6316ae2c"
11 ],
12 "okActions": [],
13 "insufficientActions": [],
14 "insufficientCycle": 0,
15 "rules": [
16 {
17 "id": null,
18 "index": 1,
19 "metricName": "Test01",
20 "dimensions": [],
21 "statistics": "average",
22 "threshold": "1",
23 "comparisonOperator": ">",
24 "cycle": 60,
25 "count": 1,
26 "function": "THRESHOLD"
27 },
28 {
29 "id": null,
30 "index": 2,
31 "metricName": "Test01",
32 "dimensions": [],
33 "statistics": "average",
34 "threshold": "2",
35 "comparisonOperator": ">",
36 "cycle": 60,
37 "count": 1,
38 "function": "THRESHOLD"
39 }
40 ],
41 "region": "bj",
42 "callbackUrl": "http://www.baidu.com",
43 "callbackToken": "yfaCqfTkQTeWxdDYLyBk",
44 "tag": ""
45 "repeatAlarmCycle": 0,
46 "maxRepeatCount": 0
47}
关闭策略
请求结构体
- Method: Post
- Url: /csm/api/v1/custom/alarm/configs/block
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
namespace | String | 名字空间 | 是 | Query |
alarmName | String | 策略名称 | 是 | Query |
请求示例
1Post /csm/api/v1/custom/alarm/configs/block?namespace=Test06&userId=38bffb7f9dc0435390b0c24656cb734d&alarmName=Polict2
响应实例
无响应参数,根据响应状态判断即可
开启策略
请求结构体
- Method: Post
- Url: /csm/api/v1/custom/alarm/configs/unblock
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 用户Id | 是 | Query |
namespace | String | 名字空间 | 是 | Query |
alarmName | String | 策略名称 | 是 | Query |
请求示例
1Post /csm/api/v1/custom/alarm/configs/unblock?namespace=Test06&userId=38bffb7f9dc0435390b0c24656cb734d&alarmName=Polict2
响应实例
无响应参数,根据响应状态判断即可