Put Trigger

Prev Next

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

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

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

リクエスト

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

メソッド URI
PUT /ncf/api/v2/triggers/{triggerName}

リクエストヘッダ

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

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

リクエストパスパラメータの説明は次の通りです。

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

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

リクエストクエリパラメータの説明は次の通りです。

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

リクエストボディ

リクエストボディの説明は次の通りです。リクエストボディにフィールドがない場合、{}空の JSON Object形式でリクエストします。

共通

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

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

cronトリガー

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

フィールド タイプ 必須の有無 説明
cronOption String Required cronの実行オプション

GitHubトリガー

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

フィールド タイプ 必須の有無 説明
credential Object Required GitHub情報
credential.username String Required GitHubユーザー名
credential.accessToken String Required GitHubアクセストークン
credential.repository String Required GitHubリポジトリ
  • リポジトリ名またはOrganization/リポジトリ名形式で入力
events String[] 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.productName String Conditional API Gatewayのサービス名
link.apiName String Conditional API Gateway API名
link.stageName String Conditional API Gatewayのステージ名

Cloud Insightトリガー

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

フィールド タイプ 必須の有無 説明
insightLink Array Optional 関連付ける Cloud Insightイベントルール情報: insightLink

insightLink

insightLinkの説明は次の通りです。

フィールド タイプ 必須の有無 説明
prodKey String Conditional Cloud Insightイベントルールの prodKey
  • insightLink入力時、必須
ruleGrpId String Conditional Cloud Insightイベントルールの ruleGrpId
  • insightLink入力時、必須
reminderTime Integer Optional Cloud Insightイベントルールのリマインダー周期(分)
  • 5~720
enableNotiWhenEventClose Boolean Optional イベント終了時に Cloud Insightイベントルールを呼び出すかどうか
  • true | false(デフォルト)

Object Storageトリガー

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

注意

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

フィールド タイプ 必須の有無 説明
objectStorageLink Array Required 関連付ける Object Storageイベントルール情報: objectStorageLink

objectStorageLink

objectStorageLinkの説明は次の通りです。

フィールド タイプ 必須の有無 説明
bucketName String Required Object Storageのバケット名
eventRuleName String Required Object Storageのイベントルール名

SourceCommitトリガー

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

参考

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

フィールド タイプ 必須の有無 説明
sourceCommitLink Array Required 関連付ける SourceCommitリポジトリの Webフック情報: sourceCommitLink

sourceCommitLink

sourceCommitLinkの説明は次の通りです。

フィールド タイプ 必須の有無 説明
enable Boolean Optional SourceCommit Webフックを有効化するかどうか
  • true (デフォルト) | false
repositoryName String Required SourceCommitリポジトリ名
webhookName String Required SourceCommit Webフック名

Secret Managerトリガー

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

参考
  • Secret Managerトリガーは韓国リージョンの VPCプラットフォームでのみサポートしています。
  • 1つのトリガーには複数のシークレットを関連付けることができますが、1つのシークレットには1つのトリガーのみ関連付けることができます。
フィールド タイプ 必須の有無 説明
secretManagerLink Array Required 関連付ける Secret Managerのシークレット情報: secretManagerLink

secretManagerLink

secretManagerLinkの説明は次の通りです。

フィールド タイプ 必須の有無 説明
secretName String Required Secret Managerのシークレット名

リクエスト例

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

curl --location --request PUT 'https://cloudfunctions.apigw.ntruss.com/ncf/api/v2/triggers/trigger001?platform=vpc&type=cron' \
--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 '{
    "description": "Cron Trigger",
    "parameters": {
        "period": "daily"
    },
    "cronOption": "30 1 * * *"
}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

共通

共通レスポンスボディの説明は次の通りです。

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

cronトリガー

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

フィールド タイプ 必須の有無 説明
content.cronOption String - Cron実行オプション

GitHubトリガー

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

フィールド タイプ 必須の有無 説明
content.credential Object - GitHub情報
content.credential.username String - GitHubユーザー名
content.credential.accessToken String - GitHubアクセストークン
content.namespace String - GitHubネームスペース
content.credential.repository String - GitHubリポジトリ
content.events String[] - トリガーするイベントの種類

Cloud Insightトリガー

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

フィールド タイプ 必須の有無 説明
content.insightLink Array - 関連付けられた Cloud Insightイベントルール情報: insightLink

insightLink

insightLinkの説明は次の通りです。

フィールド タイプ 必須の有無 説明
prodKey String - Cloud Insightイベントルールの prodKey
ruleGrpId String - Cloud Insightイベントの ruleGrpId
reminderTime Integer - Cloud Insightイベントのリマインダー周期(分)
enableNotiWhenEventClose Boolean - イベント終了時に Cloud Insightイベントルールを呼び出すかどうか

Object Storageトリガー

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

フィールド タイプ 必須の有無 説明
content.objectStorageLink Array - 関連付けられた Object Storageイベントルール情報: objectStorageLink

objectStorageLink

objectStorageLinkの説明は次の通りです。

フィールド タイプ 必須の有無 説明
bucketName String - Object Storageのバケット名
eventRuleName String - Object Storageのイベントルール名

SourceCommitトリガー

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

フィールド タイプ 必須の有無 説明
content.sourceCommitLink Array - 関連付けられた SourceCommitリポジトリの Webフック情報: sourceCommitLink

sourceCommitLink

sourceCommitLinkの説明は次の通りです。

フィールド タイプ 必須の有無 説明
enable Boolean - SourceCommit Webフックを有効化するかどうか
repositoryName String - SourceCommitリポジトリ名
webhookName String - SourceCommit Webフック名

Secret Managerトリガー

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

フィールド タイプ 必須の有無 説明
content.secretManagerLink Array - 関連付けられた Secret Managerのシークレット情報: secretManagerLink

secretManagerLink

secretManagerLinkの説明は次の通りです。

フィールド タイプ 必須の有無 説明
secretId String - Secret Managerのシークレット ID

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

Cloud Functions APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Functionsのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "content": {
        "description": "",
        "name": "trigger001",
        "namespace": "****YBNz****",
        "parameters": {
            "period": "daily"
        },
        "resourceId": "4ci**",
        "rules": {
            "****YBNz****/qr98**: {
                "action": {
                    "name": "action001",
                    "path": "****YBNz****"
                },
                "status": "active"
        },
        "triggerType": "cron"
    }
}
事業者登録番号: 129-86-31394 通信販売業申告番号:第2009-京畿城南-0510号
代表取締役: キム・ユウォン アドレス: 13561 京畿道 城南市 盆唐区 仏亭路6 グリーンファクトリー, 17~26F お客様センターの代表電話: 1544-5876
© NAVER Cloud Corp. All Rights Reserved.