百度智能云
All Product Document

          Cloud Monitor

          • Cloud Monitor
          • >
          • API Reference
          • >
          • Custom Monitor Interface

          Custom Monitor Interface

          Last Updated：2025-11-14

          Create Scope

          API description

          Create a custom scope where custom monitoring can be established

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Path Parameters
          namespace Namespace Custom Scope Yes Parameters of request body

          Namespace

          Name Types Description Required or not
          name String Scope Name Yes
          namespaceAlias String Scope Alias No
          userId String User ID Yes
          comment String Description Yes

          Response headers

          No special headers beyond common headers.

          Request example

          POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/create
// request body
{
 // Custom Scope Name
    "name":"Test01",
 // Custom Scope Alias
    "namespaceAlias":"test",
 // Custom Scope Description
 "comment": "Custom Monitor Test",
 // Account ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx"
}

          Response example

          // success
 HTTP return code is 200
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Delete Scope

          API description

          Delete Custom Scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Path Parameters
          names BatchNames Scope Name Collection Yes Parameters of request body

          BatchNames

          Name Types Description Required or not
          userId String User ID Yes
          names List< Stirng > Scope Name Yes

          Response headers

          No special headers beyond common headers.

          Request example

          POST  /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/delete
// request body
{
 // Account ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
 // Scope Name
    "names":[
        "Test01",
        "Test02"
    ]
}

          Response example

          // success
 HTTP return code is 200
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Edit a scope

          API description

          Edit a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Path Parameters
          namespace Namespace Custom Scope Yes Parameters of request body

          Namespace

          Name Types Description Required or not
          name String Scope Name Yes
          namespaceAlias String Scope Alias No
          userId String User ID Yes
          comment String Description Yes

          Response headers

          No special headers beyond common headers.

          Request example

          PUT  /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/update
// request body
{
    "name":"Test01",
    "namespaceAlias":"test",
 "comment": "Custom Monitor test update",
    "userId":"453bf9588c9e488f9ba2c9841290xxxx"
}

          Response Instance

          // success
 HTTP return code is 200
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Retrieve (Search) Scope

          API description

          Retrieve or search for a list of custom scopes

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Path Parameters
          name String Scope Name (parameter required for fuzzy search) No Request parameters
          pageNo int Page Number Yes Request parameters
          pageSize int Page size Yes Request parameters

          Response headers

          No special headers beyond common headers.

          Request example

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

          Response Instance

          // success
{
 // Page Number
    "pageNo": 1,
 // Page size
    "pageSize": 10,
 // Total
    "totalCount": 2,
    "result": [
        {
 // Scope Name
            "name": "Test01",
 // Scope Alias
            "namespaceAlias": "test",
 // Scope Description
 "comment": "Custom Monitor Test",
 // Account ID
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
 // Metric
            "metrics": [
                {
 // Metric Name
                    "name": "test",
 // Metric Alias
                    "alias": "ccc"
                }
            ],
 // Event
            "eventConfigs": [
                {
 // Event name
                    "name": "cdcd",
 // Event Alias
                    "alias": "ccc"
                }
            ]
        },
        {
            "name": "Test02",
            "namespaceAlias": "test",
            "comment": "test",
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
            "metrics": [],
            "eventConfigs": []
        }
    ]
}
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Create Metric

          API description

          Create a custom metric in a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Path Parameters
          namespace String Scope Yes Path Parameters
          metricConfig MetricConfig Parameters of request body Yes Parameters of request body

          MetricConfig

          Name Types Description Required or not
          namespace String Scope Yes
          metricName Stirng Metric name Yes
          metricAlias String Metric Alias No
          unit String Metric unit No
          cycle int Collection Period Yes
          userId String User ID Yes
          dimensions List< MetricDimension > Dimension No

          MetricDimension

          Name Types Description Required or not
          name String Dimension name Yes
          alias String Alias for Dimension No
          order int Dimension Index Yes

          Response headers

          No special headers beyond common headers.

          Request example

          POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/Test01/metrics/create
// request body
{
 // Scope Name
    "namespace":"Test06",
 // Metric Name
    "metricName":"TestMetric01",
 // Metric Alias
    "metricAlias":"metric",
 // Metric Unit
 "unit": "unit",
 // Metric Collection Period
    "cycle":60,
 // Account ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
 // Metric Dimension
    "dimensions":[
        {
 // Dimension Index
            "order":0,
 // Dimension Name
            "name":"clusterId",
 // Alias for Dimension
            "alias":"clusterId"
        }
    ]
}

          Response Instance

          // success
 HTTP return code is 200
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Delete (Batch Delete) Metrics

          API description

          Delete a custom metric in a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Path Parameters
          namespace String Scope Yes Path Parameters
          ids BatchIds Metric ID Collection Object Yes Parameters of request body

          BatchIds

          Name Types Description Required or not
          userId String User ID Yes
          namespace String Scope Yes
          ids List< Long > Metric ID Collection Yes

          Response headers

          No special headers beyond common headers.

          Request example

          POST /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/Test01/metrics/delete
// request body
{
 // Account ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
 // Scope Name
    "namespace":"Test01",
 // Metric ID collection, obtainable via Metric details or Metric list API
    "ids":[
        3129,
        3128
    ]
}

          Response Instance

          // success
 HTTP return code is 200
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Edit Metric

          API description

          Edit custom metrics in a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Path Parameters
          namespace String Scope Yes Path Parameters
          metricConfig MetricConfig Metric Configuration Yes Parameters of request body

          MetricConfig

          Name Types Description Required or not
          namespace String Scope Yes
          metricName Stirng Metric name Yes
          metricAlias String Metric Alias No
          unit String Metric unit No
          cycle int Collection Period Yes
          userId String User ID Yes
          dimensions List< MetricDimension > Dimension No

          MetricDimension

          Name Types Description Required or not
          name String Dimension name Yes
          alias String Alias for Dimension No
          order int Dimension Index Yes

          Response headers

          No special headers beyond common headers.

          Request example

          PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c9841290xxxx/custom/namespaces/Test01/metrics/TestMetric01
// request body
{
 // Scope Name
    "namespace":"Test01",
 // Metric Name
    "metricName":"TestMetric01",
 // Metric Alias
    "metricAlias":"metric01",
 // Metric Unit
 "unit": "unit",
 // Metric Collection Period
    "cycle":60,
 // Account ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
 // Metric Dimension
    "dimensions":[
        {
 // Dimension Index
            "order":0,
 // Dimension Name
            "name":"clusterId",
 // Alias for Dimension
            "alias":"clusterId"
        }
    ]
}

          Response Instance

          // success
 HTTP return code is 200
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Retrieve (Search) Metrics

          API description

          Retrieve or search for a metric list of a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Path Parameters
          namespace String Scope Yes Request parameters
          metricName String Metric Name (for fuzzy search) No Request parameters
          metricAlias String Metric Alias (for fuzzy search) No Request parameters
          pageNo int Page Number Yes Request parameters
          pageSize int Page size Yes Request parameters

          Response headers

          No special headers beyond common headers.

          Request example

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

          Response Instance

          // success
{
 // Page Number
    "pageNo": 1,
 // Page size
    "pageSize": 10,
 // Total
    "totalCount": 2,
    "result": [
        {
 // Metric ID
            "id": 3131,
 // Scope Name
            "namespace": "Test01",
 // Metric Name
            "metricName": "TestMetric01",
 // Metric Alias
            "metricAlias": "test01",
 // Metric Unit
 "unit": "unit",
 // Collection Period
            "cycle": 60,
 // Account ID
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
            "dimensions": [
                {
 // Dimension Name
                    "name": "ClusrerId",
 // Alias for Dimension
 "alias": "Cluster ID",
 // Dimension Index
                    "order": 0
                }
            ]
        },
        {
            "id": 3130,
            "namespace": "Test01",
            "metricName": "TestMetric02",
            "metricAlias": "test",
 "unit": "unit",
            "cycle": 60,
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
            "dimensions": []
        }
    ]
}
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Metric details

          API description

          Retrieve Metric details for a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Path Parameters
          namespace String Scope Yes Path Parameters
          metricName String Metric name Yes Path Parameters

          Response headers

          No special headers beyond common headers.

          Request example

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

          Response Instance

          // success
{
 // Metric ID
    "id": 3131,
 // Scope Name
    "namespace": "Test01",
 // Metric Name
    "metricName": "TestMetric01",
 // Metric Alias
    "metricAlias": "test01",
 // Metric Unit
 "unit": "unit",
 // Collection Period
    "cycle": 60,
 // Account ID
    "userId": "453bf9588c9e488f9ba2c9841290xxxx",
    "dimensions": [
        {
 // Dimension Name
            "name": "ClusrerId",
 // Alias for Dimension
 "alias": "Cluster ID",
 // Dimension Index
            "order": 0
        }
    ]
}
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Create Event

          API description

          Create a custom event in a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          eventConfig EventConfig Event configuration Yes Parameters of request body

          EventConfig

          Name Types Description Required or not
          userId String User ID Yes
          namespace String Scope Yes
          eventName String Event name Yes
          eventNameAlias String Event alias No
          eventLevel EventLevel Event Level Yes
          comment String Description No

          EventLevel

          Value Description
          NOTICE Notification Event Level
          MAJOR Alert Event Level
          WARNING Warning Event Level
          CRITICAL Fault Event Level

          Response headers

          No special headers beyond common headers.

          Request example

          POST /csm/api/v1/custom/event/configs/create
// request body
{
 // Account ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
 // Scope Name
    "namespace":"Test01",
 // Event name
    "eventName":"TestEvent01",
 // Event Alias
    "eventNameAlias":"test",
 // Event Level
    "eventLevel":"WARNING",
 // Event Description
 "comment": "This is an event"
}

          Response Instance

          // success
 HTTP return code is 200
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Delete (Batch Delete) Events

          API description

          Delete a custom event in a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          names BatchNames Event Collection Yes requestBody

          BatchNames

          Name Types Description Required or not
          userId String User ID Yes
          namespace String Scope Yes
          names List< String > Event name Yes

          Response headers

          No special headers beyond common headers.

          Request example

          POST /csm/api/v1/custom/event/configs/delete
// request body
{
 // Account ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
 // Scope Name
    "namespace":"Test01",
 // Event name collection
    "names":[
 // Event name
        "TestEvent01",
        "TestEvent02"
    ]
}

          Response Instance

          // success
 HTTP return code is 200
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Edit event

          API description

          Edit a custom event in a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          eventConfig EventConfig Event configuration Yes Parameters of request body

          EventConfig

          Name Types Description Required or not
          userId String User ID Yes
          namespace String Scope Yes
          eventName String Event name Yes
          eventNameAlias String Event alias No
          eventLevel EventLevel Event Level Yes
          comment String Description No

          EventLevel

          Value Description
          NOTICE Notification Event Level
          MAJOR Alert Event Level
          WARNING Warning Event Level
          CRITICAL Fault Event Level

          Response headers

          No special headers beyond common headers.

          Request example

          POST /csm/api/v1/custom/event/configs/update
// request body
{
 // Account ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
 // Scope Name
    "namespace":"Test01",
 // Event name
    "eventName":"TestEvent01",
 // Event Alias
    "eventNameAlias":"test01",
 // Event Level
    "eventLevel":"WARNING",
 // Event Description
 "comment": "This is an event"
}

          Response Instance

          // success
 HTTP return code is 200
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Retrieve (Search) Events

          API description

          Retrieve or search for an event list of a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Request parameters
          namespace String Scope Yes Request parameters
          name String Event Name (for fuzzy search) No Request parameters
          eventLevel EventLevel Alarm Level (Filter by Alarm Level) No Request parameters
          pageNo int Page Number Yes Request parameters
          pageSize int Page size Yes Request parameters

          EventLevel

          Value Description
          NOTICE Notification Event Level
          MAJOR Alert Event Level
          WARNING Warning Event Level
          CRITICAL Fault Event Level

          Response headers

          No special headers beyond common headers.

          Request example

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

          Response Instance

          // success
{
 // Page Number
    "pageNo": 1,
 // Page size
    "pageSize": 10,
 // Total
    "totalCount": 2,
    "result": [
        {
 // Account ID
            "userId":"453bf9588c9e488f9ba2c9841290xxxx",
 // Scope Name
            "namespace":"Test01",
 // Event name
            "eventName":"TestEvent01",
 // Event Alias
            "eventNameAlias":"test01",
 // Event Level
 // Notification NOTICE
 // Alert MAJOR
 // Warning WARNING
 // Fault CRITICAL
            "eventLevel":"WARNING",
 // Event Description
 "comment": "This is an event"
        },
        {
            "userId": "453bf9588c9e488f9ba2c9841290xxxx",
            "namespace": "Test01",
            "eventName": "TestEvent02",
            "eventNameAlias": "test02",
            "eventLevel": "WARNING",
 "comment": "This is an event"
        }
    ]
}
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Event Details

          API description

          Retrieve event details for a custom scope

          Request structure

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

          API description

          No special headers beyond common headers.

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Request parameters
          namespace String Scope Yes Request parameters
          eventName String Event name Yes Request parameters

          Response headers

          No special headers beyond common headers.

          Request example

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

          Response Instance

          // success
{
 // Account ID
    "userId":"453bf9588c9e488f9ba2c9841290xxxx",
 // Scope Name
    "namespace":"Test01",
 // Event name
    "eventName":"TestEvent01",
 // Event Alias
    "eventNameAlias":"test01",
 // Event Level,
 // Notification NOTICE
 // Alert MAJOR
 // Warning WARNING
 // Fault CRITICAL
    "eventLevel":"WARNING",
 // Event Description
 "comment": "This is an event"
}
// failure
{
 //Request ID
    "requestId": "e841b060-1862-4a38-a414-416f407e9dfe",
 // Error Code
    "code": "AUTHORIZATION_ERROR",
 // Error Reason
    "message": "Forbidden"
}

          Create Strategy

          Request structure

          • Method:Post
          • Url:/csm/api/v1/custom/alarm/configs/create

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes requestBody
          actionEnabled Boolean Enabled or not Yes requestBody
          okActions List< String > Abnormal recovery alarm action No requestBody
          alarmActions List< String > Abnormal alarm action No requestBody
          insufficientActions List< String > Insufficient Data Alarm Action No requestBody
          region String Region No requestBody
          namespace String Scope Yes requestBody
          alarmName String Policy name Yes requestBody
          level String Alarm Levels: NOTICE: Notification WARNING: Warning CRITICAL: Critical MAJOR: Major. Yes requestBody
          insufficientCycle int No-data alarm judgment period No requestBody
          rules List< CustomAlarmRule > Alarm Rule Yes requestBody
          policyEnabled Boolean Is the strategy effective No requestBody
          callbackUrl String Alarm callback address No requestBody
          callbackToken String Alarm callback token No requestBody
          repeatAlarmCycle Int Repeat Reminder Period No requestBody
          maxRepeatCount Int Repeat Reminder Count No requestBody

          CustomAlarmRule

          Name Types Description Required or not
          metricName String Metric name Yes
          cycle int Alarm Judgment Period Yes
          statistics String Value types: average, maximum, minimum, sum Yes
          threshold String Threshold Yes
          comparisonOperator String Comparison Operator Yes
          count int Number of Abnormal Occurrences Yes
          function String THRESHOLD Yes
          index int Alarm Rule Number Yes
          dimensions List Metric Dimensions No

          Request example

          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
        }
    ]
}

          Response Instance

          No response parameters; judge by response status

          Delete (Batch Delete) Strategy

          Request structure

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

          Request parameters

          Name Types Description Required or not Parameter location
          customAlarmList List<AlarmPolicyBatch> Batch Alarm Strategy Yes requestBody

          AlarmPolicyBatch

          Name Types Description Required or not
          userId String User ID Yes
          scope String Scope Yes
          alarmName List Policy name Yes

          Request example

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

          Response Instance

          No response parameters; judge by response status

          Edit Strategy

          Request structure

          • Method: Put
          • Url: /csm/api/v1/custom/alarm/configs/update

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes requestBody
          actionEnabled Boolean Enabled or not Yes requestBody
          okActions List< String > Abnormal recovery alarm action No requestBody
          alarmActions List< String > Abnormal alarm action No requestBody
          insufficientActions List< String > Insufficient Data Alarm Action No requestBody
          region String Region No requestBody
          namespace String Scope Yes requestBody
          alarmName String Policy name Yes requestBody
          level String Alarm Levels: NOTICE: Notification WARNING: Warning CRITICAL: Critical MAJOR: Major. Yes requestBody
          insufficientCycle int No-data alarm judgment period No requestBody
          rules List< CustomAlarmRule > Alarm Rule Yes requestBody
          policyEnabled Boolean Is the strategy effective No requestBody
          callbackUrl String Alarm callback address No requestBody
          callbackToken String Alarm callback token No requestBody
          repeatAlarmCycle Int Repeat Reminder Period No requestBody
          maxRepeatCount Int Repeat Reminder Count No requestBody

          CustomAlarmRule

          Name Types Description Required or not
          metricName String Metric name Yes
          cycle int Alarm Judgment Period Yes
          statistics String Value types: average, maximum, minimum, sum Yes
          threshold String Threshold Yes
          comparisonOperator String Comparison Operator Yes
          count int Number of Abnormal Occurrences Yes
          function String THRESHOLD Yes
          index int Alarm Rule Number Yes
          dimensions List <MetricDimensions> Metric Dimensions No

          Request example

          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
        }
    ]
}

          Response Instance

          No response parameters; judge by response status

          Retrieve (Search) Strategy

          Request structure

          • Method:Get
          • Url: /csm/api/v1/custom/alarm/configs/list

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Query
          alarmName String Strategy Name (for fuzzy search) No Query
          namespace String Scope No Query
          actionEnabled Boolean Enabled or not No Query
          pageNo int Yes Query
          pageSize int Yes Query

          Request example

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

          Response Instance

          {
    "orderBy": "",
    "order": "",
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 1,
    "result": [
        {
            "comment": "",
            "userId": "38bffb7f9dc0435390b0c24656cb734d",
            "alarmName": "Polict2",
            "namespace": "Test06",
            "level": "MAJOR",
            "actionEnabled": true,
            "policyEnabled": true,
            "alarmActions": [
 "scs alarm"
            ],
            "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
        }
    ]
}

          Strategy Details

          Request structure

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

          Request parameters

          Name Type Description Required Parameter Position
          userId String User ID Yes Query
          namespace String Scope Yes Query
          alarmName String Strategy Name Yes Query

          Request example

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

          Response Instance

          {
    "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
}

          Disable Strategy

          Request structure

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

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Query
          namespace String Scope Yes Query
          alarmName String Policy name Yes Query

          Request example

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

          Response Instance

          No response parameters; judge by response status

          Enable Strategy

          Request structure

          • Method: Post
          • Url: /csm/api/v1/custom/alarm/configs/unblock

          Request parameters

          Name Types Description Required or not Parameter location
          userId String User ID Yes Query
          namespace String Scope Yes Query
          alarmName String Policy name Yes Query

          Request example

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

          Response Instance

          No response parameters; judge by response status

          Previous
          Custom Monitor - Query Data API
          Next
          Dashboard API