如何调用GetMonitorItem_云网管(CMN)-阿里云帮助中心

根据监控项ID查询监控项详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cmn:GetMonitorItem	get	MonitorItem acs:cmn:{#regionId}:{#accountId}:monitoritem/{#MonitorItemId}	无	无

请求参数

名称	类型	必填	描述	示例值
MonitorItemId	string	是	监控项 ID	m-598zb0r9z3f44cfr
InstanceId	string	是	实例 ID	cmn-cn-xxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
MonitorItem	object	数据
AnalysisCode	string	解析代码	/\n Parsing logic\n @param: output :Collect raw data\n/\nfunction parse(output){\n var results = {}
CollectionType	string	采集类型	PING
Config	string	监控项参数配置	{\"Interval\":1000,\"PackNum\":30}
DataItem	string	数据项	avg_latency
MonitorItemDescription	string	监控项描述	监控连通性
Effective	integer	是否启用	1
ExecInterval	integer	执行间隔(s)	60
CreateTime	string	创建时间	2023-06-22 02:37:19
UpdateTime	string	修改时间	2023-06-22 02:37:19
MonitorItemId	string	监控项 ID	m-598zb0r9z3f44cfr
MonitorItemName	string	监控项名称	连通性监控
SecurityDomain	string	安全域	*
DeviceForm	string	设备形态	网络设备
AlarmRuleList	array<object>	通用告警规则列表
	object	告警规则列表
AlarmStatus	string	告警规则	CRITICAL
Variable	string	指标名	loss_rate
Expression	string	表达式	>=
Value	string	比较值	10
Type	string	类型	SINGLE
PersonalizedAlarmRuleList	array<object>	个性化告警规则列表
	object
AlarmStatus	string	告警规则	CRITICAL
Variable	string	指标名	loss_rate
Expression	string	表达式	>=
Value	string	类型	20
FieldName	string	个性化对象类型	role
FieldValue	string	个性化对象值	ASW
RequestId	string	Id of the request	94EDA8CB-57C7-57F6-9193-26E701348ADB

示例

正常返回示例

JSON格式

{
  "MonitorItem": {
    "AnalysisCode": "/**\\n** Parsing logic\\n** @param: output :Collect raw data\\n**/\\nfunction parse(output){\\n    var results = {}",
    "CollectionType": "PING",
    "Config": "{\\\"Interval\\\":1000,\\\"PackNum\\\":30}",
    "DataItem": "avg_latency",
    "MonitorItemDescription": "监控连通性",
    "Effective": 1,
    "ExecInterval": 60,
    "CreateTime": "2023-06-22 02:37:19",
    "UpdateTime": "2023-06-22 02:37:19\n",
    "MonitorItemId": "m-598zb0r9z3f44cfr",
    "MonitorItemName": "连通性监控",
    "SecurityDomain": "*",
    "DeviceForm": "网络设备",
    "AlarmRuleList": [
      {
        "AlarmStatus": "CRITICAL",
        "Variable": "loss_rate",
        "Expression": ">=",
        "Value": "10"
      }
    ],
    "Type": "SINGLE",
    "PersonalizedAlarmRuleList": [
      {
        "AlarmStatus": "CRITICAL",
        "Variable": "loss_rate",
        "Expression": ">=",
        "Value": "20",
        "FieldName": "role",
        "FieldValue": "ASW"
      }
    ]
  },
  "RequestId": "94EDA8CB-57C7-57F6-9193-26E701348ADB"
}

错误码

HTTP status code	错误码	错误信息	描述
400	SignatureDoesNotMatch	签名不通过	-
403	NoPermission	没有权限	-
404	Invalid%s.NotFound	The specified resource %s does not exist.	找不到对应资源
404	ServiceNotFound	后端服务未找到	-
500	InternalError	服务器内部错误	-
503	ServiceUnavailable	服务不可用	-

访问错误中心查看更多错误码。