将 Akamai 与 Google SecOps 集成

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

使用场景

Akamai 集成使用 Google SecOps 功能来支持以下用例:

  • 在边缘自动屏蔽威胁:将调查期间发现的恶意 IP 地址、CIDR 块、自治系统编号、地理位置、TLS 指纹或文件哈希添加到 Akamai 客户端列表或网络列表中,以便在网络边缘屏蔽威胁。

  • 管理动态访问权限控制和许可清单:在误报问题得到解决或临时限制到期后,从 Akamai 客户端列表和网络列表中移除良性指标或过期条目。

  • 跨环境部署政策更新:直接通过自动化 playbook 在 Akamai 预演或生产环境中激活更新后的客户端列表和网络列表,并向利益相关方通知激活事件。

  • 审核边缘安全列表:检索 Akamai 客户端列表和网络列表的元数据、内容和环境激活状态,以丰富安全调查并验证当前的强制执行状态。

准备工作

在 Google SecOps 中配置 Akamai 集成之前,请先完成以下前提步骤:

  1. 为 Google SecOps 实例创建 Akamai EdgeGrid API 凭据。

  2. 在 Akamai 中配置所需的 API 权限,以便执行您计划运行的操作。

创建 Akamai EdgeGrid API 凭证

Akamai 集成使用 EdgeGrid 凭据向 Akamai API 进行身份验证。在 Akamai 控制中心内预配专用 API 客户端,并收集集成参数所需的以下凭证值:

  • Host(Akamai API 客户端的基本主机名网址)
  • Client Token
  • Client Secret
  • Access Token

配置 API 权限(最小权限)

仅向 Akamai API 客户端授予您计划运行的特定操作所需的 API 服务权限,并验证 API 客户端的访问权限控制群组范围是否包含目标客户端列表和网络列表。

请参阅下表,了解 Akamai 操作所需的最低 API 权限:

操作名称 Akamai API 服务 所需访问权限级别 端点范围
启用客户名单 Client Lists API v1 和 v2 Read-Write 使用 GET /client-list/v1/lists 解析客户端名单标识符,并使用 POST /client-list/v2/lists/{listId}/activations 激活目标名单。
激活网络列表 Network Lists API v2 Read-Write 使用 GET /network-list/v2/network-lists 解析网络列表标识符,并使用 POST /network-list/v2/network-lists/{networkListId}/environments/{environment}/activate 激活目标列表。
将内容添加到客户列表 Client Lists API v1 Read-Write 使用 GET /client-list/v1/lists 检索客户端列表以进行验证,并使用 POST /client-list/v1/lists/{listId}/items 附加项。
向网络列表添加内容 Network Lists API v2 Read-Write 使用 GET /network-list/v2/network-lists 解析网络列表标识符,并使用 POST /network-list/v2/network-lists/{networkListId}/append 附加项。
获取客户名单 Client Lists API v1 Read-Only 使用 GET /client-list/v1/lists 检索客户名单及其内容。
获取网络列表 Network Lists API v2 Read-Only 使用 GET /network-list/v2/network-lists、GET /network-list/v2/network-lists/{networkListId} 和 GET /network-list/v2/network-lists/{networkListId}/environments/{environment}/status 检索网络列表、列表项和环境激活状态。
Ping Network Lists API v2 Read-Only 使用 GET /network-list/v2/network-lists?limit=1 验证 API 连接和凭据。
从客户列表中移除内容 Client Lists API v1 Read-Write 使用 GET /client-list/v1/lists 检索客户端列表以进行验证,并使用 POST /client-list/v1/lists/{listId}/items 删除项。
从网络列表中移除内容 Network Lists API v2 Read-Write 使用 GET /network-list/v2/network-lists 解析网络列表标识符,并使用 DELETE /network-list/v2/network-lists/{networkListId}/elements 移除各个元素。

集成参数

Akamai 集成需要以下参数:

参数 说明
Host

必填。

Akamai API 实例的基础网址,包括 https:// 架构,例如 https://akab-example.luna.akamaiapis.net。

默认值为 https://{host}。

Client Token

必填。

Akamai EdgeGrid API 客户端的客户端令牌。

Client Secret

必填。

Akamai EdgeGrid API 客户端的客户端密钥。

Access Token

必填。

Akamai EdgeGrid API 客户端的访问令牌。

Verify SSL

必填。

如果选中此选项,集成会在连接到 Akamai 服务器时验证 SSL 证书。

默认处于启用状态。

如需了解如何在 Google SecOps 中配置集成,请参阅配置集成。

如有需要,您可以在后续阶段进行更改。配置集成实例后,您可以在 playbook 中使用该实例。如需详细了解如何配置和支持多个实例,请参阅支持多个实例。

操作

如需详细了解操作,请参阅 在工作桌上响应待处理的操作和在案例中运行手动操作。

启用客户名单

使用激活客户端列表操作在 Akamai 预演或生产环境中激活特定客户端列表。

此操作不会在 Google SecOps 实体上运行。

操作输入

Activate Client List(激活客户名单)操作需要以下参数:

参数 说明
Client List Name

可选。

要激活的客户名单的名称。匹配区分大小写。

您必须提供 Client List Name 或 Client List ID。如果您同时提供这两者,则操作会使用 Client List ID。

Client List ID

可选。

要启用的客户名单的唯一标识符。

您必须提供 Client List Name 或 Client List ID。如果您同时提供这两者,则操作会使用 Client List ID。

Environment

可选。

客户端列表激活的目标 Akamai 环境。

可能的值如下:

  • Production
  • Staging

默认值为 Production。

Comment

可选。

说明客户名单激活目的的注释。

Notification Recipients

可选。

一个逗号分隔列表,其中包含在客户列表激活完成时要通知的电子邮件地址。

操作输出

激活客户名单操作会提供以下输出:

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

以下示例展示了使用激活客户端列表操作时收到的 JSON 结果输出:

{
  "action": "ACTIVATE",
  "activations": {
    "STAGING": {
      "activationId": 3797405,
      "activationStatus": "PENDING_ACTIVATION"
    }
  },
  "comments": "Activating 235466",
  "createDate": "2026-02-12T15:12:07.952+00:00",
  "createdBy": "4wksaj3wyt23jt2i",
  "listId": "235466_GOOGLESECOPSCLIENTLIST1",
  "notificationRecipients": [
    "12345@email.com"
  ],
  "version": 14
}
输出消息

Activate Client List 操作会提供以下输出消息:

输出消息 消息说明
Successfully activated the client list in Akamai. 操作成功。
Error executing action "Activate Client List". Reason: Provide a value in "Client List Name" or "Client List ID" parameter.

操作失败。

在 Client List Name 或 Client List ID 参数中提供有效的标识符。

Error executing action "Activate Client List". Reason: "CLIENT_LIST_IDENTIFIER" client list wasn't found in Akamai.

操作失败。

验证指定的客户端列表名称或 ID 是否存在于 Akamai 中,以及如果按 Client List Name 搜索,名称是否与大小写完全匹配。

Error executing action "Activate Client List". Reason: ERROR_REASON

操作失败。

请检查与 Akamai 服务器的连接,验证目标客户端列表是否有可供激活的内容,或检查您的 API 凭据。

脚本结果

下表列出了使用启用客户名单操作时脚本结果输出的值:

脚本结果名称 值
is_success true 或 false

激活网络列表

使用激活网络列表操作在 Akamai 预演或生产环境中激活特定网络列表。

此操作不会在 Google SecOps 实体上运行。

操作输入

Activate Network List 操作需要以下参数:

参数 说明
Network List Name

可选。

要激活的网络列表的名称。匹配区分大小写。

您必须提供 Network List Name 或 Network List ID。如果您同时提供这两者,则操作会使用 Network List ID。

Network List ID

可选。

要激活的网络列表的唯一标识符。

您必须提供 Network List Name 或 Network List ID。如果您同时提供这两者,则操作会使用 Network List ID。

Environment

可选。

网络列表激活的目标 Akamai 环境。

可能的值如下:

  • Production
  • Staging

默认值为 Production。

Comment

可选。

描述网络列表激活目的的注释。

Notification Recipients

可选。

网络列表激活完成后要通知的电子邮件地址的逗号分隔列表。

操作输出

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

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

以下示例展示了使用激活网络列表操作时收到的 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: Provide a value in "Network List Name" or "Network List ID" parameter.

操作失败。

在 Network List Name 或 Network List ID 参数中提供有效的标识符。

Error executing action "Activate Network List". Reason: "NETWORK_LIST_IDENTIFIER" network list wasn't found in Akamai.

操作失败。

验证指定的网络列表名称或 ID 是否存在于 Akamai 中,以及如果按 Network List Name 搜索,名称是否与确切的大小写匹配。

Error executing action "Activate Network List". Reason: ERROR_REASON

操作失败。

请检查与 Akamai 服务器的连接,验证您的 API 凭据是否具有对 Network Lists API 的写入权限,或检查您的输入参数。

脚本结果

下表列出了使用激活网络列表操作时脚本结果输出的值:

脚本结果名称 值
is_success true 或 false

将商品添加到客户名单

使用向客户端列表添加项操作,将一个或多个项(例如 IP 地址、地理位置、自治系统编号、TLS 指纹或文件哈希)添加到 Akamai 中的现有客户端列表。

该操作会单独处理每个项,并在 JSON 结果中报告 status 为 added、duplicated(如果该项已存在于列表中)或 failed。添加项会更新 Akamai 中的客户端列表,但在您为目标环境运行激活客户端列表操作之前,更改不会在 Akamai 边缘生效。

此操作不会在 Google SecOps 实体上运行。

操作输入

Add Items To Client List 操作需要以下参数:

参数 说明
Client List Name

可选。

要更新的客户名单的名称。匹配不区分大小写。

您必须提供 Client List Name 或 Client List ID。如果您同时提供这两者,则操作会使用 Client List ID。

Client List ID

可选。

要更新的客户名单的唯一标识符。匹配不区分大小写。

您必须提供 Client List Name 或 Client List ID。如果您同时提供这两者,则操作会使用 Client List ID。

Item Value

必填。

要添加到客户端列表中的项值逗号分隔列表。

Item Description

可选。

要与所添加项关联的说明。

Item Expiration Date

可选。

所添加内容的失效日期,采用 ISO 8601 格式,例如 YYYY-MM-DDTHH:MM:SSZ 或 YYYY-MM-DDTHH:MM:SS+00:00。

Item Tags

可选。

要与添加的项关联的标签逗号分隔列表。

操作输出

将项目添加到客户端列表操作提供以下输出:

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

以下示例展示了使用向客户名单添加内容操作时收到的 JSON 结果输出:

[
  {
    "createDate": "2026-03-20T09:54:11.410+00:00",
    "createdBy": "4wksaj3wyt23jt2i",
    "description": "Blocked IP indicator",
    "expirationDate": "2026-04-05T19:29:02.320+00:00",
    "tags": [],
    "type": "IP",
    "updateDate": "2026-03-20T09:54:11.410+00:00",
    "updatedBy": "4wksaj3wyt23jt2i",
    "value": "192.0.2.1",
    "status": "added"
  },
  {
    "value": "192.0.2.3",
    "status": "duplicated"
  },
  {
    "value": "192.0.2.TT",
    "status": "failed",
    "error": "Validation failed: append[0].value: Item of type IP has an invalid value 192.0.2.TT"
  }
]
输出消息

Add Items To Client List 操作提供以下输出消息:

输出消息 消息说明
Successfully updated client list in Akamai.

操作成功。

所有指定的项要么已添加到客户名单 ("status": "added"),要么已存在于名单中 ("status": "duplicated")。

One or more items were not added. See JSON results for details.

该操作未能添加一个或多个指定项 ("status": "failed")。

如果该批次中至少有一项已添加到列表中或已存在于列表中,则 is_success 仍为 true。如果所有项都失败,则 is_success 为 false。查看 JSON 结果输出,检查每个失败项的 error 详细信息,并验证 Item Value 参数中的每个值是否与目标客户名单的数据类型匹配。

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

操作失败。

在 Client List Name 或 Client List ID 参数中提供有效的标识符。

Error executing action "Add Items To Client List". Reason: "CLIENT_LIST_IDENTIFIER" client list wasn't found in Akamai.

操作失败。

请验证指定的客户端列表名称或 ID 是否存在于 Akamai 中,以及您的 API 凭据是否有权访问客户端列表。

Error executing action "Add Items To Client List". Reason: ERROR_REASON

操作失败。

请检查与 Akamai 服务器的连接,验证 Item Expiration Date 参数是否使用了有效的 ISO 8601 格式,或检查您的 API 凭据。

脚本结果

下表列出了使用将内容添加到客户列表操作时脚本结果输出的值:

脚本结果名称 值
is_success true 或 false

向网络列表添加内容

使用向网络列表添加项操作,将一个或多个项(例如 IP 地址、CIDR 块或地理位置)附加到 Akamai 中的现有网络列表。

添加项会更新 Akamai 中的网络列表,但在您针对目标环境运行激活网络列表操作之前,更改不会在 Akamai 边缘生效。

此操作不会在 Google SecOps 实体上运行。

操作输入

Add Items To Network List 操作需要以下参数:

参数 说明
Network List Name

可选。

要更新的网络列表的名称。匹配区分大小写。

您必须提供 Network List Name 或 Network List ID。如果您同时提供这两者,则操作会使用 Network List ID。

Network List ID

可选。

要更新的网络列表的唯一标识符。

您必须提供 Network List Name 或 Network List ID。如果您同时提供这两者,则操作会使用 Network List ID。

Items

必填。

要添加到网络列表中的项的逗号分隔列表。

操作输出

Add Items To Network List(向网络列表添加内容)操作提供以下输出:

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
案例墙表格 不可用
丰富化表 不可用
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"
    }
  }
}
输出消息

Add Items To Network List 操作会提供以下输出消息:

输出消息 消息说明
Successfully updated network list 'NETWORK_LIST_IDENTIFIER' in Akamai. 操作成功。
Failed to update network list 'NETWORK_LIST_IDENTIFIER' in Akamai.

操作失败。

请验证 Items 参数中的值对于目标网络列表类型是否有效,以及该列表是否不是只读的。

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

操作失败。

在 Network List Name 或 Network List ID 参数中提供有效的标识符。

Error executing action "Add Items To Network List". Reason: "NETWORK_LIST_IDENTIFIER" network list wasn't found in Akamai.

操作失败。

验证指定的网络列表名称或 ID 是否存在于 Akamai 中,以及如果按 Network List Name 搜索,名称是否与确切的大小写匹配。

Error executing action "Add Items To Network List". Reason: ERROR_REASON

操作失败。

检查与 Akamai 服务器的连接,验证 Items 参数的格式,或检查您的 API 凭据。

脚本结果

下表列出了使用将内容添加到网络列表操作时脚本结果输出的值:

脚本结果名称 值
is_success true 或 false

获取客户名单

使用获取客户端列表操作可检索在 Akamai 中配置的客户端列表的元数据和内容。

此操作不会在 Google SecOps 实体上运行。

操作输入

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

参数 说明
Client List Name

可选。

要检索的客户名单名称的逗号分隔列表。匹配区分大小写。

如果您未提供 Client List Name 或 Client List ID,该操作会返回所有可用的客户名单,最多不超过指定的限制。

Client List ID

可选。

要检索的客户名单 ID 的逗号分隔列表。匹配不区分大小写。

如果您未提供 Client List Name 或 Client List ID,该操作会返回所有可用的客户名单,最多不超过指定的限制。

Include Items

可选。

如果选中,该操作会返回每个匹配的客户端列表中的项的相关信息。

仅当您在 Client List Name 或 Client List ID 中提供值时,该操作才会返回此信息。

Type

可选。

要搜索的客户名单类型。如果设置为 Select One,该操作会搜索所有客户名单类型。

可能的值如下:

  • Select One
  • IP
  • GEO
  • ASN
  • TLS Fingerprint
  • File Hash

默认值为 Select One。

Max Client Lists To Return

必填。

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

最大值为 100。

默认值为 100。

Max Client List Items To Return

必填。

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

最大值为 100。

默认值为 100。

操作输出

获取客户名单操作会提供以下输出:

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

以下示例展示了使用获取客户名单操作时收到的 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.

操作失败。

验证指定的客户端列表名称或 ID 是否存在于 Akamai 中,是否与所选 Type 过滤条件匹配,以及在按 Client List Name 搜索时是否使用了确切的大小写。

Error executing action "Get Client Lists". Reason: ERROR_REASON

操作失败。

请检查与 Akamai 服务器的连接,验证返回参数的最大值是否介于 1 和 100 之间,或检查您的 API 凭据。

脚本结果

下表列出了使用获取客户名单操作时脚本结果输出的值:

脚本结果名称 值
is_success true 或 false

获取网络列表

使用获取网络列表操作可检索 Akamai 中配置的网络列表的元数据、内容和激活状态。

此操作不会在 Google SecOps 实体上运行。

操作输入

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

参数 说明
Network List Name

可选。

要检索的网络列表名称的逗号分隔列表。匹配区分大小写。

如果您未提供 Network List Name 或 Network List ID,该操作会返回所有可用的网络列表,最多不超过指定的限制。

Network List ID

可选。

要检索的网络列表 ID 的逗号分隔列表。匹配不区分大小写。

如果您未提供 Network List Name 或 Network List ID,该操作会返回所有可用的网络列表,最多不超过指定的限制。

Include Items

可选。

如果选中,该操作会返回每个网络列表中包含的内容。

Include Activation Status

可选。

如果选择此选项,该操作会返回每个匹配网络列表的激活状态。

仅当您在 Network List Name 或 Network List ID 中提供值时,该操作才会返回此信息。

Activation Environment

可选。

当您选择 Include Activation Status 并提供特定 Network List Name 或 Network List ID 时,要返回其网络列表激活状态的环境。

可能的值如下:

  • Both
  • Production
  • Staging

默认值为 Both。

Max Network Lists To Return

必填。

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

最大值为 100。

默认值为 100。

Max Network List Items To Return

必填。

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

最大值为 100。

默认值为 100。

操作输出

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

操作输出类型 可用性
案例墙附件 不可用
案例墙链接 不可用
案例墙表格 不可用
丰富化表 不可用
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"
      }
    },
    "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.

操作失败。

验证指定的网络列表名称或 ID 是否存在于 Akamai 中,以及按 Network List Name 搜索时名称是否完全匹配。

Error executing action "Get Network Lists". Reason: ERROR_REASON

操作失败。

请检查与 Akamai 服务器的连接,验证返回参数的最大值是否介于 1 和 100 之间,或检查您的 API 凭据。

脚本结果

下表列出了使用获取网络列表操作时脚本结果输出的值:

脚本结果名称 值
is_success true 或 false

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 ERROR_REASON

操作失败。

验证 Host 网址是否可访问,检查您的 Akamai EdgeGrid 令牌和密钥是否有效,并确认 API 客户端是否有权访问 Network Lists API。

脚本结果

下表列出了使用 Ping 操作时脚本结果输出的值:

脚本结果名称 值
is_success true 或 false

从客户列表中移除内容

使用从客户端列表中移除项操作可从 Akamai 中的现有客户端列表中移除一个或多个项。

该操作会单独处理每个项,并在 JSON 结果中报告 status、removed doesn't exist(如果该项不在列表中)或 failed。移除项会更新 Akamai 中的客户端列表,但在您针对目标环境运行激活客户端列表操作之前,更改不会在 Akamai 边缘生效。

此操作不会在 Google SecOps 实体上运行。

操作输入

Remove Items From Client List 操作需要以下参数:

参数 说明
Client List Name

可选。

要更新的客户名单的名称。匹配不区分大小写。

您必须提供 Client List Name 或 Client List ID。如果您同时提供这两者,则操作会使用 Client List ID。

Client List ID

可选。

要更新的客户名单的唯一标识符。匹配不区分大小写。

您必须提供 Client List Name 或 Client List ID。如果您同时提供这两者,则操作会使用 Client List ID。

Item Value

必填。

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

操作输出

从客户端列表中移除内容操作提供以下输出:

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

以下示例展示了使用从客户名单中移除内容操作时收到的 JSON 结果输出:

[
  {
    "value": "192.0.2.1",
    "status": "doesn't exist"
  },
  {
    "value": "192.0.2.4",
    "status": "removed"
  },
  {
    "value": "192.0.2.4E",
    "status": "failed",
    "error": "Validation failed: delete[0].value: Item of type IP has an invalid value 192.0.2.4E"
  }
]
输出消息

从客户端列表中移除内容操作会提供以下输出消息:

输出消息 消息说明
Successfully updated client list in Akamai.

操作成功。

所有指定项均已从客户名单中移除 ("status": "removed") 或已不在名单中 ("status": "doesn't exist")。

One or more items were not removed. See JSON results for details.

该操作未能移除一个或多个指定项 ("status": "failed")。

如果批处理中至少有一项的状态为 removed 或 doesn't exist,则 is_success 仍为 true。如果所有项都失败,则 is_success 为 false。查看 JSON 结果输出,检查每个失败项的 error 详细信息,并验证 Item Value 参数中的每个值对于目标客户名单是否有效。

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

操作失败。

在 Client List Name 或 Client List ID 参数中提供有效的标识符。

Error executing action "Remove Items From Client List". Reason: "CLIENT_LIST_IDENTIFIER" client list wasn't found in Akamai.

操作失败。

请验证指定的客户端列表名称或 ID 是否存在于 Akamai 中,以及您的 API 凭据是否有权访问客户端列表。

Error executing action "Remove Items From Client List". Reason: ERROR_REASON

操作失败。

检查与 Akamai 服务器的连接,验证 Item Value 参数的格式,或检查您的 API 凭据。

脚本结果

下表列出了使用从客户名单中移除项目操作时脚本结果输出的值:

脚本结果名称 值
is_success true 或 false

从网络列表中移除内容

使用从网络列表中移除项操作,从 Akamai 中的现有网络列表中移除一个或多个项。

移除内容会更新 Akamai 中的网络列表,但只有在您针对目标环境运行激活网络列表操作后,更改才会在 Akamai 边缘生效。

此操作不会在 Google SecOps 实体上运行。

操作输入

从网络列表中移除内容操作需要以下参数:

参数 说明
Network List Name

可选。

要更新的网络列表的名称。匹配区分大小写。

您必须提供 Network List Name 或 Network List ID。如果您同时提供这两者,则操作会使用 Network List ID。

Network List ID

可选。

要更新的网络列表的唯一标识符。

您必须提供 Network List Name 或 Network List ID。如果您同时提供这两者,则操作会使用 Network List ID。

Items

必填。

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

操作输出

从网络列表中移除项操作提供以下输出:

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

以下示例展示了使用从网络列表中移除内容操作时收到的 JSON 结果输出:

[
  {
    "networkListType": "networkListResponse",
    "accessControlGroup": "KSD\nwith ION 3-13H1234",
    "name": "General List",
    "elementCount": 3010,
    "readOnly": false,
    "shared": false,
    "syncPoint": 23,
    "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.

操作成功。

如果您在 Items 参数中指定了多个项,则只要该操作从网络列表中移除了至少一个项,就会成功。

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

该操作未能移除任何指定内容。

验证 Items 参数中指定的值是否存在于目标网络列表中。

No valid items provided for removal. Please provide a comma-separated list of items.

操作失败。

在 Items 参数中提供一个或多个以英文逗号分隔的有效值。

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

操作失败。

在 Network List Name 或 Network List ID 参数中提供有效的标识符。

Error executing action "Remove Items From Network List". Reason: "NETWORK_LIST_IDENTIFIER" network list wasn't found in Akamai.

操作失败。

验证指定的网络列表名称或 ID 是否存在于 Akamai 中,以及如果按 Network List Name 搜索,名称是否与确切的大小写匹配。

Error executing action "Remove Items From Network List". Reason: ERROR_REASON

操作失败。

检查与 Akamai 服务器的连接,验证 Items 参数的格式,或检查您的 API 凭据。

脚本结果

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

脚本结果名称 值
is_success true 或 false

需要更多帮助?获得社区成员和 Google SecOps 专业人士的解答。