整合 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」動作測試與 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 結果

以下範例說明使用「取得網路清單」動作時收到的 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) 動作失敗。
指令碼結果

下表說明使用「取得網路清單」動作時，指令碼結果輸出的值：

指令碼結果名稱 值
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 結果

以下範例說明使用「將項目新增至聯播網清單」動作時收到的 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 結果

下列範例說明使用「啟用網路清單」動作時收到的 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.

 動作失敗。
指令碼結果

下表說明使用「啟用網路清單」動作時，指令碼結果輸出的值：

指令碼結果名稱 值
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 結果

    以下範例說明使用「取得用戶端清單」動作時收到的 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.

    		 動作成功。
    Error executing action "Get Client Lists". Reason: {0}''.format (error.Stacktrace) 動作失敗。
    指令碼結果

    下表說明使用「取得用戶端清單」動作時，指令碼結果輸出的值：

    指令碼結果名稱 值
    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

    選填。

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

    動作輸出內容

    「Add Items To Client List」(將項目新增至用戶端清單) 動作會提供下列輸出內容：

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

    「Add Items To Client List」(將項目新增至用戶端清單) 動作會提供下列輸出訊息：

    輸出訊息 訊息說明
    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.

    		 動作失敗。
    指令碼結果

    下表說明使用「從用戶端清單中移除項目」動作時，指令碼結果輸出的值：

    指令碼結果名稱 值
    is_success True或False

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