自定义监控接口

更新时间：2024-01-23

创建名字空间

接口描述

创建一个自定义的名字空间，在该空间下可以创建自定义监控

请求结构

POST /csm/api/v1/userId/{userId}/custom/namespaces/create HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	路径参数
namespace	Namespace	自定义空间	是	请求体参数

Namespace

名称	类型	描述	是否必须
name	String	名字空间名称	是
namespaceAlias	String	空间别名	否
userId	String	用户Id	是
comment	String	说明	是

响应头域

除公共头域外，无其它特殊头域

请求示例

POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/create
// request body
{
    // 自定义空间名称
    "name":"Test01",
    // 自定义空间别名
    "namespaceAlias":"test",
    // 自定义空间描述
    "comment":"自定义监控测试",
    // 账号ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx"
}

响应示例

// success
http的返回码为200

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

删除名字空间

接口描述

删除自定义的名字空间

请求结构

POST /csm/api/v1/userId/{userId}/custom/namespaces/delete HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	说明	是否必须	参数位置
userId	String	用户Id	是	路径参数
names	BatchNames	空间名称集合	是	请求体参数

BatchNames

名称	类型	说明	是否必须
userId	String	用户Id	是
names	List< Stirng >	名字空间名称	是

响应头域

除公共头域外，无其它特殊头域

请求示例

POST  /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/delete
// request body
{
    // 账号ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
    // 名字空间名称
    "names":[
        "Test01",
        "Test02"
    ]
}

响应示例

// success
http的返回码为200

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

编辑名字空间

接口描述

编辑某个自定义的名字空间

请求结构

PUT /csm/api/v1/userId/{userId}/custom/namespaces/update HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	路径参数
namespace	Namespace	自定义空间	是	请求体参数

Namespace

名称	类型	描述	是否必须
name	String	名字空间名称	是
namespaceAlias	String	空间别名	否
userId	String	用户Id	是
comment	String	说明	是

响应头域

除公共头域外，无其它特殊头域

请求示例

PUT  /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/update
// request body
{
    "name":"Test01",
    "namespaceAlias":"test",
    "comment":"自定义监控测试update",
    "userId":"453bf9588c9e488f9ba2c9841290xxxx"
}

响应实例

// success
http的返回码为200

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

获取(搜索)名字空间

接口描述

获取或者搜索自定义的名字空间列表

请求结构

GET /csm/api/v1/userId/{userId}/custom/namespaces/list HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	路径参数
name	String	名字空间名称（模糊搜索时需要传递的参数）	否	请求参数
pageNo	int	页号	是	请求参数
pageSize	int	页大小	是	请求参数

响应头域

除公共头域外，无其它特殊头域

请求示例

GET /csm/api/v1/userId/38bffb7f9dc0435390b0c24656cb734d/custom/namespaces/list?pageNo=1&pageSize=10

响应实例

// success
{
    // 页号
    "pageNo": 1,
    // 每页大小
    "pageSize": 10,
    // 总数
    "totalCount": 2,
    "result": [
        {
            // 空间名称
            "name": "Test01",
            // 空间别名
            "namespaceAlias": "test",
            // 空间描述
            "comment": "自定义监控测试",
            // 账号ID
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
            // 指标
            "metrics": [
                {
                    // 指标名称
                    "name": "test",
                    // 指标别名
                    "alias": "ccc"
                }
            ],
            // 事件
            "eventConfigs": [
                {
                    // 事件名称
                    "name": "cdcd",
                    // 事件别名
                    "alias": "ccc"
                }
            ]
        },
        {
            "name": "Test02",
            "namespaceAlias": "test",
            "comment": "test",
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
            "metrics": [],
            "eventConfigs": []
        }
    ]
}

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

创建指标

接口描述

在某个自定义空间创建自定义的指标

请求结构

POST /csm/api/v1/userId/{userId}/custom/namespaces/{namespace}/metrics/create HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: 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	维度序号	是

响应头域

除公共头域外，无其它特殊头域

请求示例

POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/Test01/metrics/create
// request body
{
    // 空间名称
    "namespace":"Test06",
    // 指标名称
    "metricName":"TestMetric01",
    // 指标别名
    "metricAlias":"metric",
    // 指标单位
    "unit":"个",
    // 指标采集周期
    "cycle":60,
    // 账号ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
    // 指标维度
    "dimensions":[
        {
            // 维度序号
            "order":0,
            // 维度名称
            "name":"clusterId",
            // 维度别名
            "alias":"clusterId"
        }
    ]
}

响应实例

// success
http的返回码为200

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

删除(批量删除)指标

接口描述

在某个自定义空间删除自定义指标

请求结构

POST /csm/api/v1/userId/{userId}/custom/namespaces/{namespace}/metrics/delete HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	路径参数
namespace	String	名字空间	是	路径参数
ids	BatchIds	指标ID集合对象	是	请求体参数

BatchIds

名称	类型	描述	是否必须
userId	String	用户Id	是
namespace	String	名字空间	是
ids	List< Long >	指标ID集合	是

响应头域

除公共头域外，无其它特殊头域

请求示例

POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/Test01/metrics/delete
// request body
{
    // 账号ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
    // 空间名称
    "namespace":"Test01",
    // 指标ID集合，可以通过指标详情或者指标列表接口获取
    "ids":[
        3129,
        3128
    ]
}

响应实例

// success
http的返回码为200

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

编辑指标

接口描述

在某个自定义空间编辑自定义的指标

请求结构

PUT /csm/api/v1/userId/{userId}/custom/namespaces/{namespace}/metrics/{metricName} HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: 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	维度序号	是

响应头域

除公共头域外，无其它特殊头域

请求示例

PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/Test01/metrics/TestMetric01
// request body
{
    // 空间名称
    "namespace":"Test01",
    // 指标名称
    "metricName":"TestMetric01",
    // 指标别名
    "metricAlias":"metric01",
    // 指标单位
    "unit":"个",
    // 指标采集周期
    "cycle":60,
    // 账号ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
    // 指标维度
    "dimensions":[
        {
            // 维度序号
            "order":0,
            // 维度名称
            "name":"clusterId",
            // 维度别名
            "alias":"clusterId"
        }
    ]
}

响应实例

// success
http的返回码为200

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

获取（搜索）指标

接口描述

获取或者搜索某个自定义的名字空间的指标列表

请求结构

GET /csm/api/v1/userId/{userId}/custom/namespaces/metrics HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	路径参数
namespace	String	名字空间	是	请求参数
metricName	String	指标名称（模糊搜索时使用）	否	请求参数
metricAlias	String	指标别名（模糊搜索时使用）	否	请求参数
pageNo	int	页号	是	请求参数
pageSize	int	页大小	是	请求参数

响应头域

除公共头域外，无其它特殊头域

请求示例

GET /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/metrics?metricName=&metricAlias=&pageNo=1&pageSize=10&namespace=Test01

响应实例

// success
{
    // 页号
    "pageNo": 1,
    // 每页大小
    "pageSize": 10,
    // 总数
    "totalCount": 2,
    "result": [
        {
            // 指标ID
            "id": 3131,
            // 空间名称
            "namespace": "Test01",
            // 指标名称
            "metricName": "TestMetric01",
            // 指标别名
            "metricAlias": "test01",
            // 指标单位
            "unit": "个",
            // 采集周期
            "cycle": 60,
            // 账号ID
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
            "dimensions": [
                {
                    // 维度名称
                    "name": "ClusrerId",
                    // 维度别名
                    "alias": "集群id",
                    // 维度序号
                    "order": 0
                }
            ]
        },
        {
            "id": 3130,
            "namespace": "Test01",
            "metricName": "TestMetric02",
            "metricAlias": "test",
            "unit": "个",
            "cycle": 60,
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
            "dimensions": []
        }
    ]
}

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

指标详情

接口描述

获取某个自定义名字空间的指标详情

请求结构

GET /csm/api/v1/userId/{userId}/custom/namespaces/{namespace}/metrics/{metricName} HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	路径参数
namespace	String	名字空间	是	路径参数
metricName	String	指标名称	是	路径参数

响应头域

除公共头域外，无其它特殊头域

请求示例

Get  /csm/api/v1/userId/38bffb7f9dc0435390b0c24656cb734d/custom/namespaces/Test06/metrics/Test02

响应实例

// success
{
    // 指标ID
    "id": 3131,
    // 空间名称
    "namespace": "Test01",
    // 指标名称
    "metricName": "TestMetric01",
    // 指标别名
    "metricAlias": "test01",
    // 指标单位
    "unit": "个",
    // 采集周期
    "cycle": 60,
    // 账号ID
    "userId": "453bf9588c9e488f9ba2c9841290xxxx",
    "dimensions": [
        {
            // 维度名称
            "name": "ClusrerId",
            // 维度别名
            "alias": "集群id",
            // 维度序号
            "order": 0
        }
    ]
}

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

创建事件

接口描述

在某个自定义空间创建自定义的事件

请求结构

POST /csm/api/v1/custom/event/configs/create HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
eventConfig	EventConfig	事件配置	是	请求体参数

EventConfig

名称	类型	描述	是否必须
userId	String	用户Id	是
namespace	String	名字空间	是
eventName	String	事件名称	是
eventNameAlias	String	事件别名	否
eventLevel	EventLevel	事件级别	是
comment	String	描述	否

EventLevel

值	描述
NOTICE	通知事件级别
MAJOR	预警事件级别
WARNING	警告事件级别
CRITICAL	故障事件级别

响应头域

除公共头域外，无其它特殊头域

请求示例

POST /csm/api/v1/custom/event/configs/create
// request body
{
    // 账号ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
    // 空间名称
    "namespace":"Test01",
    // 事件名称
    "eventName":"TestEvent01",
    // 事件别名
    "eventNameAlias":"test",
    // 事件等级
    "eventLevel":"WARNING",
    // 事件描述
    "comment":"这是一个事件"
}

响应实例

// success
http的返回码为200

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

删除(批量删除)事件

接口描述

在某个自定义空间删除自定义事件

请求结构

POST /csm/api/v1/custom/event/configs/delete HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
names	BatchNames	事件集合	是	requestBody

BatchNames

名称	类型	描述	是否必须
userId	String	用户Id	是
namespace	String	名字空间	是
names	List< String >	事件名称	是

响应头域

除公共头域外，无其它特殊头域

请求示例

POST /csm/api/v1/custom/event/configs/delete
// request body
{
    // 账号ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
    // 空间名称
    "namespace":"Test01",
    // 事件名称集合
    "names":[
        // 事件名称
        "TestEvent01",
        "TestEvent02"
    ]
}

响应实例

// success
http的返回码为200

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

编辑事件

接口描述

在某个自定义空间编辑自定义的事件

请求结构

POST /csm/api/v1/custom/event/configs/update HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
eventConfig	EventConfig	事件配置	是	请求体参数

EventConfig

名称	类型	描述	是否必须
userId	String	用户Id	是
namespace	String	名字空间	是
eventName	String	事件名称	是
eventNameAlias	String	事件别名	否
eventLevel	EventLevel	事件级别	是
comment	String	描述	否

EventLevel

值	描述
NOTICE	通知事件级别
MAJOR	预警事件级别
WARNING	警告事件级别
CRITICAL	故障事件级别

响应头域

除公共头域外，无其它特殊头域

请求示例

POST /csm/api/v1/custom/event/configs/update
// request body
{
    // 账号ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
    // 空间名称
    "namespace":"Test01",
    // 事件名称
    "eventName":"TestEvent01",
    // 事件别名
    "eventNameAlias":"test01",
    // 事件等级
    "eventLevel":"WARNING",
    // 事件描述
    "comment":"这是一个事件"
}

响应实例

// success
http的返回码为200

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

获取（搜索）事件

接口描述

获取或者搜索某个自定义名字空间的事件列表

请求结构

GET /csm/api/v1/custom/event/configs/list HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	请求参数
namespace	String	名字空间	是	请求参数
name	String	事件名称（模糊搜索时使用）	否	请求参数
eventLevel	EventLevel	报警级别（按报警级别筛选）	否	请求参数
pageNo	int	页号	是	请求参数
pageSize	int	页大小	是	请求参数

EventLevel

值	描述
NOTICE	通知事件级别
MAJOR	预警事件级别
WARNING	警告事件级别
CRITICAL	故障事件级别

响应头域

除公共头域外，无其它特殊头域

请求示例

GET /csm/api/v1/custom/event/configs/list?userId=453bf9588c9e488f9ba2c9841290xxxx&namespace=Test01&pageNo=1&pageSize=10

响应实例

// success
{
    // 页号
    "pageNo": 1,
    // 每页大小
    "pageSize": 10,
    // 总数
    "totalCount": 2,
    "result": [
        {
            // 账号ID
            "userId":"453bf9588c9e488f9ba2c9841290xxxx",
            // 空间名称
            "namespace":"Test01",
            // 事件名称
            "eventName":"TestEvent01",
            // 事件别名
            "eventNameAlias":"test01",
            // 事件等级
            // 通知 NOTICE
            // 预警 MAJOR
            // 警告 WARNING
            // 故障 CRITICAL
            "eventLevel":"WARNING",
            // 事件描述
            "comment":"这是一个事件"
        },
        {
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
            "namespace": "Test01",
            "eventName": "TestEvent02",
            "eventNameAlias": "test02",
            "eventLevel": "WARNING",
            "comment": "这是一个事件"
        }
    ]
}

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

事件详情

接口描述

获取某个自定义名字空间的事件详情

请求结构

GET /csm/api/v1/custom/event/configs/detail HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string

接口描述

除公共头域外，无其它特殊头域

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	请求参数
namespace	String	名字空间	是	请求参数
eventName	String	事件名称	是	请求参数

响应头域

除公共头域外，无其它特殊头域

请求示例

GET /csm/api/v1/custom/event/configs/detail?userId=453bf9588c9e488f9ba2c9841290xxxx&namespace=Test01&eventName=TestEvent01

响应实例

// success
{
    // 账号ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
    // 空间名称
    "namespace":"Test01",
    // 事件名称
    "eventName":"TestEvent01",
    // 事件别名
    "eventNameAlias":"test01",
    // 事件等级， 
    // 通知 NOTICE
    // 预警 MAJOR
    // 警告 WARNING
    // 故障 CRITICAL
    "eventLevel":"WARNING",
    // 事件描述
    "comment":"这是一个事件"
}

// failure
{
    //请求ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
    // 错误代码
    "code": "AUTHORIZATION_ERROR",
    // 错误原因
    "message": "Forbidden"
}

创建策略

请求结构体

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	指标纬度	否

请求示例

 
Post /csm/api/v1/custom/alarm/configs/create
{
    "userId":"38bffb7f9dc0435390b0c24656cb734d", 
    "actionEnabled":true,
    "alarmActions":[
        "e3b8e777-4f35-48ed-abf6-bfcf6316ae2c" 
    ],
    "okActions":[

    ],
    "insufficientActions":[

    ],
    "callbackUrl":"http://www.baidu.com",
    "callbackToken":"tXMWIhPonbFqdWjDxBKz",
    "region":"bj",
    "namespace":"Test06",
    "alarmName":"policytest", 
    "level":"MAJOR",
    "insufficientCycle":0,
    "rules":[
        {
            "dimensions":[

            ],
            "metricName":"Test01",
            "cycle":60,
            "statistics":"average",
            "threshold":"1",
            "comparisonOperator":">",
            "count":1,
            "function":"THRESHOLD",
            "index":1
        }
    ]
}

响应实例

无响应参数，根据响应状态判断即可

删除(批量删除)策略

请求结构体

Method:Post
Url: /csm/api/v1/custom/alarm/configs/delete

请求参数

名称	类型	描述	是否必须	参数位置
customAlarmList	List<AlarmPolicyBatch>	批量报警策略	是	requestBody

AlarmPolicyBatch

名称	类型	描述	是否必须
userId	String	用户 Id	是
scope	String	名字空间	是
alarmName	List	策略名称	是

请求示例

Post /csm/api/v1/custom/alarm/configs/delete
{
    "customAlarmList": [
        {
            "scope": "cyn-928",
            "userId": "453bf9588c9e488f9ba2c984129090dc",
            "alarmName": [
                "test-113017"
            ]
        }
    ]
}

响应实例

无响应参数，根据响应状态判断即可

编辑策略

请求结构体

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>	指标纬度	否

请求示例

Put /csm/api/v1/custom/alarm/configs/update
{
    "userId":"38bffb7f9dc0435390b0c24656cb734d",
    "actionEnabled":true,
    "alarmActions":[
        "e3b8e777-4f35-48ed-abf6-bfcf6316ae2c"
    ],
    "okActions":[

    ],
    "insufficientActions":[

    ],
    "callbackUrl":"http://www.baidu.com",
    "callbackToken":"yfaCqfTkQTeWxdDYLyBk",
    "region":"bj",
    "namespace":"Test06",
    "alarmName":"Polict2",
    "level":"MAJOR",
    "insufficientCycle":0,
    "rules":[
        {
            "dimensions":[

            ],
            "metricName":"Test01",
            "cycle":60,
            "statistics":"average",
            "threshold":"1",
            "comparisonOperator":">",
            "count":1,
            "function":"THRESHOLD",
            "index":1
        },
        {
            "dimensions":[

            ],
            "metricName":"Test01",
            "cycle":60,
            "statistics":"average",
            "threshold":"2",
            "comparisonOperator":">",
            "count":1,
            "function":"THRESHOLD",
            "index":2
        }
    ]
}

响应实例

无响应参数，根据响应状态判断即可

获取（搜索）策略

请求结构体

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

请求示例

Get /csm/api/v1/custom/alarm/configs/list?namespace=Test06&userId=38bffb7f9dc0435390b0c24656cb734d&pageNo=1&pageSize=10&alarmName=&actionEnabled=

响应实例

{
    "orderBy": "",
    "order": "",
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 1,
    "result": [
        {
            "comment": "",
            "userId": "38bffb7f9dc0435390b0c24656cb734d",
            "alarmName": "Polict2",
            "namespace": "Test06",
            "level": "MAJOR",
            "actionEnabled": true,
            "policyEnabled": true,
            "alarmActions": [
                "scs报警"
            ],
            "okActions": [],
            "insufficientActions": [],
            "insufficientCycle": 0,
            "rules": [
                {
                    "id": null,
                    "index": 1,
                    "metricName": "Test01",
                    "dimensions": [],
                    "statistics": "average",
                    "threshold": "1",
                    "comparisonOperator": ">",
                    "cycle": 60,
                    "count": 1,
                    "function": "THRESHOLD"
                },
                {
                    "id": null,
                    "index": 2,
                    "metricName": "Test01",
                    "dimensions": [],
                    "statistics": "average",
                    "threshold": "2",
                    "comparisonOperator": ">",
                    "cycle": 60,
                    "count": 1,
                    "function": "THRESHOLD"
                }
            ],
            "region": "bj",
            "callbackUrl": "http://www.baidu.com",
            "callbackToken": "yfaCqfTkQTeWxdDYLyBk",
            "tag": ""
            "repeatAlarmCycle": 0,
            "maxRepeatCount": 0
        }
    ]
}

策略详情

请求结构体

Method:Get
Url: /csm/api/v1/custom/alarm/configs/detail

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	Query
namespace	String	名字空间	是	Query
alarmName	String	策略名称	是	Query

请求示例

Get /csm/api/v1/custom/alarm/configs/detail?namespace=Test06&alarmName=Polict2&userId=38bffb7f9dc0435390b0c24656cb734d

响应实例

{
    "comment": "",
    "userId": "38bffb7f9dc0435390b0c24656cb734d",
    "alarmName": "Polict2",
    "namespace": "Test06",
    "level": "MAJOR",
    "actionEnabled": true,
    "policyEnabled": true,
    "alarmActions": [
        "e3b8e777-4f35-48ed-abf6-bfcf6316ae2c"
    ],
    "okActions": [],
    "insufficientActions": [],
    "insufficientCycle": 0,
    "rules": [
        {
            "id": null,
            "index": 1,
            "metricName": "Test01",
            "dimensions": [],
            "statistics": "average",
            "threshold": "1",
            "comparisonOperator": ">",
            "cycle": 60,
            "count": 1,
            "function": "THRESHOLD"
        },
        {
            "id": null,
            "index": 2,
            "metricName": "Test01",
            "dimensions": [],
            "statistics": "average",
            "threshold": "2",
            "comparisonOperator": ">",
            "cycle": 60,
            "count": 1,
            "function": "THRESHOLD"
        }
    ],
    "region": "bj",
    "callbackUrl": "http://www.baidu.com",
    "callbackToken": "yfaCqfTkQTeWxdDYLyBk",
    "tag": ""
    "repeatAlarmCycle": 0,
     "maxRepeatCount": 0
}

关闭策略

请求结构体

Method: Post
Url: /csm/api/v1/custom/alarm/configs/block

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户Id	是	Query
namespace	String	名字空间	是	Query
alarmName	String	策略名称	是	Query

请求示例

Post /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

请求示例

Post /csm/api/v1/custom/alarm/configs/unblock?namespace=Test06&userId=38bffb7f9dc0435390b0c24656cb734d&alarmName=Polict2

响应实例

无响应参数，根据响应状态判断即可

通知模版

自定义监控-查询数据接口

云监控 BCM

自定义监控接口

创建名字空间

接口描述

请求结构

接口描述

请求参数

响应头域

请求示例

响应示例

删除名字空间

接口描述

请求结构

接口描述

请求参数

响应头域

请求示例

响应示例

编辑名字空间

接口描述

请求结构

接口描述

请求参数

响应头域

请求示例

响应实例

获取(搜索)名字空间

接口描述

请求结构

接口描述

请求参数

响应头域

请求示例

响应实例

创建指标

接口描述

请求结构

接口描述

请求参数

响应头域

请求示例

响应实例

删除(批量删除)指标

接口描述

请求结构

接口描述

请求参数

响应头域

请求示例

响应实例

编辑指标

接口描述

请求结构

接口描述

请求参数

响应头域

请求示例

响应实例

获取（搜索）指标

接口描述

请求结构

接口描述

请求参数

响应头域

请求示例

响应实例

指标详情

接口描述

请求结构

接口描述

请求参数

响应头域

请求示例

响应实例

创建事件

接口描述

请求结构

接口描述

请求参数

响应头域