將 Akamai 與 Google SecOps 整合

本文說明如何將 Akamai 與 Google Security Operations 整合。

用途

Akamai 整合功能會使用 Google SecOps 功能,支援下列用途:

  • 在邊緣自動封鎖威脅:將調查期間發現的惡意 IP 位址、CIDR 區塊、自治系統編號、地理位置、TLS 指紋或檔案雜湊,新增至 Akamai 用戶端清單或網路清單,在網路邊緣封鎖威脅。

  • 管理動態存取控管和許可清單:解決誤判或暫時限制到期後,從 Akamai 用戶端清單和網路清單中移除良性指標或過期項目。

  • 在不同環境中部署政策更新:直接透過自動化教戰手冊,在 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 解析用戶端清單 ID,並使用 POST /client-list/v2/lists/{listId}/activations 啟用目標清單。
啟用網路清單 Network Lists API v2 Read-Write 使用 GET /network-list/v2/network-lists 解析網路清單 ID,並使用 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 解析聯播網清單 ID,並使用 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 解析網路清單 ID,並使用 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 中設定整合功能,請參閱「設定整合功能」。

如有需要,您可以在後續階段進行變更。設定整合執行個體後,即可在應對手冊中使用。如要進一步瞭解如何設定及支援多個執行個體,請參閱「支援多個執行個體」。

動作

如要進一步瞭解動作,請參閱「 在工作區回應待處理動作」和「在案件中執行手動動作」。

啟用客戶名單

使用「Activate Client List」動作,在 Akamai 測試或正式環境中啟用特定用戶端清單。

這項動作不會在 Google SecOps 實體上執行。

動作輸入內容

「啟用客戶清單」動作需要下列參數:

參數 說明
Client List Name

選填。

要啟用的客戶清單名稱。比對時須區分大小寫。

您必須提供 Client List Name 或 Client List ID。如果兩者都提供,動作會使用 Client List ID。

Client List ID

選填。

要啟用的客戶清單專屬 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 參數中提供有效的 ID。

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

動作失敗。

請確認 Akamai 中有指定的用戶端清單名稱或 ID,且名稱的大小寫與 Client List Name 搜尋結果完全相符。

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

動作失敗。

請檢查與 Akamai 伺服器的連線、確認目標客戶清單中有可啟用的項目,或檢查 API 憑證。

指令碼執行結果

下表列出使用「啟用客戶清單」動作時,指令碼結果輸出的值:

指令碼結果名稱 值
is_success true或false

啟用網路清單

使用「Activate Network List」動作,在 Akamai 測試或正式環境中啟用特定網路清單。

這項動作不會在 Google SecOps 實體上執行。

動作輸入內容

「啟用網路清單」動作需要下列參數:

參數 說明
Network List Name

選填。

要啟用的網路清單名稱。比對時須區分大小寫。

您必須提供 Network List Name 或 Network List ID。如果兩者都提供,動作會使用 Network List ID。

Network List ID

選填。

要啟用的網路清單專屬 ID。

您必須提供 Network List Name 或 Network List ID。如果兩者都提供,動作會使用 Network List ID。

Environment

選填。

啟用網路清單的目標 Akamai 環境。

可能的值如下:

  • Production
  • Staging

預設值為 Production。

Comment

選填。

說明啟用網路清單用途的註解。

Notification Recipients

選填。

網路清單啟用完成時,要通知的電子郵件地址清單 (以半形逗號分隔)。

動作輸出內容

「啟用網路清單」動作會提供下列輸出內容:

動作輸出類型 可用性
案件總覽附件 無法使用
案件總覽連結 無法使用
案件總覽表格 無法使用
補充資訊表格 無法使用
JSON 結果 可用
輸出訊息 可用
指令碼執行結果 可用
JSON 結果

以下範例顯示使用「Activate Network List」(啟用網路清單) 動作時,收到的 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/"
    }
  }
}
輸出訊息

「Activate Network List」動作會提供下列輸出訊息:

輸出訊息 訊息說明
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 參數中提供有效的 ID。

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

動作失敗。

請確認 Akamai 中有指定的網路清單名稱或 ID,且名稱的大小寫與 Network List Name 搜尋結果完全相符。

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

動作失敗。

請檢查與 Akamai 伺服器的連線、確認 API 憑證具備 Network Lists API 的寫入權限,或檢查輸入參數。

指令碼執行結果

下表列出使用「Activate Network List」動作時,指令碼結果輸出的值:

指令碼結果名稱 值
is_success true或false

將項目新增至客戶清單

使用「Add Items To Client List」(將項目新增至用戶端清單) 動作,將一或多個項目 (例如 IP 位址、地理位置、自治系統編號、TLS 指紋或檔案雜湊) 新增至 Akamai 中的現有用戶端清單。

這項動作會個別處理每個項目,並在 JSON 結果中回報 added、duplicated (如果項目已在清單中) 或 failed 的 status。新增項目會更新 Akamai 中的用戶端清單,但只有在您對目標環境執行「Activate Client List」(啟用用戶端清單) 動作後,變更才會在 Akamai 邊緣生效。

這項動作不會在 Google SecOps 實體上執行。

動作輸入內容

「Add Items To Client List」動作需要下列參數:

參數 說明
Client List Name

選填。

要更新的客戶清單名稱。比對時不區分大小寫。

您必須提供 Client List Name 或 Client List ID。如果兩者都提供,動作會使用 Client List ID。

Client List ID

選填。

要更新的客戶清單專屬 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

選填。

以半形逗號分隔的標記清單,用於與新增的項目建立關聯。

動作輸出內容

「Add Items To Client List」動作會提供下列輸出內容:

動作輸出類型 可用性
案件總覽附件 無法使用
案件總覽連結 無法使用
案件總覽表格 無法使用
補充資訊表格 無法使用
JSON 結果 可用
輸出訊息 可用
指令碼執行結果 可用
JSON 結果

以下範例顯示使用「Add Items To Client List」動作時,收到的 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 參數中提供有效的 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 憑證。

指令碼執行結果

下表列出使用「Add Items To Client List」動作時,指令碼結果輸出的值:

指令碼結果名稱 值
is_success true或false

將項目新增至網路清單

使用「Add Items To Network List」動作,將一或多個項目 (例如 IP 位址、CIDR 區塊或地理位置) 附加至 Akamai 中的現有網路清單。

新增項目會更新 Akamai 中的網路清單,但必須對目標環境執行「Activate Network List」(啟用網路清單) 動作,變更才會在 Akamai 邊緣生效。

這項動作不會在 Google SecOps 實體上執行。

動作輸入內容

「Add Items To Network List」動作需要下列參數:

參數 說明
Network List Name

選填。

要更新的網路清單名稱。比對時須區分大小寫。

您必須提供 Network List Name 或 Network List ID。如果兩者都提供,動作會使用 Network List ID。

Network List ID

選填。

要更新的網路清單專屬 ID。

您必須提供 Network List Name 或 Network List ID。如果兩者都提供,動作會使用 Network List ID。

Items

這是必填欄位。

要新增至網路清單的項目,以半形逗號分隔。

動作輸出內容

「Add Items To Network List」動作會提供下列輸出內容:

動作輸出類型 可用性
案件總覽附件 無法使用
案件總覽連結 無法使用
案件總覽表格 無法使用
補充資訊表格 無法使用
JSON 結果 可用
輸出訊息 可用
指令碼執行結果 可用
JSON 結果

以下範例顯示使用「Add Items To Network List」動作時,收到的 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 參數中提供有效的 ID。

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

動作失敗。

請確認 Akamai 中有指定的網路清單名稱或 ID,且名稱的大小寫與 Network List Name 搜尋結果完全相符。

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

動作失敗。

請檢查與 Akamai 伺服器的連線、確認 Items 參數的格式,或查看 API 憑證。

指令碼執行結果

下表列出使用「Add Items To Network List」動作時,指令碼結果輸出的值:

指令碼結果名稱 值
is_success true或false

取得客戶名單

使用「Get Client Lists」動作,擷取 Akamai 中設定的用戶端清單中繼資料和項目內容。

這項動作不會在 Google SecOps 實體上執行。

動作輸入內容

「Get Client Lists」動作需要下列參數:

參數 說明
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。

動作輸出內容

「Get Client Lists」動作會提供下列輸出內容:

動作輸出類型 可用性
案件總覽附件 無法使用
案件總覽連結 無法使用
案件總覽表格 無法使用
補充資訊表格 無法使用
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
  }
]
輸出訊息

「Get Client Lists」動作會提供下列輸出訊息:

輸出訊息 訊息說明
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 憑證。

指令碼執行結果

下表列出使用「Get Client Lists」動作時,指令碼結果輸出的值:

指令碼結果名稱 值
is_success true或false

取得網路清單

使用「Get Network Lists」動作,擷取 Akamai 中設定的網路清單中繼資料、項目內容和啟用狀態。

這項動作不會在 Google SecOps 實體上執行。

動作輸入內容

「Get Network Lists」動作需要下列參數:

參數 說明
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。

動作輸出內容

「Get Network Lists」動作會提供下列輸出內容:

動作輸出類型 可用性
案件總覽附件 無法使用
案件總覽連結 無法使用
案件總覽表格 無法使用
補充資訊表格 無法使用
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/"
        }
      }
    }
  }
]
輸出訊息

「Get Network Lists」動作會提供下列輸出訊息:

輸出訊息 訊息說明
Successfully returned network lists from Akamai. 動作成功。
No network lists were found for the provided criteria in Akamai.

動作失敗。

請確認 Akamai 中存在指定的網路清單名稱或 ID,且名稱與依 Network List Name 搜尋時的大小寫完全一致。

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

動作失敗。

請檢查與 Akamai 伺服器的連線、確認傳回參數上限介於 1 和 100 之間,或查看 API 憑證。

指令碼執行結果

下表列出使用「Get Network Lists」動作時,指令碼結果輸出的值:

指令碼結果名稱 值
is_success true或false

乒乓

使用 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

從客戶清單中移除項目

使用「Remove Items From Client List」(從用戶端清單中移除項目) 動作,從 Akamai 的現有用戶端清單中移除一或多個項目。

這項動作會個別處理每個項目,並在 JSON 結果中回報 removed、doesn't exist (如果項目不在清單中) 或 failed 的 status。移除項目後,Akamai 中的用戶端清單會更新,但您必須對目標環境執行「Activate Client List」(啟用用戶端清單) 動作,變更才會在 Akamai 邊緣生效。

這項動作不會在 Google SecOps 實體上執行。

動作輸入內容

「Remove Items From Client List」動作需要下列參數:

參數 說明
Client List Name

選填。

要更新的客戶清單名稱。比對時不區分大小寫。

您必須提供 Client List Name 或 Client List ID。如果兩者都提供,動作會使用 Client List ID。

Client List ID

選填。

要更新的客戶清單專屬 ID。比對時不區分大小寫。

您必須提供 Client List Name 或 Client List ID。如果兩者都提供,動作會使用 Client List ID。

Item Value

這是必填欄位。

以半形逗號分隔的項目值清單,用於從用戶端清單中移除項目。

動作輸出內容

「Remove Items From Client List」動作會提供下列輸出內容:

動作輸出類型 可用性
案件總覽附件 無法使用
案件總覽連結 無法使用
案件總覽表格 無法使用
補充資訊表格 無法使用
JSON 結果 可用
輸出訊息 可用
指令碼執行結果 可用
JSON 結果

以下範例顯示使用「Remove Items From Client List」動作時,收到的 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"
  }
]
輸出訊息

「Remove Items From Client List」動作會提供下列輸出訊息:

輸出訊息 訊息說明
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 參數中提供有效的 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 憑證。

指令碼執行結果

下表列出使用「Remove Items From Client List」動作時,指令碼結果輸出的值:

指令碼結果名稱 值
is_success true或false

從網路清單中移除項目

使用「Remove Items From Network List」動作,從 Akamai 的現有網路清單中移除一或多個項目。

移除項目後,Akamai 的網路清單會更新,但您必須對目標環境執行「Activate Network List」(啟用網路清單) 動作,變更才會在 Akamai 邊緣生效。

這項動作不會在 Google SecOps 實體上執行。

動作輸入內容

Remove Items From Network List 動作需要下列參數:

參數 說明
Network List Name

選填。

要更新的網路清單名稱。比對時須區分大小寫。

您必須提供 Network List Name 或 Network List ID。如果兩者都提供,動作會使用 Network List ID。

Network List ID

選填。

要更新的網路清單專屬 ID。

您必須提供 Network List Name 或 Network List ID。如果兩者都提供,動作會使用 Network List ID。

Items

這是必填欄位。

要從網路清單中移除的項目,並以逗號分隔的清單呈現。

動作輸出內容

「Remove Items From Network List」動作會提供下列輸出內容:

動作輸出類型 可用性
案件總覽附件 無法使用
案件總覽連結 無法使用
案件總覽表格 無法使用
補充資訊表格 無法使用
JSON 結果 可用
輸出訊息 可用
指令碼執行結果 可用
JSON 結果

以下範例顯示使用「Remove Items From Network List」動作時,收到的 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"
      }
    }
  }
]
輸出訊息

Remove Items From Network List 動作會提供下列輸出訊息:

輸出訊息 訊息說明
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 參數中提供有效的 ID。

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

動作失敗。

請確認 Akamai 中有指定的網路清單名稱或 ID,且名稱的大小寫與 Network List Name 搜尋結果完全相符。

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

動作失敗。

請檢查與 Akamai 伺服器的連線、確認 Items 參數的格式,或查看 API 憑證。

指令碼執行結果

下表列出使用「Remove Items From Network List」動作時,指令碼結果輸出的值:

指令碼結果名稱 值
is_success true或false

還有其他問題嗎?向社群成員和 Google SecOps 專業人員尋求解答。