获取微告警全局白名单设置

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

1. 接口描述

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

获取微告警全局白名单

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeMaWhitelist
Version String 公共参数,本接口取值:2018-02-28
Region String 公共参数,地域信息本接口不需要传递此参数。
By String 可选排序列: [CreateTime 
Filters Array of Filter
  • From - string - 是否必填:否 - 白名单来源
  • Enable - int64 - 是否必填:否 - 是否开启
  • Updater - string - 是否必填:否 - 创建人
  • Name - string - 是否必填:否 - 白名单名称

  • 示例值:查看
    Limit Int64 限制条数,默认10,最大100
    示例值: 10
    Offset Int64 偏移量,默认0
    示例值: 0
    Order String 排序方式: [ASC:升序

    3. 输出参数

    参数名称 类型 描述
    Enable Int64 是否整体开启
  • 0 : 未开启
  • 1 : 开启

  • 示例值: 1
    List Array of MaWhitelist 全局过滤白名单配置集
    示例值:查看
    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: DescribeMaWhitelist
    <Public request parameters>
    
    {}
    

    输出示例

    {
     "Response": {
      "Enable": 1,
      "List": [
       {
        "CreateTime": "2023-10-31 10:57:13",
        "Dest": "all",
        "DestPort": "80",
        "Enable": 1,
        "From": 1,
        "Id": 2,
        "ModifyTime": "2023-10-31 16:58:50",
        "Name": "name1",
        "Source": "1.1.1.1",
        "Updater": "user2"
       },
       {
        "CreateTime": "2023-10-31 19:47:35",
        "Dest": "all",
        "DestPort": "8080;80",
        "Enable": 0,
        "From": 1,
        "Id": 3,
        "ModifyTime": "2023-10-31 19:53:22",
        "Name": "111222",
        "Source": "1.1.1.1",
        "Updater": "user1"
       },
       {
        "CreateTime": "2023-11-01 12:36:51",
        "Dest": "all",
        "DestPort": "8080;80",
        "Enable": 0,
        "From": 1,
        "Id": 4,
        "ModifyTime": "2023-11-01 12:36:51",
        "Name": "1112224",
        "Source": "1.1.1.1",
        "Updater": "user1"
       }
      ],
      "RequestId": "a73f0942-8fdc-4063-afba-dc29b1823285",
      "TotalCount": 3
     }
    }