• 开发与集成
  • 企业版开发
  • 功能 API
  • 360view
  • npb

分发策略相关API

创建时间：2024-11-01 最近修改时间：2024-11-01

#1. 分发策略相关API

#1.1 目录

#1.2 分发策略

操作 HTTP Method
获取全部分发策略 GET
获取单个分发策略 GET
创建分发策略 POST
更新分发策略 PATCH
删除分发策略 DELETE

#1.3 分发点

操作 HTTP Method
获取全部分发点 GET
获取单个分发点 GET
创建分发点 POST
更新分发点 PATCH
删除分发点 DELETE

#1.4 API详情

#1.4.1 分发策略API

#1.4.1.1 获取全部分发策略

  • URL:

    /v1/deepflow/npb-policies/

  • Response:

    {
  "OPT_STATUS": "SUCCESS", // API触发的操作是否成功，SUCCESS表示成功，其他值表示未成功
    "WAIT_CALLBACK": false, // 是否为同步API，文档内所有API都是同步的
    "TASK": null, // 该字段在文档中所有API中，暂无意义
    "DESCRIPTION": "", // API触发的操作失败原因
    "TYPE": "dict", // 暂无意义
    "DATA": [{
      "ID": 1,
      "LCUUID": "03b1b72b-3fe6-4d23-a1cd-4fe8ed966199",
      "NAME": "yc-1000-100",  // 名称
      "STATE": 1, //状态 0禁用，1运行
      "BUSINESS_ID": 1, //暂时无用
      "ACL_ID": 73214, //供底层使用
      "POLICY_ACL_GROUP_ID": 141, //供底层使用
      "PROTOCOL": null, //协议
      "SRC_PORTS": "22",  //采集点过滤规则端口
      "DST_PORTS": "80", //对端过滤规则端口
      "SRC_SUB_TYPE": 11,  //采集点过滤规则端口
      "DST_SUB_TYPE": 11, //对端过滤资源子类型
      "SRC_TYPE": 1,  //采集点过滤规则端口
      "DST_TYPE": 1, //对端过滤资源类型
      "VNI": 100, //流量标签
      "NPB_TUNNEL_ID": 1, //分发点ID
      "TAP_TYPE": 1, //采集点
      "PAYLOAD_SLICE": 1000, //截断长度
      "CREATED_AT": "2019-05-17 18:36:32", //创建时间
      "UPDATED_AT": "2019-05-18 10:53:29", //修改时间
      "SRC_IP": "192.168.1.1-192.168.2.3", //采集点过滤规则IP
      "DST_IP": "10.30.100.39", //对端过滤规则IP
      "SRC_EPC_ID": 2,  //采集点过滤规则VPC ID
      "DST_EPC_ID": 3, //对端过滤规则VPC ID
      "SRC_VM_ID": null,  //采集点过滤规则云服务器ID
      "DST_VM_ID": null, //对端过滤规则云服务器ID
      "SRC_GROUP_ID": null,  //采集点过滤规则资源组ID
      "DST_GROUP_ID": null,  //对端过滤规则资源组ID
      "SRC_POD_GROUP_ID": null,  //采集点过滤规则POD组ID
      "DST_POD_GROUP_ID": null, //对端过滤规则POD组ID
      "SRC_POD_SERVICE_ID": null,  //采集点过滤规则容器服务ID
      "DST_POD_SERVICE_ID": null, //对端过滤规则容器服务ID
      "SRC_POD_CLUSTER_ID": null,  //采集点过滤规则POD组所在集群ID
      "DST_POD_CLUSTER_ID": null   //对端过滤规则POD组所在集群ID
    }]
}

#1.4.1.2 获取单个分发策略

  • URL:

    /v1/deepflow/npb-policies/{lcuuid}/

  • Response:

    {
  "OPT_STATUS": "SUCCESS", // API触发的操作是否成功，SUCCESS表示成功，其他值表示未成功
    "WAIT_CALLBACK": false, // 是否为同步API，文档内所有API都是同步的
    "TASK": null, // 该字段在文档中所有API中，暂无意义
    "DESCRIPTION": "", // API触发的操作失败原因
    "TYPE": "dict", // 暂无意义
    "DATA": {
      "ID": 1,
      "LCUUID": "03b1b72b-3fe6-4d23-a1cd-4fe8ed966199",
      "NAME": "yc-1000-100",  // 名称
      "STATE": 1, //状态 0禁用，1运行
      "BUSINESS_ID": 1, //暂时无用
      "ACL_ID": 73214, //供底层使用
      "POLICY_ACL_GROUP_ID": 141, //供底层使用
      "PROTOCOL": null, //协议
      "SRC_PORTS": "22",  //采集点过滤规则端口
      "DST_PORTS": "80", //对端过滤规则端口
      "SRC_SUB_TYPE": 11,  //采集点过滤规则端口
      "DST_SUB_TYPE": 11, //对端过滤资源子类型
      "SRC_TYPE": 1,  //采集点过滤规则端口
      "DST_TYPE": 1, //对端过滤资源类型
      "VNI": 100, //流量标签
      "NPB_TUNNEL_ID": 1, //分发点ID
      "TAP_TYPE": 1, //采集点
      "PAYLOAD_SLICE": 1000, //截断长度
      "CREATED_AT": "2019-05-17 18:36:32", //创建时间
      "UPDATED_AT": "2019-05-18 10:53:29", //修改时间
      "SRC_IP": "192.168.1.1-192.168.2.3", //采集点过滤规则IP
      "DST_IP": "10.30.100.39", //对端过滤规则IP
      "SRC_EPC_ID": 2,  //采集点过滤规则VPC ID
      "DST_EPC_ID": 3, //对端过滤规则VPC ID
      "SRC_VM_ID": null,  //采集点过滤规则云服务器ID
      "DST_VM_ID": null, //对端过滤规则云服务器ID
      "SRC_GROUP_ID": null,  //采集点过滤规则资源组ID
      "DST_GROUP_ID": null,  //对端过滤规则资源组ID
      "SRC_POD_GROUP_ID": null,  //采集点过滤规则POD组ID
      "DST_POD_GROUP_ID": null, //对端过滤规则POD组ID
      "SRC_POD_SERVICE_ID": null,  //采集点过滤规则容器服务ID
      "DST_POD_SERVICE_ID": null, //对端过滤规则容器服务ID
      "SRC_POD_CLUSTER_ID": null,  //采集点过滤规则POD组所在集群ID
      "DST_POD_CLUSTER_ID": null   //对端过滤规则POD组所在集群ID
    }
}

#1.4.1.3 创建分发策略

  • URL:

    /v1/deepflow/npb-policies/{lcuuid}/

  • 请求参数

字段 类型 描述 限制
BUSINESS_ID int 业务id 必填，仅支持：1
NAME string 资源组名称 必填
STATE int 状态 必填，0：禁用，1：启用
PROTOCOL int 协议 非必填，范围：0~255
VNI int 流量标签 非必填，范围：0~1023，默认：0
NPB_TUNNEL_ID int 分发点ID 必填
TAP_TYPE int 采集点 必填
PAYLOAD_SLICE int payload截断 非必填，范围：0~65535
SRC_PORTS list of string 采集点过滤端端口 仅在协议指定为TCP、UDP时可填；支持单个端口及端口范围组合，举例：10,20-22、80；端口范围：1~65535
DST_PORTS list of string 对端端口 仅在协议指定为TCP、UDP时可填；支持单个端口及端口范围组合，举例：10,20-22、80；端口范围：1~65535
SRC_TYPE int 采集点过滤端类型 必填，1：虚拟化，2：容器，3：资源组
SRC_SUB_TYPE int 采集点过滤端子类型 采集点过滤端类型为1、2时必填，为3时不填，11：IP，12：IP段，13：子网，14：云服务器，21：POD组
SRC_EPC_ID int 采集点过滤端VPC ID 采集点过滤端子类型为11、12、13时选填，为14时必填，其他不填
SRC_IP string 采集点过滤端IP/IP段/子网内容 采集点过滤端子类型为11、12、13时必填，其他不填
SRC_VM_ID int 采集点过滤端云服务器ID 采集点过滤端子类型为14时必填，其他不填
SRC_GROUP_ID int 采集点过滤端资源组ID 采集点过滤端类型为3时必填，其他不填
SRC_POD_CLUSTER_ID int 采集点过滤端集群ID 采集点过滤端类型为2时必填，其他不填
SRC_POD_GROUP_ID int 采集点过滤端POD组ID 采集点过滤端子类型为21时必填，其他不填
DST_TYPE int 对端类型 1：虚拟化，2：容器，3：资源组
DST_SUB_TYPE int 对端子类型 对端类型为1、2时必填，为3时不填，11：IP，12：IP段，13：子网，14：云服务器，21：POD组，22：服务
DST_EPC_ID int 对端VPC ID 对端子类型为11、12、13时选填，为14时必填，其他不填
DST_IP string 对端IP/IP段/子网内容 对端子类型为11、12、13时必填，其他不填
DST_VM_ID int 对端云服务器ID 对端子类型为14时必填，其他不填
DST_GROUP_ID int 对端资源组ID 对端类型为3时必填，其他不填
DST_POD_CLUSTER_ID int 对端集群ID 对端类型为2时必填，其他不填
DST_POD_GROUP_ID int 对端POD组ID 对端子类型为21时必填，其他不填
DST_POD_SERVICE_ID int 对端服务ID 对端子类型为22时必填，其他不填

  • Request：

      {
      "NAME": "npb_policy1",
      "STATE": 1,
      "BUSINESS_ID": 1,
      "PROTOCOL": 6,
      "VNI": 1,
      "NPB_TUNNEL_ID": 1,
      "TAP_TYPE": 1,
      "PAYLOAD_SLICE": 5，
      "SRC_PORTS": "22-22",
      "DST_PORTS": "22-22",
      "SRC_TYPE": 1,
      "SRC_SUB_TYPE": 11,
      "SRC_EPC_ID": null,
      "SRC_IP": '10.20.1.0',
      "SRC_VM_ID": null,
      "SRC_GROUP_ID": null,
      "SRC_POD_CLUSTER_ID": null,
      "SRC_POD_GROUP_ID": null,
      "DST_TYPE": 1,
      "DST_SUB_TYPE": 11,
      "DST_EPC_ID": null,
      "DST_IP": '10.20.1.0',
      "DST_VM_ID": null,
      "DST_GROUP_ID": null,
      "DST_POD_CLUSTER_ID": null,
      "DST_POD_GROUP_ID": null,
      "DST_POD_SERVICE_ID": null
  }

  • Response:

      {
    "DATA": {
      "NAME": "npb_policy1",
      "STATE": 1,
      "BUSINESS_ID": 1,
      "PROTOCOL": 6,
      "VNI": 1,
      "NPB_TUNNEL_ID": 1,
      "ACL_ID": 73214,
      "POLICY_ACL_GROUP_ID": 141,
      "TAP_TYPE": 1,
      "PAYLOAD_SLICE": 5，
      "SRC_PORTS": "22-22",
      "DST_PORTS": "22-22",
      "SRC_TYPE": 1,
      "SRC_SUB_TYPE": 11,
      "SRC_EPC_ID": null,
      "SRC_IP": '10.20.1.0',
      "SRC_VM_ID": null,
      "SRC_GROUP_ID": null,
      "SRC_POD_CLUSTER_ID": null,
      "SRC_POD_GROUP_ID": null,
      "DST_TYPE": 1,
      "DST_SUB_TYPE": 11,
      "DST_EPC_ID": null,
      "DST_IP": '10.20.1.0',
      "DST_VM_ID": null,
      "DST_GROUP_ID": null,
      "DST_POD_CLUSTER_ID": null,
      "DST_POD_GROUP_ID": null,
      "DST_POD_SERVICE_ID": null,
      "CREATED_AT": "2017-06-13 17:01:57",
      "UPDATED_AT": "2017-06-13 17:01:57",
      "LCUUID": "a074a0a1-0525-4cb3-982a-f46c1b980832",
      "ID": 1
      },
    ...
  }

#1.4.1.4 更新分发策略

  • URL:

    /v1/deepflow/npb-policies/{lcuuid}/

  • 请求参数（仅下发需要修改的字段）

字段 类型 描述 限制
TAP_TYPE int 采集点
STATE int 状态 0：禁用，1：启用
PROTOCOL int 协议 范围：0~255
PAYLOAD_SLICE int payload截断 范围：0~65535
SRC_PORTS list of string 采集点过滤端端口 仅在协议指定为TCP、UDP时可填；支持单个端口及端口范围组合，举例：10,20-22、80；端口范围：1~65535
DST_PORTS list of string 对端端口 仅在协议指定为TCP、UDP时可填；支持单个端口及端口范围组合，举例：10,20-22、80；端口范围：1~65535
SRC_TYPE int 采集点过滤端类型 1：虚拟化，2：容器，3：资源组
SRC_SUB_TYPE int 采集点过滤端子类型 采集点过滤端类型为1、2时必填，为3时不填，11：IP，12：IP段，13：子网，14：云服务器，21：POD组
SRC_EPC_ID int 采集点过滤端VPC ID 采集点过滤端子类型为11、12、13时选填，为14时必填，其他不填
SRC_IP string 采集点过滤端IP/IP段/子网内容 采集点过滤端子类型为11、12、13时必填，其他不填
SRC_VM_ID int 采集点过滤端云服务器ID 采集点过滤端子类型为14时必填，其他不填
SRC_GROUP_ID int 采集点过滤端资源组ID 采集点过滤端类型为3时必填，其他不填
SRC_POD_CLUSTER_ID int 采集点过滤端集群ID 采集点过滤端类型为2时必填，其他不填
SRC_POD_GROUP_ID int 采集点过滤端POD组ID 采集点过滤端子类型为21时必填，其他不填
DST_TYPE int 对端类型 1：虚拟化，2：容器，3：资源组
DST_SUB_TYPE int 对端子类型 对端类型为1、2时必填，为3时不填，11：IP，12：IP段，13：子网，14：云服务器，21：POD组，22：服务
DST_EPC_ID int 对端VPC ID 对端子类型为11、12、13时选填，为14时必填，其他不填
DST_IP string 对端IP/IP段/子网内容 对端子类型为11、12、13时必填，其他不填
DST_VM_ID int 对端云服务器ID 对端子类型为14时必填，其他不填
DST_GROUP_ID int 对端资源组ID 对端类型为3时必填，其他不填
DST_POD_CLUSTER_ID int 对端集群ID 对端类型为2时必填，其他不填
DST_POD_GROUP_ID int 对端POD组ID 对端子类型为21时必填，其他不填
DST_POD_SERVICE_ID int 对端服务ID 对端子类型为22时必填，其他不填

  • Request：

      {
      "STATE": 1,
      "PROTOCOL": 6,
      "PAYLOAD_SLICE": 5，
      "SRC_PORTS": "22-22",
      "DST_PORTS": "22-22",
      "SRC_TYPE": 1,
      "SRC_SUB_TYPE": 11,
      "SRC_EPC_ID": null,
      "SRC_IP": '10.20.1.0',
      "SRC_VM_ID": null,
      "SRC_GROUP_ID": null,
      "SRC_POD_CLUSTER_ID": null,
      "SRC_POD_GROUP_ID": null,
      "DST_TYPE": 1,
      "DST_SUB_TYPE": 11,
      "DST_EPC_ID": null,
      "DST_IP": '10.20.1.0',
      "DST_VM_ID": null,
      "DST_GROUP_ID": null,
      "DST_POD_CLUSTER_ID": null,
      "DST_POD_GROUP_ID": null,
      "DST_POD_SERVICE_ID": null
  }

  • Response:

      {
    "DATA": {
      "NAME": "npb_policy1",
      "STATE": 1,
      "BUSINESS_ID": 1,
      "PROTOCOL": 6,
      "VNI": 1,
      "NPB_TUNNEL_ID": 1,
      "TAP_TYPE": 1,
      "ACL_ID": 73214,
      "POLICY_ACL_GROUP_ID": 141,
      "PAYLOAD_SLICE": 5，
      "SRC_PORTS": "22-22",
      "DST_PORTS": "22-22",
      "SRC_TYPE": 1,
      "SRC_SUB_TYPE": 11,
      "SRC_EPC_ID": null,
      "SRC_IP": '10.20.1.0',
      "SRC_VM_ID": null,
      "SRC_GROUP_ID": null,
      "SRC_POD_CLUSTER_ID": null,
      "SRC_POD_GROUP_ID": null,
      "DST_TYPE": 1,
      "DST_SUB_TYPE": 11,
      "DST_EPC_ID": null,
      "DST_IP": '10.20.1.0',
      "DST_VM_ID": null,
      "DST_GROUP_ID": null,
      "DST_POD_CLUSTER_ID": null,
      "DST_POD_GROUP_ID": null,
      "DST_POD_SERVICE_ID": null,
      "CREATED_AT": "2017-06-13 17:01:57",
      "UPDATED_AT": "2017-06-13 17:01:57",
      "LCUUID": "a074a0a1-0525-4cb3-982a-f46c1b980832",
      "ID": 1
    },
    ...
  }

#1.4.1.5 删除分发策略

  • URL:

    /v1/deepflow/npb-policies/{lcuuid}/

  • Response:

      {
    "DATA": {
      "LCUUID": "61376cc5-4488-4795-9834-b680401343a5"
    },
    ...
  }

#1.5 分发点API

#1.6 获取全部分发点

  • URL:

    /v1/deepflow/npb-tunnels/

  • Response

    {
  "OPT_STATUS": "SUCCESS", // API触发的操作是否成功，SUCCESS表示成功，其他值表示未成功
    "TASK": null, // 该字段在文档中所有API中，暂无意义
    "DESCRIPTION": "", // API触发的操作失败原因
    "TYPE": "NPB_TUNNEL", // 暂无意义
    "WAIT_CALLBACK": false, // 是否为同步API，文档内所有API都是同步的
    "DATA": [{
      "ID": 1,
      "LCUUID": "814e95d4-7b08-493b-9a1a-77db141995b0",
      "IP": "10.33.47.58", // 隧道端点IP
      "TYPE": 1, //隧道类型
      "POLICY_COUNT": 10, //使用该分发点创建的分发策略个数
      "CREATED_AT": "2019-05-17 18:36:32", //创建时间
      "UPDATED_AT": "2019-05-18 10:53:29", //修改时间
      "NAME": "tunnel1" //名称
    }]
  }

#1.7 获取单个分发点

  • URL:

    /v1/deepflow/npb-tunnels//

  • Response

    {
  "OPT_STATUS": "SUCCESS", // API触发的操作是否成功，SUCCESS表示成功，其他值表示未成功
    "TASK": null, // 该字段在文档中所有API中，暂无意义
    "DESCRIPTION": "", // API触发的操作失败原因
    "TYPE": "NPB_TUNNEL", // 暂无意义
    "WAIT_CALLBACK": false, // 是否为同步API，文档内所有API都是同步的
    "DATA": {
      "ID": 1,
      "LCUUID": "814e95d4-7b08-493b-9a1a-77db141995b0",
      "IP": "10.33.47.58", // 隧道端点IP
      "TYPE": 1, //隧道类型
      "POLICY_COUNT": 10, //使用该分发点创建的分发策略个数
      "CREATED_AT": "2019-05-17 18:36:32", //创建时间
      "UPDATED_AT": "2019-05-18 10:53:29", //修改时间
      "NAME": "tunnel1" //名称
    }
  }

#1.7.1.1 创建分发点

  • URL:

    /v1/deepflow/npb-tunnels/{lcuuid}/

  • 请求参数

字段 类型 描述
IP string 隧道端点IP 必填
NAME string 名称 必填
TYPE int 隧道类型 必填，0：VXLAN，1：ERSPAN

  • Request：

      {
      "NAME": "npb_tunnel1",
      "IP": "10.33.49.23",
      "TYPE": 1
  }

  • Response:

      {
    "DATA": {
      "ID": 1,
      "LCUUID": "814e95d4-7b08-493b-9a1a-77db141995b0",
      "IP": "10.33.47.23",
      "TYPE": 1,
      "POLICY_COUNT":0,
      "CREATED_AT": "2019-05-17 18:36:32",
      "UPDATED_AT": "2019-05-18 10:53:29",
      "NAME": "npb_tunnel1"
      },
    ...
  }

#1.7.1.2 更新分发点

  • URL:

    /v1/deepflow/npb-tunnels/{lcuuid}/

  • 请求参数（仅下发需要修改的字段）

字段 类型 描述 限制
IP string 隧道端点IP
NAME string 名称
TYPE int 隧道类型 0：VXLAN，1：ERSPAN

  • Request：

      {
      "NAME": "npb_tunnel1",
      "IP": "10.33.49.23",
      "TYPE": 0
  }

  • Response:

      {
    "DATA": {
      "ID": 1,
      "LCUUID": "814e95d4-7b08-493b-9a1a-77db141995b0",
      "IP": "10.33.47.23",
      "TYPE": 0,
      "POLICY_COUNT":0,
      "CREATED_AT": "2019-05-17 18:36:32",
      "UPDATED_AT": "2019-05-18 10:53:29",
      "NAME": "npb_tunnel1"
      },
    ...
  }

#1.7.1.3 删除分发点

  • URL:

    /v1/deepflow/npb-tunnels/{lcuuid}/

  • Response:

      {
    "DATA": {
      "LCUUID": "61376cc5-4488-4795-9834-b680401343a5"
    },
    ...
  }