获取微告警自定义白名单

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

1. 接口描述

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

获取微告警自定义白名单

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeMaCustomPolicyList
Version	是	否	String	公共参数，本接口取值：2018-02-28
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
By	否	否	String	可选排序列: [CreateTime
Filters	否	否	Array of Filter	SrcLabelId - string - 是否必填：否 - 源标签id SrcLabelKey - string - 是否必填：否 - 源标签key SrcLabelValue - string - 是否必填：否 - 源标签value DestLabelId - string - 是否必填：否 - 目标标签id DestLabelKey - string - 是否必填：否 - 目标标签key DestLabelValue - string - 是否必填：否 - 目标标签value SrcIP - string - 是否必填：否 - 源IP DestIP - string - 是否必填：否 - 目标IP Enable - int64 - 是否必填：否 - 是否开启 Updater- string - 是否必填：否 - 创建人/更新人 Name - string - 是否必填：否 - 自定义白名单名称示例值：查看
Limit	否	否	Int64	限制条数,默认10,最大100 示例值： 10
Offset	否	否	Int64	偏移量,默认0 示例值： 0
Order	否	否	String	排序方式: [ASC:升序

3. 输出参数

参数名称	类型	描述
List	Array of MaCustomPolicy	自定义白名单策略集示例值：查看
TotalCount	Int64	总数示例值： 100
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 请求自定义策略

请求自定义策略

输入示例

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

{}

输出示例

{
 "Response": {
  "List": [
   {
    "ActionType": 0,
    "CreateTime": "2023-11-03 17:37:59",
    "DestHostWorkloadNum": 0,
    "DestIPs": [
     "1.1.1.12"
    ],
    "DestLabels": [],
    "DestPodWorkloadNum": 0,
    "DestPorts": [],
    "DestType": 1,
    "DestWorkloads": [],
    "Enable": 1,
    "Id": 13,
    "ModifyTime": "2023-11-03 19:12:51",
    "Name": "label56-11112",
    "SrcHostWorkloadNum": 0,
    "SrcIPs": [],
    "SrcLabels": [
     {
      "Id": 36,
      "Key": "app",
      "Source": "learn",
      "Value": "VM-64-49-tos"
     }
    ],
    "SrcPodWorkloadNum": 0,
    "SrcType": 0,
    "SrcWorkloads": [],
    "Updater": "c"
   },
   {
    "ActionType": 0,
    "CreateTime": "2023-11-03 19:16:36",
    "DestHostWorkloadNum": 0,
    "DestIPs": [
     "1.1.1.12"
    ],
    "DestLabels": [],
    "DestPodWorkloadNum": 0,
    "DestPorts": [],
    "DestType": 1,
    "DestWorkloads": [],
    "Enable": 1,
    "Id": 14,
    "ModifyTime": "2023-11-03 19:16:36",
    "Name": "workload-11112",
    "SrcHostWorkloadNum": 1,
    "SrcIPs": [],
    "SrcLabels": [],
    "SrcPodWorkloadNum": 0,
    "SrcType": 2,
    "SrcWorkloads": [
     {
      "Id": 84336,
      "Name": "tke_cls-psggh793_master_etcd",
      "Type": 0
     }
    ],
    "Updater": "cq"
   }
  ],
  "RequestId": "49b8aee2-4522-4022-8654-63f03461fb2d",
  "TotalCount": 2
 }
}