事件监控
查询云产品事件
接口描述
获取用户相关的云产品事件信息列表。
权限说明
所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成,均为字符串。 对于每个HTTP请求,使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}。
- version是正整数。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号(;)分隔,如host;x-bce-date。列表按照字典序排列。(本API签名仅使用host和x-bce-date两个header)
- signature是256位签名的十六进制表示,由64个小写字母组成。
当百度智能云接收到用户的请求后,系统将使用相同的SK和同样的认证机制生成认证字符串,并与用户请求中包含的认证字符串进行比对。如果认证字符串相同,系统认为用户拥有指定的操作权限,并执行相关操作;如果认证字符串不同,系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见 鉴权认证。
请求结构
1GET /event-api/v1/bce-event/list HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 | 
|---|---|---|---|---|
| pageNo | int | 是 | Query参数 | 分页页码 | 
| pageSize | int | 是 | Query参数 | 分页大小 | 
| startTime | String | 是 | Query参数 | 事件发生时间过滤条件, UTC日期表示,如 2019-01-01T00:00:00Z | 
| endTime | String | 是 | Query参数 | 事件结束时间过滤条件, UTC日期表示,如 2019-01-01T00:00:00Z | 
| accountId | String | 是 | Query参数 | 用户ID | 
| ascending | bool | 否 | Query参数 | 是否以事件发生时间正序排序,默认为倒序false | 
| scope | String | 否 | Query参数 | 事件所属云服务名 | 
| region | String | 否 | Query参数 | 事件所属地域过滤条件 | 
| eventLevel | String | 否 | Query参数 | 事件级别过滤条件,包括:CRITICAL、MAJOR、WARNING、NOTICE | 
| eventName | String | 否 | Query参数 | 事件名称精确搜索 | 
| eventAlias | String | 否 | Query参数 | 事件别名模糊搜索 | 
| resourceType | String | 否 | Query参数 | 事件影响实例所归属是产品子类型,如BCC子类型:Instance | 
| resourceId | String | 否 | Query参数 | 事件实例的实例Id,如BCC实例:i-SyZeMxxx | 
| eventId | String | 否 | Query参数 | 事件的唯一ID。如:999bbc21-2061-49e6-bb2a-fd3e6c5xxxxx | 
响应参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| pageNumber | int | 分页页码 | 
| pageSize | int | 分页大小 | 
| pageElements | int | 返回页面结果数量 | 
| last | boolean | 是否最后一页 | 
| first | boolean | 是否第一页 | 
| totalPages | int | 总页码数 | 
| totalElements | int | 总结果数量 | 
| content | List | 返回结果 | 
CloudEventData
| 参数名 | 类型 | 描述 | 
|---|---|---|
| accountId | String | 事件所属租户ID | 
| serviceName | String | 事件所属云服务名 | 
| region | String | 事件归属的区域名,默认为global | 
| resourceType | String | 事件归属的实例类型,用于后续区分不同类型云资源对象使用,默认为“instance” | 
| resourceId | String | 事件归属的实例Id | 
| eventId | String | 事件ID,用于标识一个事件。 | 
| eventType | String | 事件类型 | 
| eventLevel | EventLevel | 事件级别,[NOTICE/WARNING/MAJOR/CRITICAL] | 
| eventAlias | String | 事件别名 | 
| timestamp | String | 事件发生的时间戳,UTC格式 | 
| content | String | 事件内容 | 
请求示例
1GET /event-api/v1/bce-event/list?pageNo=1&pageSize=1&startTime=2022-01-01T00:00:00Z&endTime=2022-07-18T00:00:00Z
2Host: bcm.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
1{
2    "content": [
3        {
4            "accountId": "453bf9588c9e488f9ba2c9841290xxxx",  // 事件所属租户ID
5            "serviceName": "BCE_BCC", // 事件所属云服务名
6            "region": "bj", // 事件所属地域
7            "resourceType": "Instance", // 事件发生实例的资源类型
8            "resourceId": "i-SyZeMxxx", // 事件发生实例的实例ID
9            "eventId": "999bbc21-2061-49e6-bb2a-fd3e6c5xxxxx", // 事件ID
10            "eventType": "InstanceStateChange", // 事件名称
11            "eventLevel": "NOTICE", // 事件等级
12            "eventAlias": "BCC状态变化通知", // 事件名称中文
13            "timestamp": "2022-07-15T01:01:00Z", // 事件发生时间
14            "content": "{\"info\":\"BCC实例状态变化\",\"advice\":\"您的BCC实例i-SyZeMxxx状态已变更为运行中\"}" // 事件携带附加信息
15        },
16    ],
17    "query": null,
18    "fields": [],
19    "orderBy": [],
20    "pageNumber": 1,
21    "pageSize": 1,
22    "pageElements": 1,
23    "last": false,
24    "first": true,
25    "totalPages": 34,
26    "totalElements": 34
27}查询平台类事件
接口描述
获取用户相关的平台类事件信息列表。
权限说明
所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成,均为字符串。 对于每个HTTP请求,使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}。
- version是正整数。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号(;)分隔,如host;x-bce-date。列表按照字典序排列。(本API签名仅使用host和x-bce-date两个header)
- signature是256位签名的十六进制表示,由64个小写字母组成。
当百度智能云接收到用户的请求后,系统将使用相同的SK和同样的认证机制生成认证字符串,并与用户请求中包含的认证字符串进行比对。如果认证字符串相同,系统认为用户拥有指定的操作权限,并执行相关操作;如果认证字符串不同,系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见 鉴权认证。
请求结构
1GET /event-api/v1/platform-event/list HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 | 
|---|---|---|---|---|
| pageNo | int | 是 | Query参数 | 分页页码 | 
| pageSize | int | 是 | Query参数 | 分页大小 | 
| startTime | String | 是 | Query参数 | 事件发生时间过滤条件, UTC日期表示,如 2019-01-01T00:00:00Z | 
| endTime | String | 是 | Query参数 | 事件结束时间过滤条件, UTC日期表示,如 2019-01-01T00:00:00Z | 
| accountId | String | 是 | Query参数 | 用户ID | 
| ascending | bool | 否 | Query参数 | 是否以事件发生时间正序排序,默认为倒序false | 
| region | String | 否 | Query参数 | 事件所属地域过滤条件 | 
| eventLevel | String | 否 | Query参数 | 事件级别过滤条件,包括:CRITICAL、MAJOR、WARNING、NOTICE | 
| eventName | String | 否 | Query参数 | 事件名称精确搜索 | 
| eventAlias | String | 否 | Query参数 | 事件别名模糊搜索 | 
| eventId | String | 否 | Query参数 | 事件的唯一ID。如:999bbc21-2061-49e6-bb2a-fd3e6c5xxxxx | 
响应参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| pageNumber | int | 分页页码 | 
| pageSize | int | 分页大小 | 
| pageElements | int | 返回页面结果数量 | 
| last | boolean | 是否最后一页 | 
| first | boolean | 是否第一页 | 
| totalPages | int | 总页码数 | 
| totalElements | int | 总结果数量 | 
| content | List | 返回结果 | 
PlatformEventDataResponse
| 参数名 | 类型 | 描述 | 
|---|---|---|
| userId | String | 用户ID | 
| eventSource | String | 事件来源 | 
| eventName | String | 事件名称 | 
| timestamp | String | 事件发生的时间戳,UTC格式 | 
| eventId | String | 事件ID,用于标识一个事件。 | 
| region | String | 事件归属的区域名 | 
| az | String | 事件归属的可用区 | 
| eventLevel | EventLevel | 事件级别,[NOTICE/WARNING/MAJOR/CRITICAL] | 
| eventAlias | String | 事件别名 | 
| eventParentAlias | String | 父类型的事件名称 | 
| content | String | 事件内容 | 
| resources | List | 受影响的资源列表,选填 | 
PlatformResource
| 参数名 | 类型 | 描述 | 
|---|---|---|
| service | String | 服务名称 | 
| userId | String | 用户ID | 
| instanceId | String | 实例ID | 
| shortInstanceId | String | 短实例ID | 
| instanceName | String | 实例名称 | 
请求示例
1GET /event-api/v1/platform-event/list?pageNo=1&pageSize=1&startTime=2022-05-01T00:00:00Z&endTime=2022-07-18T00:00:00Z
2Host: bcm.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
1{
2    "content": [
3        {
4            "userId": "453bf9588c9e488f9ba2c9841290xxxx", // 事件所属租户ID,为*时代表该事件影响所有用户
5            "eventSource": "Platform", // 事件来源
6            "eventName": "RD_NET_ERROR", // 事件名称
7            "timestamp": "2022-07-17T01:30:29Z", // 事件发生时间
8            "eventId": "999bbc21-2061-49e6-bb2a-fd3e6c5xxxxx", // 事件ID
9            "region": "bj", // 事件所属地域
10            "az": "[\"zoneB\",\"zoneA\"]", // 事件影响可用区,可能为空。
11            "eventLevel": "CRITICAL", // 事件级别
12            "eventAlias": "RD网络异常", // 事件中文名称
13            "eventParentAlias": "", // 事件所属类别,如"抖动类"等。可为空。
14            "status": "ALARM", // 事件状态,NULL-该事件无状态、ALARM-警报状态、OK-恢复正常状态
15            "content": "{\"info\":\"platform-0714-005\",\"advice\":\"RD网络异常,请关注\",\"raw\":\"\"}", // 事件附加信息
16
17            // 事件所影响的范围
18            "resources": [
19                {
20                    "service": "BCE_BCC", // 所影响的云产品范围
21                    "userId": "453bf9588c9e488f9ba2c9841290xxxx",
22                    "instanceId": "43fs23jfsx9df220sDSf92fxxxxx", // 影响的实例ID,为"*"时表示影响定位不到具体的实例
23                    "shortInstanceId": "i-SyZeMxxx", // 影响的实例短ID,为空时表示影响定位不到具体的实例
24                    "instanceName": "i-SyZeMxxx" // 影响的实例名称,为空时表示影响定位不到具体的实例
25                }
26            ]
27        }
28    ],
29    "query": null,
30    "fields": [],
31    "orderBy": [],
32    "pageNumber": 1,
33    "pageSize": 1,
34    "pageElements": 1,
35    "last": false,
36    "first": true,
37    "totalPages": 100,
38    "totalElements": 100
39}报警策略
创建事件报警策略
接口描述
创建事件报警策略
请求结构
1POST /event-api/v1/accounts/{accountId}/services/{serviceName}/alarm-policies HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 | 
|---|---|---|---|---|
| serviceName | String | 是 | Path参数 | 事件所属的云产品 | 
| accountId | String | 是 | Path参数 | 用户ID | 
| alarmConfig | EventAlarmConfig | 是 | Body | 事件策略配置 | 
响应头域
除公共头域外,无其它特殊头域。
响应参数
无参数
请求示例
1{
2    "serviceName": "BCE_EDAP",  // 事件策略归属云产品
3    "name": "test-jobgroup",  // 事件策略名称
4    // 策略所关注的实例范围,必填
5    "resource": {
6        "region": "bj",
7        
8        // 多region全部实例需要填写,仅在全部实例类型策略生效
9        "regions": ["bj","bd"]
10        "type": "instance",
11        "monitorObjectType": "TAG"
12        "resources": [
13             {
14                "identifiers": [
15                    {
16                        "name": "tag-key",
17                        "value": "tag-value",
18                    }
19                ]
20            }
21        ]
22    },
23    // 用户配置关注的事件范围,必填
24    "eventFilter": {
25        "eventLevel": "*", 
26        "eventTypeList": [
27            "*"
28        ]
29    },
30    // 通知模板列表,必填
31    "incidentActions": [
32        "b22b97d6-72b4-4ac1-a86d-25d66375xxxx"
33    ],
34    "blockStatus": "NORMAL", // 该策略的通知状态,正常为"NORMAL",关闭通知时状态为"BLOCKED"
35    "accountId": "453bf9588c9e488f9ba2c9841290xxxx" // 策略所属用户Id,必填
36}附录
EventAlarmConfig
| 名称 | 类型 | 描述 | 
|---|---|---|
| serviceName | String | 策略所属云产品,必填 | 
| accountId | String | 策略所属用户Id,必填 | 
| name | String | 策略名称,用户自定义。用户在同一云产品下命名唯一。必填 | 
| resource | EventResourceFilter | 策略所关注的实例范围,必填 | 
| eventFilter | EventFilter | 用户配置关注的事件范围,必填 | 
| incidentActions | List | 通知模板列表,必填 | 
| blockStatus | String | 该策略的通知状态,正常为"NORMAL",关闭通知时状态为"BLOCKED" | 
EventResourceFilter
| 名称 | 类型 | 描述 | 
|---|---|---|
| region | String | 实例地域信息,必填 | 
| regions | List | 多region全部实例需要填写,仅在全部实例类型策略生效 | 
| type | String | 云产品的子产品类型,必填,默认值Instance。 | 
| monitorObjectType | MonitorObjectType | 策略所属云产品,必填 | 
| resources | List<EventResource> | 策略关注的具体实例信息,当monitorObjectType为ALL时,忽略 | 
EventFilter
| 名称 | 类型 | 描述 | 
|---|---|---|
| eventLevel | EventLevel | 关注事件级别,必填 | 
| eventTypeList | List | 用户配置关注的事件类型,可多选。全选为"*" | 
EventResource
| 名称 | 类型 | 描述 | 
|---|---|---|
| identifiers | Map<String,String> | 用户配置实例或者标签信息。实例:instanceId:i-vs3s24i;标签:tag-k-1:tag-v-1 | 
MonitorObjectType
| 值 | 描述 | 
|---|---|
| ALL | 全部实例 | 
| TAG | 针对指定标签生效 | 
| INSTANCE | 针对指定实例生效 | 
EventLevel
| 值 | 描述 | 
|---|---|
| * | 全部 | 
| NOTICE | 通知 | 
| WARNING | 警告 | 
| MAJOR | 预警 | 
| CRITICAL | 故障 | 
