创建监控项。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cmn:CreateMonitorItem | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MonitorItemName | string | 是 | 监控项名称 | CPU利用率监控 |
MonitorItemDescription | string | 是 | 监控项描述 | 监控CPU利用率 |
DataItem | string | 否 | 数据项 | avg_latency |
SecurityDomain | string | 是 | 安全域 | * |
AnalysisCode | string | 是 | 解析代码 | /**\n** Parsing logic\n** @param: output :Collect raw data\n\n1.3.6.1.4.1.12356.101.13.2.1.1.12\n**/\n\n\nfunction parse(output){\n \tvar results = {} |
CollectionType | string | 是 | 采集类型 | SNMP |
Effective | integer | 是 | 是否启用 | 1 |
Config | string | 是 | 监控项参数配置 | {\"Type\":\"snmpwalk\"} |
ExecInterval | integer | 是 | 执行间隔(s) | 60 |
DeviceForm | string | 否 | 设备形态 | 网络设备 |
AlarmRuleList | array<object> | 否 | 告警规则列表 | |
object | 否 | 监控项 | ||
AlarmStatus | string | 是 | 告警状态 | CRITICAL |
Variable | string | 是 | 指标名 | avg_latency |
Expression | string | 是 | 表达式 | > |
Value | string | 是 | 比较值 | 100 |
Type | string | 是 | 类型 | SINGLE |
ClientToken | string | 是 | 幂等参数 | c6aaac41-8cfa-4952-bb1c-1ad9617ab23f |
InstanceId | string | 是 | 实例 ID | cmn-cn-xxxx |
返回参数
示例
正常返回示例
JSON
格式
{
"MonitorItemId": "m-c4k8xcdlxxc1x0p2",
"RequestId": "BC7E67AB-7653-505E-BB78-45486035E137"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Missing%s | You must specify the parameter %s. | 必填参数没有填。请检查调用时是否填写了此参数,并重试请求。 |
400 | InvalidParameter%s | The specified parameter %s is invalid. | 参数无效,请检查参数 |
400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. | 用了一个已经使用过的 ClientToken,但此次请求内容却又与上一次使用该 Token 的 request 不一样。 |
400 | Duplicate%s%s | The %s %s value is already occupied. | 资源属性值已经被占用 |
400 | QuotaTooMuch | Quota exceeds limit. | 资源配额超过限制。 |
400 | SignatureDoesNotMatch | 签名不通过 | - |
403 | NoPermission | 没有权限 | - |
404 | ServiceNotFound | 后端服务未找到 | - |
500 | InternalError | 服务器内部错误 | - |
503 | ServiceUnavailable | 服务不可用 | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-30 | OpenAPI 错误码发生变更 | 查看变更详情 |