Skip to main content
Astra Automation
本繁體中文版使用機器翻譯，譯文僅供參考，若與英文版本牴觸，應以英文版本為準。

建立新的掛鉤來源

PDF

POST /accounts/{account_id}/core/v1/hookSources

指示要建立的 Hook Source API 資源所需的值。

參數

Name 類型 在 必要 說明

account_id

字串

路徑

True

包含帳戶資源的 ID

  • 範例：{{.Account}}

請求本文

指示要建立的 Hook Source API 資源所需的值。

Name 類型 必要 說明

類型

字串

True

資源的媒體類型。定義的值為：

  • "application/astra-hookSource"

版本

字串

True

資源版本。已定義值包括：

  • "1.0"

姓名

字串

True

包含使用者指定資源名稱的 JSON 字串。已定義的值包括：

  • 最短長度：1

  • 最大長度：63 名稱在所有 hook 來源資源中必須是唯一的。

sourceType

字串

True

定義勾點來源類型的 JSON 字串。已定義的值包括：

  • "script" - Shell 腳本。純文字來源不得包含二進位資料或歸位字元，否則將傳回錯誤。

來源

字串

True

包含待執行腳本的 JSON 字串，採用 base64 編碼格式。已定義的值包括：

  • 最短長度：0

  • 最大長度：131072

  • 符合 base64 編碼資料模式。使用 base64 編碼時，來源值的最大大小為 128 KiB。

描述

字串

錯誤

包含使用者指定的鉤子來源描述的 JSON 字串。已定義的值包括：

  • 最短長度：0

  • 最大長度：511

中繼資料

"type_astra_metadata_update"

錯誤

與資源相關聯的用戶端和服務指定中繼資料。定義的值為：

  • 遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。
範例請求 
{
  "type": "application/astra-hookSource",
  "version": "1.0",
  "name": "Payroll script",
  "sourceType": "script",
  "source": "ZWNobyAiVkhKaGJuTWdVbWxuYUhSeklRPT0iIHwgYmFzZTY0IC1k",
  "description": "Pre and post hook script for payroll"
}

回應

Status: 201, Returns the newly created hookSource resource in the JSON response body.
Name 類型 必要 說明

類型

字串

True

資源的媒體類型。定義的值為：

  • "application/astra-hookSource"

版本

字串

True

資源版本。已定義值包括：

  • "1.0"

ID

字串

True

資源的全域唯一識別碼。定義的值為：

  • 符合 UUIDv4 架構

姓名

字串

True

包含使用者指定資源名稱的 JSON 字串。已定義的值包括：

  • 最短長度：1

  • 最大長度：63 名稱在所有 hook 來源資源中必須是唯一的。

私有

字串

True

JSON 字串，指示來源欄位是否會在 API 中公開，還是故意留白。已定義的值包括：

  • "true" - 來源值為私有值，不會透過 API 公開。

  • "false" - 來源值不是私有的，將透過 API 公開。

預先載入

字串

True

指示來源是否已預先載入的 JSON 字串。定義的值包括：

  • "true" - 來源已預先載入。

  • 「 false 」：來源未預先載入。預先載入的掛鉤來源資源為唯讀。

sourceType

字串

True

定義勾點來源類型的 JSON 字串。已定義的值包括：

  • "script" - Shell 腳本。純文字來源不得包含二進位資料或歸位字元，否則將傳回錯誤。

來源

字串

錯誤

包含待執行腳本的 JSON 字串，採用 base64 編碼格式。已定義的值包括：

  • 最短長度：0

  • 最大長度：131072

  • 符合 base64 編碼資料模式。使用 base64 編碼時，來源值的最大大小為 128 KiB。

sourceMD5Checksum

字串

True

JSON 字串包含針對「source」鍵值計算出的 MD5 校驗和。已定義的值包括：

  • 定義的正規表示式為："^([0-9a-fA-F]){32}$"

描述

字串

錯誤

包含使用者指定的鉤子來源描述的 JSON 字串。已定義的值包括：

  • 最短長度：0

  • 最大長度：511

中繼資料

"type_astra_metadata_update"

True

與資源相關聯的用戶端和服務指定中繼資料。定義的值為：

  • 遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。
範例回應 
{
  "type": "application/astra-hookSource",
  "version": "1.0",
  "id": "fae6dfbb-ecb8-58ff-a116-6357eb7c956a",
  "name": "Payroll script",
  "private": "false",
  "preloaded": "false",
  "sourceType": "script",
  "source": "ZWNobyAiVkhKaGJuTWdVbWxuYUhSeklRPT0iIHwgYmFzZTY0IC1k",
  "sourceMD5Checksum": "b1a4b8b0144c3f6be553b626130ca145",
  "description": "Pre and post hook script for payroll",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

回應

Status: 401, Unauthorized
Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤
範例回應 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

回應

Status: 400, Bad request
Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤

invalidFields

陣列["invalidFields"]

錯誤

無效請求本文欄位清單
範例回應 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

回應

Status: 409, Conflict
Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤

invalidFields

陣列["invalidFields"]

錯誤

無效請求本文欄位清單
範例回應 
{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

回應

Status: 403, Forbidden
Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤
範例回應 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

錯誤

Status: 404, Not found
Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤
範例錯誤回應 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

定義

請參閱定義

type_astra_label

Name 類型 必要 說明

姓名

字串

True

值

字串

True

type_astra_metadata_update

與資源相關聯的用戶端和服務指定中繼資料。定義的值為：

  • 遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

Name 類型 必要 說明

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

invalidParams

Name 類型 必要 說明

姓名

字串

True

無效查詢參數的名稱

原因

字串

True

查詢參數無效的原因

invalidFields

Name 類型 必要 說明

姓名

字串

True

無效請求內文欄位的名稱

原因

字串

True

請求本文欄位無效的原因