获取微告警主机列表

最近更新时间: 2026-09-17 00:02:50

1. 接口描述

接口请求域名： cwp.api3.fincloud.tencent.cn。

获取微告警主机列表

默认接口请求频率限制：20次/秒。

接口更新时间：0001-01-01 00:00:00。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeMaHostList
Version	是	否	String	公共参数，本接口取值：2018-02-28
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
By	否	否	String	可选排序列: [CreateTime] 示例值： CreateTime
Filters	否	否	Array of Filter	Name - string - 是否必填：否 - 主机名称 Id - string - 是否必填：否 - 主机ID InstanceId - string - 是否必填：否 - 实例ID Ip - string - 是否必填：否 - IP地址 OsType - string - 是否必填：否 - 操作系统 VpcId - string - 是否必填：否 - 所属网络 Region - string - 是否必填：否 - 地域 Label - string - 是否必填：否 - 关联标签 IsEnable - string - 是否必填：否 - 监控状态示例值：查看
Limit	否	否	Int64	限制条数,默认10,最大100 示例值： 10
Offset	否	否	Int64	偏移量,默认0 示例值： 0
Order	否	否	String	排序方式: [ASC:升序

3. 输出参数

参数名称	类型	描述
List	Array of MaHost	主机列表示例值：查看
TotalCount	Int64	总数示例值： 10
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
MissingParameter	缺少参数错误。
ResourceNotFound	资源不存在。
InvalidParameter	参数错误。
OperationDenied	操作被拒绝。
InvalidParameterValue	参数取值错误。

5. 示例

示例1 DescribeMaHostList

获取微告警主机列表

输入示例

POST / HTTP/1.1
Host: cwp.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeMaHostList
<Public request parameters>

{
 "By": "CreateTime",
 "Filters": [],
 "Limit": 0,
 "Offset": 0,
 "Order": "ASC"
}

输出示例

{
 "Response": {
  "List": [
   {
    "AlarmCount": 0,
    "HostIp": "192.168.0.1",
    "Id": 0,
    "InstanceId": "inst-anyinst",
    "IsEnabled": 0,
    "IsNew": 0,
    "Labels": [
     {
      "Id": 0,
      "Key": "46a44-46a44-46a44",
      "Source": "",
      "Value": "any value",
      "WorkloadCount": 0
     }
    ],
    "Name": "name1",
    "OsName": "name1",
    "PublicIp": "35.168.0.1",
    "Region": "region1",
    "Uuid": "5a540076-d38a-4078-aa98-qwert371d322",
    "VpcId": "102"
   }
  ],
  "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
  "TotalCount": 0
 }
}