Skip to main content
23.10
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

新しいフックソースを作成

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

作成するフックソースAPIリソースの希望する値を示します。

パラメータ

Name を入力します 入力 必須 説明

account_id

string

path(パス)

True

包含するアカウントリソースのID

  • 例:{{.Account}}

要求の本文

作成するフックソースAPIリソースの希望する値を示します。

Name を入力します 必須 説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです:

  • "application/astra-hookSource"

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです:

  • "1.0"

名前

string

True

ユーザーが指定したリソース名を含むJSON文字列。定義された値は次のとおりです:

  • 最小長さ:1

  • 最大長:63 名前はすべてのフックソースリソース内で一意である必要があります。

sourceType

string

True

フックソースのタイプを定義するJSON文字列。定義された値は次のとおりです:

  • 「script」 - シェルスクリプト。プレーンテキストソースには、バイナリデータまたはキャリッジリターン文字を含めてはなりません。含めた場合はエラーが返されます。

ソース

string

True

base64形式で実行するスクリプトを含むJSON文字列。定義された値は次のとおりです:

  • 最小長さ:0

  • 最大長さ:131072

  • base64エンコードデータスキーマに準拠しています。base64を使用してエンコードした場合、ソース値の最大サイズは128 KiBです。

description

string

False

フックソースに関するユーザー指定の説明を含むJSON文字列。定義された値は次のとおりです:

  • 最小長さ:0

  • 最大長さ:511

メタデータ

"type_astra_metadata_update"

False

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、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 を入力します 必須 説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです:

  • "application/astra-hookSource"

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです:

  • "1.0"

ID

string

True

リソースのグローバル一意識別子。定義された値は次のとおりです:

  • UUIDv4スキーマに準拠

名前

string

True

ユーザーが指定したリソース名を含むJSON文字列。定義された値は次のとおりです:

  • 最小長さ:1

  • 最大長:63 名前はすべてのフックソースリソース内で一意である必要があります。

プライベート

string

True

ソースフィールドがAPIで公開されるか、意図的に空白のままにされるかを示すJSON文字列。定義された値は次のとおりです:

  • 「true」 - ソース値は非公開であり、API を通じて公開されることはありません。

  • 「false」 - ソース値は非公開ではなく、API を通じて公開されます。

プリロード済み

string

True

ソースがプリロードされたかどうかを示すJSON文字列。定義された値は次のとおりです:

  • 「true」 - ソースはプリロードされています。

  • 「false」 - ソースがプリロードされていませんでした。プリロードされたフックソースリソースは読み取り専用です。

sourceType

string

True

フックソースのタイプを定義するJSON文字列。定義された値は次のとおりです:

  • 「script」 - シェルスクリプト。プレーンテキストソースには、バイナリデータまたはキャリッジリターン文字を含めてはなりません。含めた場合はエラーが返されます。

ソース

string

False

base64形式で実行するスクリプトを含むJSON文字列。定義された値は次のとおりです:

  • 最小長さ:0

  • 最大長さ:131072

  • base64エンコードデータスキーマに準拠しています。base64を使用してエンコードした場合、ソース値の最大サイズは128 KiBです。

sourceMD5Checksumを使用したチャンク アップロード署名要求がサポートされるようになりました。

string

True

「source」キーの値に対して計算されたMD5チェックサムを含むJSON文字列。定義された値は次のとおりです:

  • 定義された正規表現は次のとおりです:"^([0-9a-fA-F]){32}$"

description

string

False

フックソースに関するユーザー指定の説明を含むJSON文字列。定義された値は次のとおりです:

  • 最小長さ:0

  • 最大長さ:511

メタデータ

"type_astra_metadata_update"

True

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、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 を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

回答例
{
  "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 を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

invalidFields

配列["invalidFields"]

False

無効なリクエストボディフィールドのリスト

回答例
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

応答

Status: 409, Conflict
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

invalidFields

配列["invalidFields"]

False

無効なリクエストボディフィールドのリスト

回答例
{
  "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 を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

回答例
{
  "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 を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

エラー応答の例
{
  "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 を入力します 必須 説明

名前

string

True

Value

string

True

type_astra_metadata_update

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

Name を入力します 必須 説明

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

無効なクエリパラメータの名前

理由

string

True

クエリパラメータが無効な理由

invalidFields

Name を入力します 必須 説明

名前

string

True

無効なリクエストボディフィールドの名前

理由

string

True

リクエスト本文フィールドが無効な理由