事件监控
更新时间：2023-11-16
查询云产品事件
接口描述
获取用户相关的云产品事件信息列表。
权限说明
所有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和同样的认证机制生成认证字符串，并与用户请求中包含的认证字符串进行比对。如果认证字符串相同，系统认为用户拥有指定的操作权限，并执行相关操作；如果认证字符串不同，系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见 鉴权认证。
请求结构
GET /event-api/v1/bce-event/list HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: 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参数 | 事件别名模糊搜索 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无参数
请求示例
GET /event-api/v1/bce-event/list?pageNo=1&pageSize=1&startTime=2022-01-01T00:00:00Z&endTime=2022-07-18T00:00:00Z
Host: bcm.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
{
"content": [
{
"accountId": "xxx", // 事件所属租户ID
"serviceName": "BCE_billing", // 事件所属云服务名
"region": "global", // 事件所属地域
"resourceType": "Instance", // 事件发生实例的资源类型
"resourceId": "xxx", // 事件发生实例的实例ID
"eventId": "xxx", // 事件ID
"eventType": "ResourcesExpiration", // 事件名称
"eventLevel": "WARNING", // 事件等级
"eventAlias": "ResourcesExpiration", // 事件名称中文
"timestamp": "2022-07-15T01:01:00Z", // 事件发生时间
"content": "{\"info\":\"尊敬的客户您好，您有2个EIP资源将在1天后到期，到期后资源将停服，账号及资源详情见下方：AccountId: xxx。区域:bj,实例 ID:xxx;区域:bj,实例 ID:xxx\",\"advice\":\"如需要继续使用，请及时续费或开通自动续费；如预期不再使用，请提前备份数据，感谢您的支持\"}" // 事件携带附加信息
},
],
"query": null,
"fields": [],
"orderBy": [],
"pageNumber": 1,
"pageSize": 1,
"pageElements": 1,
"last": false,
"first": true,
"totalPages": 34,
"totalElements": 34
}查询平台类事件
接口描述
获取用户相关的平台类事件信息列表。
权限说明
所有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和同样的认证机制生成认证字符串，并与用户请求中包含的认证字符串进行比对。如果认证字符串相同，系统认为用户拥有指定的操作权限，并执行相关操作；如果认证字符串不同，系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见 鉴权认证。
请求结构
GET /event-api/v1/platform-event/list HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: 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参数 | 事件别名模糊搜索 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无参数
请求示例
GET /event-api/v1/platform-event/list?pageNo=1&pageSize=1&startTime=2022-05-01T00:00:00Z&endTime=2022-07-18T00:00:00Z
Host: bcm.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
{
"content": [
{
"userId": "xxx", // 事件所属租户ID，为*时代表该事件影响所有用户
"eventSource": "Platform", // 事件来源
"eventName": "RD_NET_ERROR", // 事件名称
"timestamp": "2022-07-17T01:30:29Z", // 事件发生时间
"eventId": "platform-0717-101", // 事件ID
"region": "bj", // 事件所属地域
"az": "[\"zoneB\",\"zoneA\"]", // 事件影响可用区，可能为空。
"eventLevel": "CRITICAL", // 事件级别
"eventAlias": "RD网络异常", // 事件中文名称
"eventParentAlias": "xxx", // 事件所属类别，如"抖动类"等。可为空。
"status": "ALARM", // 事件状态，NULL-该事件无状态、ALARM-警报状态、OK-恢复正常状态
"content": "{\"info\":\"platform-0714-005\",\"advice\":\"xxx\",\"raw\":\"\"}", // 事件附加信息
// 事件所影响的范围
"resources": [
{
"service": "BCE_BCC", // 所影响的云产品范围
"userId": "xxx",
"instanceId": "xxx", // 影响的实例ID，为"*"时表示影响定位不到具体的实例
"shortInstanceId": "xxx", // 影响的实例短ID，为空时表示影响定位不到具体的实例
"instanceName": "xxx" // 影响的实例名称，为空时表示影响定位不到具体的实例
}
],
"policyName": null
}
],
"query": null,
"fields": [],
"orderBy": [],
"pageNumber": 1,
"pageSize": 1,
"pageElements": 1,
"last": false,
"first": true,
"totalPages": 100,
"totalElements": 100
}报警策略
创建事件报警策略
接口描述
创建事件报警策略
请求结构
POST /event-api/v1/accounts/{accountId}/services/{serviceName}/alarm-policies HTTP/1.1
Host: bcm.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| endTime | String | 是 | Path参数 | 事件所属的云产品 |
| accountId | String | 是 | Path参数 | 用户ID |
| alarmConfig | EventAlarmConfig | 是 | Body | 事件策略配置 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无参数
请求示例
{
"serviceName": "BCE_EDAP",
"name": "test-jobgroup",
"resource": {
"region": "bj",
"type": "instance",
"monitorObjectType": "TAG"
"resources": [
{
"identifiers": [
{
"name": "tag-key",
"value": "tag-value",
}
]
}
]
},
"eventFilter": {
"eventLevel": "*",
"eventTypeList": [
"*"
]
},
"incidentActions": [
"b22b97d6-72b4-4ac1-a86d-25d6637564a1"
],
"blockStatus": "NORMAL",
"accountId": "453bf9588c9e488f9ba2c984129090dc"
}附录
EventAlarmConfig
| 名称 | 类型 | 描述 |
|---|---|---|
| serviceName | String | 策略所属云产品，必填 |
| accountId | String | 策略所属用户Id，必填 |
| name | String | 策略名称，用户自定义。用户在同一云产品下命名唯一。必填 |
| resource | EventResourceFilter | 策略所关注的实例范围，必填 |
| eventFilter | EventFilter | 用户配置关注的事件范围，必填 |
| incidentActions | List<String> | 通知模板列表，必填 |
| blockStatus | String | 该策略的通知状态，正常为"NORMAL",关闭通知时状态为"BLOCKED" |
EventResourceFilter
| 名称 | 类型 | 描述 |
|---|---|---|
| region | String | 实例地域信息，必填 |
| type | String | 云产品的子产品类型，必填，默认值Instance。 |
| monitorObjectType | MonitorObjectType | 策略所属云产品，必填 |
| resources | List<EventResource> | 策略关注的具体实例信息，当monitorObjectType为ALL时，忽略 |
EventFilter
| 名称 | 类型 | 描述 |
|---|---|---|
| eventLevel | EventLevel | 关注事件级别，必填 |
| eventTypeList | List<String> | 用户配置关注的事件类型，可多选。全选为"*" |
EventResource
| 名称 | 类型 | 描述 |
|---|---|---|
| identifiers | Map<String,String> | 用户配置实例或者标签信息。实例：instanceId:i-vs3s24i；标签：tag-k-1:tag-v-1 |
MonitorObjectType
| 值 | 描述 |
|---|---|
| ALL | 全部实例 |
| TAG | 针对指定标签生效 |
| INSTANCE | 针对指定实例生效 |
EventLevel
| 值 | 描述 |
|---|---|
| * | 全部 |
| NOTICE | 通知 |
| WARNING | 警告 |
| MAJOR | 预警 |
| CRITICAL | 故障 |