将 Akamai 与 Google SecOps 集成

本文档介绍了如何将 Akamai 与 Google Security Operations (Google SecOps) 集成。

集成版本：1.0

集成参数

Akamai 集成需要以下参数：

参数 说明
Host

必填。

Akamai 实例的主机名。
Client Token

必填。

您的 Akamai 客户端令牌。
Client Secret

必填。

您的 Akamai 客户端密钥。
Access Token

必填。

您的 Akamai 访问令牌。
Verify SSL

必填。

在连接到 Akamai 时验证 SSL 证书。

此选项将会默认选中。

操作

如需详细了解操作，请参阅处理“工作台”中的待处理操作和执行手动操作。

Ping

使用 Ping 操作测试与 Akamai 的连接。

此操作不会在 Google SecOps 实体上运行，并且没有输入参数。

操作输出

Ping 操作提供以下输出：

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
“支持请求”表格 不可用
丰富化表 不可用
JSON 结果 不可用
脚本结果 可用
输出消息

Ping 操作提供以下输出消息：

输出消息 消息说明
Successfully connected to the Akamai server with the provided connection parameters! 操作成功。
Failed to connect to the Akamai server! Error is {0}".format(exception.stacktrace) 操作失败。
脚本结果

下表介绍了使用 Ping 操作时脚本结果输出的值：

脚本结果名称 值
is_success True 或 False

获取网络列表

使用 Get Network Lists 操作可获取有关 Akamai 中网络列表的信息。

操作输入

获取网络列表操作需要以下参数：

参数 说明
Network List Name

可选。

要搜索的网络列表名称的英文逗号分隔列表。
Network List ID

可选。

要搜索的网络列表 ID 的英文逗号分隔列表。
Include Items

可选。

返回有关网络列表中的商品的信息。

默认值为 False。
Include Activation Status

可选。

返回每个网络列表的启用状态。

默认值为 False。

注意：仅当提供 Network List Name 或 Network List ID 时，系统才会返回此信息。
Activation Environment

可选。

返回的激活状态所对应的环境。

可能的值如下：
  • Production
  • Staging

注意：仅当提供 Network List Name 或 Network List ID 时，系统才会返回此信息。
Max Network Lists To Return

必填。

要返回的网络列表数量上限。

默认值和最大值为 100。
Max Network List Items To Return

必填。

每个网络列表返回的最大项数。

默认值和最大值为 100。

操作输出

获取网络列表操作提供以下输出：

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
“支持请求墙”表格 不可用
丰富化表 不可用
JSON 结果 可用
脚本结果 可用
JSON 结果

以下示例介绍了使用 Get Network Lists 操作时收到的 JSON 结果输出：

[
   {
       "networkListType": "networkListResponse",
       "accessControlGroup": "KSD\nwith ION 3-13H1234",
       "name": "General List",
       "elementCount": 3011,
       "readOnly": false,
       "shared": false,
       "syncPoint": 22,
       "type": "IP",
       "uniqueId": "25614_GENERALLIST",
       "links": {
           "activateInProduction": {
               "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/activate",
               "method": "POST"
           },
           "activateInStaging": {
               "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/activate",
               "method": "POST"
           },
           "appendItems": {
               "href": "/network-list/v2/network-lists/25614_GENERALLIST",
               "method": "POST"
           },
           "retrieve": {
               "href": "/network-list/v2/network-lists/25614_GENERALLIST"
           },
           "statusInProduction": {
               "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
           },
           "statusInStaging": {
               "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
           },
           "update": {
               "href": "/network-list/v2/network-lists/25614_GENERALLIST",
               "method": "PUT"
           }
       },
       "Activation_STAGING": {
           "activationId": 12345,
           "activationComments": "Allow IPs of new employees who joined this week",
           "activationStatus": "PENDING_ACTIVATION",
           "syncPoint": 5,
           "uniqueId": "25614_GENERALLIST",
           "fast": false,
           "dispatchCount": 1,
           "links": {
               "appendItems": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/append",
                   "method": "POST"
               },
               "retrieve": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST"
               },
               "statusInProduction": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
               },
               "statusInStaging": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
               },
               "syncPointHistory": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/sync-points/5/history"
               },
               "update": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST",
                   "method": "PUT"
               },
               "activationDetails": {
                   "href": "/network-list/v2/network-lists/activations/12345/"
               }
           }
       },
       "Activation_PRODUCTION": {
           "activationId": 12345,
           "activationComments": "Allow IPs of new employees who joined this week",
           "activationStatus": "PENDING_ACTIVATION",
           "syncPoint": 5,
           "uniqueId": "25614_GENERALLIST",
           "fast": false,
           "dispatchCount": 1,
           "links": {
               "appendItems": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/append",
                   "method": "POST"
               },
               "retrieve": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST"
               },
               "statusInProduction": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
               },
               "statusInStaging": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
               },
               "syncPointHistory": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/sync-points/5/history"
               },
               "update": {
                   "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST",
                   "method": "PUT"
               },
               "activationDetails": {
                   "href": "/network-list/v2/network-lists/activations/12345/"
               }
           }
       }
   }
]
输出消息

获取网络列表操作提供以下输出消息：

输出消息 消息说明

Successfully returned network lists from Akamai.

No network lists were found for the provided criteria in Akamai.

 操作成功。
Error executing action "Get Network Lists". Reason: {0}''.format (error.Stacktrace) 操作失败。
脚本结果

下表介绍了使用 Get Network Lists 操作时脚本结果输出的值：

脚本结果名称 值
is_success True 或 False

将商品添加到网络清单

使用 Add Items To Network List 操作将项添加到 Akamai 中的网络列表。

操作输入

将商品添加到网络列表操作需要以下参数：

参数 说明
Network List Name

可选。

要更新的网络列表的名称。

如果提供了 Network List Name 和 Network List ID，则操作会使用该 ID。
Network List ID

可选。

要更新的网络列表的 ID。

如果提供了 Network List Name 和 Network List ID，则操作会使用该 ID。
Items

必填。

要添加到网络列表中的项的列表（以英文逗号分隔）。

操作输出

将商品添加到网络列表操作提供以下输出：

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
“支持请求墙”表格 不可用
丰富化表 不可用
JSON 结果 可用
脚本结果 可用
JSON 结果

以下示例描述了使用 Add Items To Network Lists 操作时收到的 JSON 结果输出：

     {
       "networkListType": "networkListResponse",
       "accessControlGroup": "KSD\nwith ION 3-13H1234",
       "name": "General List",
       "elementCount": 3011,
       "readOnly": false,
       "shared": false,
       "syncPoint": 22,
       "type": "IP",
       "uniqueId": "25614_GENERALLIST",
       "links": {
         "activateInProduction": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/activate",
           "method": "POST"
         },
         "activateInStaging": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/activate",
           "method": "POST"
         },
         "appendItems": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST",
           "method": "POST"
         },
         "retrieve": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST"
         },
         "statusInProduction": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
         },
         "statusInStaging": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
         },
         "update": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST",
           "method": "PUT"
         }
       }
     }
输出消息

将商品添加到网络列表操作提供以下输出消息：

输出消息 消息说明
Successfully updated network list in Akamai. 操作成功。

Error executing action "Add Items To Network List". Reason: {0}''.format (error.Stacktrace)

Error executing action "Add Items To Network List". Reason: "{network name or id}" network list wasn't found in Akamai.

Error executing action "Add Items To Network List". Reason: provide a value in "Network List Name" or "Network List ID" parameter.

 操作失败。
脚本结果

下表介绍了使用将商品添加到网络列表操作时脚本结果输出的值：

脚本结果名称 值
is_success True 或 False

从网络列表中移除项目

使用 Remove Items From Network List 操作可从 Akamai 中的网络列表中移除项目。

操作输入

从网络列表中移除商品操作需要以下参数：

参数 说明
Network List Name

可选。

要更新的网络列表的名称。

如果提供了 Network List Name 和 Network List ID，则操作会使用 ID
Network List ID

可选。

要更新的网络列表的 ID。

如果提供了 Network List Name 和 Network List ID，则操作会使用 ID
Items

必填。

要从网络列表中移除的项的逗号分隔列表。

操作输出

从网络列表中移除商品操作提供以下输出：

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
“支持请求墙”表格 不可用
丰富化表 不可用
JSON 结果 可用
脚本结果 可用
JSON 结果

以下示例介绍了使用从网络列表中移除项操作时收到的 JSON 结果输出：

{
       "networkListType": "networkListResponse",
       "accessControlGroup": "KSD\nwith ION 3-13H1234",
       "name": "General List",
       "elementCount": 3011,
       "readOnly": false,
       "shared": false,
       "syncPoint": 22,
       "type": "IP",
       "uniqueId": "25614_GENERALLIST",
       "links": {
         "activateInProduction": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/activate",
           "method": "POST"
         },
         "activateInStaging": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/activate",
           "method": "POST"
         },
         "appendItems": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST",
           "method": "POST"
         },
         "retrieve": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST"
         },
         "statusInProduction": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
         },
         "statusInStaging": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
         },
         "update": {
           "href": "/network-list/v2/network-lists/25614_GENERALLIST",
           "method": "PUT"
         }
       }
     }
输出消息

从网络列表中移除项操作会提供以下输出消息：

输出消息 消息说明

Successfully updated network list in Akamai.

None of the provided items were found in the network list in Akamai.

 操作成功。

Error executing action "Remove Items From Network List". Reason: {0}''.format (error.Stacktrace)

Error executing action "Remove Items From Network List". Reason: "{network name or id}" network list wasn't found in Akamai.

Error executing action "Remove Items From Network List". Reason: provide a value in "Network List Name" or "Network List ID" parameter.

 操作失败。
脚本结果

下表介绍了使用从网络列表中移除项操作时脚本结果输出的值：

脚本结果名称 值
is_success True 或 False

激活网络列表

使用 Activate Network List 操作可从 Akamai 的网络列表中移除项目。

操作输入

激活网络列表操作需要以下参数：

参数 说明
Network List Name

可选。

要更新的网络列表的名称。

如果提供了 Network List Name 和 Network List ID，则操作会使用 ID
Network List ID

可选。

要更新的网络列表的 ID。

如果提供了 Network List Name 和 Network List ID，则操作会使用 ID
Environment

可选。

激活的目标环境。

可能的值如下：
  • Production
  • Staging
Comment

可选。

描述激活用途的注释。
Notification Recipients

可选。

以英文逗号分隔的电子邮件地址列表，用于接收有关网络列表激活的通知。

操作输出

激活网络列表操作提供以下输出：

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
“支持请求墙”表格 不可用
丰富化表 不可用
JSON 结果 可用
脚本结果 可用
JSON 结果

以下示例介绍了使用 Activate Network Lists 操作时收到的 JSON 结果输出：

{
   "activationId": 12345,
   "activationComments": "Allow IPs of new employees who joined this week",
   "activationStatus": "PENDING_ACTIVATION",
   "syncPoint": 5,
   "uniqueId": "25614_GENERALLIST",
   "fast": false,
   "dispatchCount": 1,
   "links": {
     "appendItems": {
       "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/append",
       "method": "POST"
     },
     "retrieve": {
       "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST"
     },
     "statusInProduction": {
       "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
     },
     "statusInStaging": {
       "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
     },
     "syncPointHistory": {
       "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/sync-points/5/history"
     },
     "update": {
       "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST",
       "method": "PUT"
     },
     "activationDetails": {
       "href": "/network-list/v2/network-lists/activations/12345/"
     }
   }
 }
输出消息

激活网络列表操作提供以下输出消息：

输出消息 消息说明
Successfully activated the network list in Akamai. 操作成功。

Error executing action "Activate Network List". Reason: {0}''.format(error.Stacktrace)

Error executing action "Activate Network List". Reason: "{network name or id}" network list wasn't found in Akamai.

Error executing action "Activate Network List". Reason: provide a value in "Network List Name" or "Network List ID" parameter.

 操作失败。
脚本结果

下表介绍了使用 Activate Network List 操作时脚本结果输出的值：

脚本结果名称 值
is_success True 或 False

获取客户名单

使用 Get Client Lists 操作获取有关 Akamai 中客户名单的信息。

操作输入

获取客户列表操作需要以下参数：

参数 说明
Client List Name

可选。

要搜索的客户名单名称的英文逗号分隔列表。
Client List ID

可选。

要搜索的客户名单 ID 的英文逗号分隔列表。
Include Items

可选。

返回有关客户端列表中的商品的信息。

默认值为 False。

注意：仅当提供 Client List Name 或 Client List ID 时，系统才会返回此信息。
Type

可选。

要搜索的客户名单的类型。

可能的值如下：
  • IP
  • GEO
  • ASN
  • TLS
  • Fingerprint
  • File Hash

    • 注意：如果提供了 Select One，该操作会在所有客户端列表中进行搜索。
    Max Client Lists To Return

    必填。

    要返回的客户名单数量上限。

    默认值和最大值为 100。
    Max Client List Items To Return

    必填。

    每个客户列表返回的最大项数。

    默认值和最大值为 100。

    操作输出

    获取客户列表操作提供以下输出：

    操作输出类型 可用性
    案例墙附件 不可用
    案例墙链接 不可用
    “支持请求墙”表格 不可用
    丰富化表 不可用
    JSON 结果 可用
    脚本结果 可用
    JSON 结果

    以下示例描述了使用 Get Client Lists 操作时收到的 JSON 结果输出：

    [
{
   "contractId": "K-0N7RAK71",
   "createDate": "2023-04-05T18:20:42.090+00:00",
   "createdBy": "jsmith",
   "deprecated": false,
   "groupId": 32145,
   "groupName": "Acme IT Group",
   "items": [
     {
       "createDate": "2023-04-05T18:20:42.892+00:00",
       "createdBy": "jkowalski",
       "description": "Canada - North America",
       "expirationDate": "2023-12-31T23:59:19.700+00:00",
       "productionStatus": "INACTIVE",
       "stagingStatus": "INACTIVE",
       "tags": [
         "allowlist1"
       ],
       "type": "GEO",
       "updateDate": "2023-04-05T18:20:42.892+00:00",
       "updatedBy": "mrossi",
       "value": "CA"
     }
   ],
   "itemsCount": 3,
   "listId": "1234_NORTHAMERICAGEOALLOWLIST",
   "listType": "CL",
   "name": "NorthAmericaGeoAllowlist",
   "notes": "GEO code allowlist",
   "productionActivationStatus": "INACTIVE",
   "readOnly": false,
   "shared": false,
   "stagingActivationStatus": "INACTIVE",
   "tags": [
     "allowlist2"
   ],
   "type": "GEO",
   "updateDate": "2023-04-05T18:20:42.090+00:00",
   "updatedBy": "jdupont",
   "version": 1
 }
]
    输出消息

    获取客户名单操作提供以下输出消息：

    输出消息 消息说明

    Successfully returned client lists from Akamai.

    No clients lists were found for the provided criteria in Akamai.

    		 操作成功。
    Error executing action "Get Client Lists". Reason: {0}''.format (error.Stacktrace) 操作失败。
    脚本结果

    下表介绍了使用 Get Client Lists 操作时脚本结果输出的值：

    脚本结果名称 值
    is_success True 或 False

    向客户名单添加商品

    使用 Add Items To Client List 操作将项目添加到 Akamai 中的客户端列表。

    操作输入

    向客户名单添加商品操作需要以下参数：

    参数 说明
    Client List Name

    可选。

    要更新的客户名单的名称。

    注意：如果提供了 Client List Name 和 Client List ID，则操作会使用该 ID。
    Client List ID

    可选。

    要更新的客户名单的 ID。

    注意：如果提供了 Client List Name 和 Client List ID，则操作会使用该 ID。
    Item Value

    必填。

    要添加到客户端列表中的项的列表（以英文逗号分隔）。
    Item Description

    可选。

    添加到客户端列表中的商品的说明。
    Item Expiration Date

    可选。

    添加商品的到期日期，采用 ISO 8601 格式。
    Item Tags

    可选。

    以英文逗号分隔的要与添加的商品相关联的标记列表。

    操作输出

    向客户端列表添加商品操作提供以下输出：

    操作输出类型 可用性
    案例墙附件 不可用
    案例墙链接 不可用
    “支持请求墙”表格 不可用
    丰富化表 不可用
    JSON 结果 可用
    脚本结果 可用
    JSON 结果

    以下示例描述了使用 Add Items To Client List 操作时收到的 JSON 结果输出：

    [
   {
       "createDate": "2023-04-05T19:29:02.320+00:00",
       "createdBy": "jkowalski",
       "description": "Jamaica - North America",
       "expirationDate": "2023-12-31T23:59:19.700+00:00",
       "productionStatus": "INACTIVE",
       "stagingStatus": "INACTIVE",
       "tags": [
           "allowlist2"
       ],
       "type": "GEO",
       "updateDate": "2023-04-05T19:29:02.320+00:00",
       "updatedBy": "jdupont",
       "value": "JM"
   }
}
]
    输出消息

    向客户名单添加项操作提供以下输出消息：

    输出消息 消息说明
    Successfully returned client lists from Akamai. 操作成功。

    Error executing action "Add Items To Client List". Reason: {0}''.format (error.Stacktrace)

    Error executing action "Add Items To Client List". Reason: provide a value in "Client List Name" or "Client List ID" parameter.

    Error executing action "Add Items To Client List". Reason: "{client list name or id}" client list wasn't found in Akamai.

    		 操作失败。
    脚本结果

    下表介绍了使用将商品添加到客户端列表操作时脚本结果输出的值：

    脚本结果名称 值
    is_success True 或 False

    从客户名单中移除商品

    使用 Remove Items From Client List 操作从 Akamai 中的客户端列表中移除项。

    操作输入

    从客户端列表中移除商品操作需要以下参数：

    参数 说明
    Client List Name

    可选。

    要更新的客户名单的名称。

    注意：如果提供了 Client List Name 和 Client List ID，则操作会使用该 ID。
    Client List ID

    可选。

    要更新的客户名单的 ID。

    注意：如果提供了 Client List Name 和 Client List ID，则操作会使用该 ID。
    Item Value

    必填。

    要从客户端列表中移除的项的逗号分隔列表。

    操作输出

    从客户名单中移除商品操作提供以下输出：

    操作输出类型 可用性
    案例墙附件 不可用
    案例墙链接 不可用
    “支持请求墙”表格 不可用
    丰富化表 不可用
    JSON 结果 可用
    脚本结果 可用
    JSON 结果

    以下示例介绍了使用从客户端列表中移除商品操作时收到的 JSON 结果输出：

    [
   {
       "createDate": "2023-04-05T19:29:02.320+00:00",
       "createdBy": "jkowalski",
       "description": "Jamaica - North America",
       "expirationDate": "2023-12-31T23:59:19.700+00:00",
       "productionStatus": "INACTIVE",
       "stagingStatus": "INACTIVE",
       "tags": [
           "allowlist2"
       ],
       "type": "GEO",
       "updateDate": "2023-04-05T19:29:02.320+00:00",
       "updatedBy": "jdupont",
       "value": "JM"
   }
]
    输出消息

    从客户端列表中移除商品操作会提供以下输出消息：

    输出消息 消息说明

    Successfully updated client list in Akamai.

    None of the provided items were found in the client list in Akamai.

    		 操作成功。

    Error executing action "Remove Items From Client List". Reason: {0}''.format(error.Stacktrace)

    Error executing action "Remove Items From Client List". Reason: provide a value in "Client List Name" or "Client List ID" parameter.

    Error executing action "Remove Items From Client List". Reason: "{client list name or id}" client list wasn't found in Akamai.

    		 操作失败。
    脚本结果

    下表介绍了使用 Remove Items From Client List 操作时脚本结果输出的值：

    脚本结果名称 值
    is_success True 或 False

    需要更多帮助？从社区成员和 Google SecOps 专业人士那里获得解答。