Put Trigger

Prev Next

Classic/VPC環境で利用できます。

Cloud Functionsトリガーを作成したり、変更したりします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
PUT /triggers/{triggerName}

リクエストヘッダ

Cloud Funtions APIで共通して使用されるヘッダの詳細は、Cloud Functionsの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
triggerName String Required トリガー名
  • 英数字、記号の「-」、「_」のみ使用して1~50文字以内で入力、先頭文字に「-」は使用不可
  • 他のリソース(パッケージ、アクション、トリガー)名と重複不可

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
platform String Optional プラットフォーム区分
  • vpc | classic(デフォルト)
type String Required トリガータイプ
  • cron | github | insight | object_storage | source_commit
  • 作成後は変更不可

リクエストボディ

リクエストボディの説明は次の通りです。

cronトリガー

cronトリガーのリクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
trigger Object Required トリガー情報
trigger.description String Optional トリガーの説明(Byte)
  • 0~3,000
trigger.cronOption String Required cronの実行オプション
trigger.parameters Object Optional トリガーの基本パラメータ
  • {"key": "value"}形式の JSON
  • アクション実行時、パラメータ適用の優先順位
    • 1番目: 実行時に渡されるランタイムパラメータ
    • 2番目: 関連付けられているトリガーの基本パラメータ
    • 3番目: アクションの基本パラメータ
    • 4番目: 含まれているパッケージの基本パラメータ

GitHubトリガー

GitHubトリガーのリクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
trigger Object Required トリガー情報
trigger.description String Optional トリガーの説明
  • 0~3,000bytes
trigger.parameters Object Optional トリガーの基本パラメータ
  • {"key": "value"}形式の JSON
  • アクション実行時、パラメータ適用の優先順位
    • 1番目: 実行時に渡されるランタイムパラメータ
    • 2番目: 関連付けられているトリガーの基本パラメータ
    • 3番目: アクションの基本パラメータ
    • 4番目: 含まれているパッケージの基本パラメータ
trigger.credentials.username String Required GitHubユーザー名
trigger.credentials.accessToken String Required GitHubアクセストークン
trigger.credentials.repository String Required GitHubリポジトリ
  • リポジトリ名またはOrganization/リポジトリ名形式で入力
trigger.events Array Required トリガーするイベント
  • * | check_run | check_suite | commit_comment | create | delete | deployment | deployment_status | fork | gollum | issue_comment | issues | label | member | milestone | page_build | project_card | project_column | project | public | pull_request_review_comment | pull_request_review_thread | pull_request_review | pull_request | push | repository | repository_import | repository_vulnerability_alert | release | status | team_add | watch | branch_protection_rule | code_scanning_alert | deploy_key | discussion_comment | discussion | meta | package | registry_package | secret_scanning_alert_location | secret_scanning_alert | security_and_analysis | star | workflow_job | workflow_run
link Object Conditional API Gateway情報
  • トリガー作成時にのみ有効で、必ず入力
link.productId String Conditional API Gatewayの商品 ID
link.apiName String Conditional API Gateway API名
link.stageName String Conditional API Gatewayのステージ名

Cloud Insightトリガー

Cloud Insightトリガーのリクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
trigger Object Required トリガー情報
trigger.description String Optional トリガーの説明(Byte)
  • 0~3,000
trigger.parameters Object Optional トリガーの基本パラメータ
  • {"key": "value"}形式の JSON
  • アクション実行時、パラメータ適用の優先順位
    • 1番目: 実行時に渡されるランタイムパラメータ
    • 2番目: 関連付けられているトリガーの基本パラメータ
    • 3番目: アクションの基本パラメータ
    • 4番目: 含まれているパッケージの基本パラメータ
trigger.insightLink Object[] Required Cloud Insight情報
trigger.insightLink[].prodKey String Required Cloud Insightイベントルールの prodKey
trigger.insightLink[].ruleGrpId String Required Cloud Insightイベントルールの ruleGrpId
trigger.insightLink[].reminderTime Integer Optional Cloud Insightイベントルールのリマインダー周期(分)
  • 5~720
trigger.insightLink[].enableNotiWhenEventClose Boolean Optional イベント終了時に Cloud Insightイベントルールを呼び出すかどうか
  • true | false(デフォルト)

Object Storageトリガー

Object Storageトリガーのリクエストボディの説明は次の通りです。

注意

Object Storageトリガーに関連付けられたアクションが Object Storageイベントルールと同じバケットを使用する場合、再帰呼び出しによる使用量の増加や多額の費用が発生する可能性があります。

フィールド タイプ 必須の有無 説明
trigger Object Required トリガー情報
trigger.description String Optional トリガーの説明(Byte)
  • 0~3,000
trigger.parameters Object Optional トリガーの基本パラメータ
  • {"key": "value"}形式の JSON
  • アクション実行時、パラメータ適用の優先順位
    • 1番目: 実行時に渡されるランタイムパラメータ
    • 2番目: 関連付けられているトリガーの基本パラメータ
    • 3番目: アクションの基本パラメータ
    • 4番目: 含まれているパッケージの基本パラメータ
trigger.objectStorageLink Object[] Required Object Storage情報
trigger.objectStorageLink[].bucketName String Required Object Storageのバケット名
trigger.objectStorageLink[].eventRuleName String Required Object Storageのイベントルール名

Source Commitトリガー

Source Commitトリガーを作成または変更するリクエストボディの説明は次の通りです。

参考

SourceCommitトリガーは韓国リージョンの VPCプラットフォームでのみサポートしています。

フィールド タイプ 必須の有無 説明
trigger Object Required トリガー情報
trigger.description String Optional トリガーの説明(Byte)
  • 0~3,000
trigger.parameters Object Optional トリガーの基本パラメータ
  • {"key": "value"}形式の JSON
  • アクション実行時、パラメータ適用の優先順位
    • 1番目: 実行時に渡されるランタイムパラメータ
    • 2番目: 関連付けられているトリガーの基本パラメータ
    • 3番目: アクションの基本パラメータ
    • 4番目: 含まれているパッケージの基本パラメータ
trigger.sourceCommitLink Object[] Required SourceCommit情報
trigger.sourceCommitLink[].enable Boolean Optional SourceCommit Webフックを有効化するかどうか
  • true (デフォルト) | false
    trigger.sourceCommitLink[].repositoryName String Required SourceCommitリポジトリ名
    trigger.sourceCommitLink[].webhookName String Required SourceCommit Webフック名

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location --request PUT 'https://cloudfunctions.apigw.ntruss.com/api/v2/triggers/trigger002?platform=vpc' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '<下記参照>'

    {
    "trigger": {
        "description": "cron Trigger",
        "cronOption": "0 10 * * *",
        "parameters": {

        }
    }
}

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    リクエストしたトリガーに応じたレスポンスボディの説明は次の通りです。

    Cronトリガー

    Cronトリガーのレスポンスボディの説明は次の通りです。

    フィールド タイプ 説明
    content.cronOptions String トリガー cron実行オプション
    content.description String トリガーの説明
    content.name String トリガー名
    content.namespace String ユーザーのネームスペース
    content.parameters Object トリガーの基本パラメータ
    content.resourceId String トリガーのリソース ID
    content.rules String トリガーアクションの関連付け情報
    content.triggerType String トリガーのタイプ

    GitHubトリガー

    GitHubトリガーのレスポンスボディの説明は次の通りです。

    フィールド タイプ 説明
    content.credentials Object トリガー GitHub連携情報
    content.description String トリガーの説明
    content.events String トリガーの実行 GitHubイベントオプション
    content.name String トリガー名
    content.namespace String ユーザーのネームスペース
    content.parameters Object トリガーの基本パラメータ
    content.resourceId String -
    content.rules String トリガーアクションの関連付け情報
    link.stageName String トリガーのタイプ

    Cloud Insightトリガー

    Cloud Insightトリガーのレスポンスボディの説明は次の通りです。

    フィールド タイプ 説明
    content.description String トリガーの説明
    content.name String トリガー名
    content.namespace String ユーザーのネームスペース
    content.parameters Object トリガーの基本パラメータ
    content.insightLink Object[] 関連付けられた Cloud Insightイベントルール情報
    content.insightLink[].prodKey String Cloud Insightイベントルールの prodKey
    content.insightLink[].ruleGrpId String Cloud Insightイベントルールの groupId
    content.insightLink[].reminderTime Integer Cloud Insightイベントルールのリマインダー周期(分)
    content.insightLink[].enableNotiWhenEventClose Boolean イベント終了時に Cloud Insightイベントルールを呼び出すかどうか
    content.resourceId String -
    content.rules String -
    content.triggerType String -

    Object Storageトリガー

    Object Storageトリガーのレスポンスボディの説明は次の通りです。

    フィールド タイプ 説明
    content.description String トリガーの説明
    content.name String トリガー名
    content.namespace String ユーザーのネームスペース
    content.parameters Object トリガーの基本パラメータ
    content.objectStorageLink Object[] 関連付けられた Object Storageイベントルール情報
    content.objectStorageLink[].bucketName String Object Storageイベントルールのバケット名
    content.objectStorageLink[].eventRuleName String Object Storageのイベントルール名
    content.resourceId String トリガーのリソース ID
    content.rules String トリガーアクションの関連付け情報
    content.triggerType String トリガーのタイプ

    Source Commitトリガー

    Source Commitトリガーのレスポンスボディの説明は次の通りです。

    フィールド タイプ 説明
    content.description String トリガーの説明
    content.name String トリガー名
    content.namespace String ユーザーのネームスペース
    content.parameters Object トリガーの基本パラメータ
    content.sourceCommitLink Object[] リンクされた Source Commitのリポジトリ情報
    content.sourceCommitLink[].enable Boolean Source Commit Webフックを有効化するかどうか
    content.sourceCommitLink[].repositoryName String Source Commitリポジトリ名
    content.sourceCommitLink[].webhookName String Source Commit Webフック名
    content.resourceId String トリガーのリソース ID
    content.rules String トリガーアクションの関連付け情報
    content.triggerType String トリガーのタイプ

    レスポンスステータスコード

    NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
    "content": {
        "cronOption": "0 10 * * *",
        "description": "cron Trigger",
        "limits": {},
        "name": "trigger002",
        "namespace": "****YBNz****",
        "parameters": {},
        "resourceId": "Nu3**",
        "rules": {},
        "triggerType": "Cron"
    }
}