Put Trigger
    • PDF

    Put Trigger

    • PDF

    Article Summary

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

    概要

    トリガーを作成および修正します。

    リクエスト

    リクエスト URL

    PUT {CLOUD_FUNCTIONS_API_URL}/triggers/{triggerName}
    
    Content-Type: application/json; charset=utf-8
    x-ncp-apigw-timestamp: {Timestamp}
    x-ncp-iam-access-key: {Sub Account Access Key}
    x-ncp-apigw-signature-v2: {API Gateway Signature}
    

    Path Variables

    パラメータ要否タイプ制約事項説明
    triggerNameYesstringアルファベット、数字、ハイフン(-)、アンダーバ( _ )で構成し、50文字以内のみ許可トリガー名

    リクエストパラメータ

    パラメータ名要否タイプ制約事項説明
    platformNostring(classic | vpc)- プラットフォームタイプ
    - default classicで処理
    typeNostring(basic | cron | github | insight | iot | object_storage | source_commit)- トリガータイプ
    - default basicで処理

    リクエストボディ

    リクエストボディはトリガータイプに応じて確認してください。

    Basic Trigger

    {
      "trigger": {
          "description": "string",
          "parameters": {
    
          }
      },
        "link": {
            "productId": "string",
            "apiName": "string",
            "stageName": "string"
        }
    }
    
    項目要否タイプ制約事項説明
    triggerYesobjectトリガー情報
    trigger.descriptionNostring3000byte以内の文字列トリガー説明
    trigger.parametersNoobjectJSON形式。{"key" : "value"}の形式トリガーのデフォルトパラメータ設定
    * アクション実行時のパラメータ適用優先順位
    ** 1順位: 実行時点で伝達されるランタイムパラメータ
    ** 2順位: 接続されたトリガーのデフォルトパラメータ
    ** 3順位: アクションのデフォルトパラメータ
    ** 4順位: 含まれるパッケージのデフォルトパラメータ
    linkNo-linkはトリガー作成時にのみ有効
    修正時には適用されない
    link.productIdYesstring外部接続アドレスを作成するための API Gatewayの productId
    link.apiNameYesstring外部接続アドレスを作成するための API Gatewayの apiName
    link.stageNameYesstring外部接続アドレスを作成するための API Gatewayの stageName

    Cron Trigger

    {
        "trigger": {
            "description": "string",
            "cronOption": "string",
            "parameters": {
    
            }
        }
    }
    
    項目要否タイプ制約事項説明
    triggerYesobjectトリガー情報
    trigger.descriptionNostring3000byte以内の文字列トリガー説明
    trigger.cronOptionYesstringcron expressioncron実行オプション
    trigger.parametersNoobjectJSON形式。{"key" : "value"}の形式トリガーのデフォルトパラメータ設定
    * アクション実行時のパラメータ適用優先順位
    ** 1順位: 実行時点で伝達されるランタイムパラメータ
    ** 2順位: 接続されたトリガーのデフォルトパラメータ
    ** 3順位: アクションのデフォルトパラメータ
    ** 4順位: 含まれるパッケージのデフォルトパラメータ

    GitHub Trigger

    {
        "trigger": {
            "parameters": {
    
            },
            "description": "string",
            "credentials": {
                "username": "string",
                "accessToken": "string",
                "repository": "string"
            },
            "events": [
                "string"
            ]
        },
        "link": {
        	"productId" : "string",
        	"apiName" : "string",
        	"stageName" : "string"
        }
    }
    
    項目要否タイプ制約事項説明
    triggerYesobjectトリガー情報
    trigger.descriptionNostring3000byte以内の文字列トリガー説明
    trigger.parametersNoobjectJSON形式。{"key" : "value"}の形式トリガーのデフォルトパラメータ設定
    * アクション実行時のパラメータ適用優先順位
    ** 1順位: 実行時点で伝達されるランタイムパラメータ
    ** 2順位: 接続されたトリガーのデフォルトパラメータ
    ** 3順位: アクションのデフォルトパラメータ
    ** 4順位: 含まれるパッケージのデフォルトパラメータ
    trigger.credentials.usernameYesstringGithubユーザー名
    trigger.credentials.accessTokenYesstringGithubアクセストークン
    trigger.credentials.repositoryYesstringURL形式ではなく「レファジトリ名」あるいは「Organization/レファジトリ名」形式で作成が必要Githubレファジトリ
    trigger.eventsYesstring arrayイベントの種類で "*", "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", "release", "secret_scanning_alert_location", "secret_scanning_alert", "security_and_analysis", "star", "workflow_job", "workflow_run" の中から複数選択可能トリガーするイベントリスト
    linkNolinkデータはトリガー作成時にのみ有効。修正時には適用されない
    link.productIdYesstring外部接続アドレスを作成するための API Gatewayの productId
    link.apiNameYesstring外部接続アドレスを作成するための API Gatewayの apiName
    link.stageNameYesstring外部接続アドレスを作成するための API Gatewayの stageName

    Cloud Insight Trigger

    {
        "trigger" : {
              "description" : "string",
              "parameters" : {
    
              },
              "insightLink" : [
                    {
                        "prodKey" : "string",
                        "ruleGrpId" : "string",
                        "reminderTime" : "integer",
                        "enableNotiWhenEventClose" : "boolean"
                    }
              ]
        }
    }
    
    項目要否タイプ制約事項説明
    triggerYesobjectトリガー情報
    trigger.descriptionNostring3000byte以内の文字列トリガー説明
    trigger.parametersNoobjectJSON形式。{"key" : "value"}の形式トリガーのデフォルトパラメータ設定
    * アクション実行時のパラメータ適用優先順位
    ** 1順位: 実行時点で伝達されるランタイムパラメータ
    ** 2順位: 接続されたトリガーのデフォルトパラメータ
    ** 3順位: アクションのデフォルトパラメータ
    ** 4順位: 含まれるパッケージのデフォルトパラメータ
    trigger.insightLinkYes
    trigger.insightLink[].prodKeyYesstringInsight Triggerに接続する Cloud Insight Event Ruleの prodKey
    trigger.insightLink[].ruleGrpIdYesstringInsight Triggerに接続する Cloud Insight Event Ruleの ruleGrpId
    trigger.insightLink[].reminderTimeNointegerMIN 5 / MAX 720Insight Triggerに接続する Cloud Insight Event Ruleのリマインド通知周期(分単位)
    trigger.insightLink[].enableNotiWhenEventCloseNobooleanInsight Triggerに接続する Cloud Insight Event Ruleを Event終了時にも呼び出すかどうか / default false

    Cloud IoT Core Trigger

    {
        "trigger" : {
              "description" : "string",
              "parameters" : {
    
              },
              "iotLink" : [
                    {
                      "ruleName" : "string"
                    }
              ]
        }
    }
    
    項目要否タイプ制約事項説明
    triggerYesobjectトリガー情報
    trigger.descriptionNostring3000byte以内の文字列トリガー説明
    trigger.parametersNoobjectJSON形式。{"key" : "value"}の形式トリガーのデフォルトパラメータ設定
    * アクション実行時のパラメータ適用優先順位
    ** 1順位: 実行時点で伝達されるランタイムパラメータ
    ** 2順位: 接続されたトリガーのデフォルトパラメータ
    ** 3順位: アクションのデフォルトパラメータ
    ** 4順位: 含まれるパッケージのデフォルトパラメータ
    trigger.iotLinkYes
    trigger.iotLink[].ruleNameYesstringCloud IoT Core Triggerに接続する Cloud IoT Core規則の名前

    Object Storage Trigger

    注意

    Object Storage Triggerに接続されたアクションが Object Storage Event Ruleと同じ Bucketを使用する場合、再帰呼び出しによる使用量の増加および過剰な請求が発生する可能性があります。

    {
        "trigger" : {
              "description" : "string",
              "parameters" : {
    
              },
              "objectStorageLink" : [
                    {
                      "bucketName" : "string",
                      "eventRuleName" : "string"
                    }
              ]
        }
    }
    
    項目要否タイプ制約事項説明
    triggerYesobjectトリガー情報
    trigger.descriptionNostring3000byte以内の文字列トリガー説明
    trigger.parametersNoobjectJSON形式。{"key" : "value"}の形式トリガーのデフォルトパラメータ設定
    * アクション実行時のパラメータ適用優先順位
    ** 1順位: 実行時点で伝達されるランタイムパラメータ
    ** 2順位: 接続されたトリガーのデフォルトパラメータ
    ** 3順位: アクションのデフォルトパラメータ
    ** 4順位: 含まれるパッケージのデフォルトパラメータ
    trigger.objectStorageLinkYes
    trigger.objectStorageLink[].bucketNameYesstringObject Storage Triggerに接続する Object Storageの Bucket名
    trigger.objectStorageLink[].eventRuleNameYesstringObject Storage Triggerに接続する Object Storageの Event Rule名

    Source Commit Trigger

    参考
    • SourceCommitタイプトリガーは韓国リージョン、VPCプラットフォームのみサポートします。
    {
        "trigger" : {
              "description" : "string",
              "parameters" : {
    
              },
              "sourceCommitLink" : [
                    {
                      "enable": "boolean",
                      "repositoryName" : "string",
                      "webhookName" : "string"
                    }
              ]
        }
    }
    
    項目要否タイプ制約事項説明
    triggerYesobjectトリガー情報
    trigger.descriptionNostring3000byte以内の文字列トリガー説明
    trigger.parametersNoobjectJSON形式。{"key" : "value"}の形式トリガーのデフォルトパラメータ設定
    * アクション実行時のパラメータ適用優先順位
    ** 1順位: 実行時点で伝達されるランタイムパラメータ
    ** 2順位: 接続されたトリガーのデフォルトパラメータ
    ** 3順位: アクションのデフォルトパラメータ
    ** 4順位: 含まれるパッケージのデフォルトパラメータ
    trigger.sourceCommitLinkYes
    trigger.sourceCommitLink[].enableNoboolean- Source Commit Triggerに接続する Source Commit Repositoryの Webhook活性化ステータス指定
    - default true
    trigger.sourceCommitLink[].repositoryNameYesstringSource Commit Triggerに接続する Source Commit Repository名
    trigger.sourceCommitLink[].webhookNameYesstringSource Commit Triggerに接続する Source Commit Repositoryの Webhook名

    レスポンス

    レスポンスボディ

    Basic Trigger

    {
        "content": {
            "name": "string",
            "namespace": "string",
            "description": "string",
            "limits": {},
            "parameters": {
    
            },
            "resourceId": "string",
            "rules": {},
            "triggerType": "string"
        }
    }
    
    項目タイプ説明備考
    content.namestringトリガー名
    content.namespacestring使用者のネームスペース
    content.descriptionstringトリガー説明
    content.triggerTypestringトリガータイプ
    content.resourceIdstringトリガーの resourceId
    content.parametersobjectトリガーのデフォルトパラメータ
    content.limits使用しない
    content.rulesstringトリガーアクション接続情報

    Cron Trigger

    {
        "content": {
            "cronOption": "string",
            "description": "string",
            "limits": {},
            "name": "string",
            "namespace": "string",
            "parameters": {
    
            },
            "resourceId": "string",
            "rules": {},
            "triggerType": "string"
        }
    }
    
    項目タイプ説明備考
    content.descriptionstringトリガー説明
    content.triggerTypestringトリガータイプ
    content.resourceIdstringトリガーの resourceId
    content.cronOptionsstringトリガーの Cron実行オプション
    content.limits使用しない
    content.namestringトリガー名
    content.namespacestring使用者のネームスペース
    content.parametersobjectトリガーのデフォルトパラメータ
    content.rulesstringトリガーアクション接続情報

    GitHub Trigger

    {
        "content": {
            "credentials": {
                "accessToken": "string",
                "repository": "string",
                "username": "string"
            },
            "description": "string",
            "events": "string",
            "limits": {},
            "name": "string",
            "namespace": "string",
            "parameters": {
    
            },
            "resourceId": "string",
            "rules": {},
            "triggerType": "string"
        }
    }
    
    項目タイプ説明備考
    content.credentialsトリガー github接続情報
    content.descriptionstringトリガー説明
    content.eventsstringトリガーの実行 github eventオプション
    content.limits使用しない
    content.namestringトリガー名
    content.namespacestring使用者のネームスペース
    content.parametersobjectトリガーのデフォルトパラメータ
    content.resourceIdstringトリガーの resourceId
    content.rulesstringトリガーアクション接続情報
    content.triggerTypestringトリガータイプ

    Cloud Insight Trigger

    {
        "content" : {
              "description" : "string",
              "limits": {},
              "name": "string",
              "namespace": "string",
              "parameters" : {
    
              },
              "insightLink" : [
                    {
                        "prodKey" : "string",
                        "ruleGrpId" : "string",
                        "reminderTime" : "integer",
                        "enableNotiWhenEventClose" : "boolean"
                    }
              ],
              "resourceId": "string",
              "rules": {},
              "triggerType": "string"
        }
    }
    
    項目タイプ説明備考
    content.descriptionstringトリガー説明
    content.limits使用しない
    content.namestringトリガー名
    content.namespacestring使用者のネームスペース
    content.parametersobjectトリガーのデフォルトパラメータ
    content.insightLink接続された Cloud Insightの Event Rule情報
    content.insightLink[].prodKeystring接続された Cloud Insight Event Ruleの prodKey
    content.insightLink[].ruleGrpIdstring接続された Cloud Insight Event Ruleの groupId
    content.insightLink[].reminderTimeinteger接続された Cloud Insight Event Ruleのリマインド通知周期(分単位)
    content.insightLink[].enableNotiWhenEventCloseboolean接続された Cloud Insight Event Ruleを Event終了時にも呼び出すかどうか
    content.resourceIdstringトリガーの resourceId
    content.rulesstringトリガーアクション接続情報
    content.triggerTypestringトリガータイプ

    Cloud IoT Core Trigger

    {
        "content" : {
              "description" : "string",
              "limits": {},
              "name": "string",
              "namespace": "string",
              "parameters" : {
    
              },
              "iotLink" : [
                    {
                        "ruleName" : "string"
                    }
              ],
              "resourceId": "string",
              "rules": {},
              "triggerType": "string"
        }
    }
    
    項目タイプ説明備考
    content.descriptionstringトリガー説明
    content.limits使用しない
    content.namestringトリガー名
    content.namespacestring使用者のネームスペース
    content.parametersobjectトリガーのデフォルトパラメータ
    content.iotLink接続された Cloud IoT Core規則情報
    content.iotLink[].ruleNamestring接続された Cloud IoT Core規則の名前
    content.resourceIdstringトリガーの resourceId
    content.rulesstringトリガーアクション接続情報
    content.triggerTypestringトリガータイプ

    Object Storage Trigger

    {
        "content" : {
              "description" : "string",
              "limits": {},
              "name": "string",
              "namespace": "string",
              "parameters" : {
    
              },
              "objectStorageLink" : [
                    {
                      "bucketName" : "string",
                      "eventRuleName" : "string"
                    }
              ],
              "resourceId": "string",
              "rules": {},
              "triggerType": "string"
        }
    }
    
    項目タイプ説明備考
    content.descriptionstringトリガー説明
    content.limits使用しない
    content.namestringトリガー名
    content.namespacestring使用者のネームスペース
    content.parametersobjectトリガーのデフォルトパラメータ
    content.objectStorageLink接続された Object Storage Event Ruleの情報
    content.objectStorageLink[].bucketNamestring接続された Object Storage Event Ruleの Bucket名前
    content.objectStorageLink[].eventRuleNamestring接続された Object Storage Event Ruleの名前
    content.resourceIdstringトリガーの resourceId
    content.rulesstringトリガーアクション接続情報
    content.triggerTypestringトリガータイプ

    Source Commit Trigger

    {
        "content" : {
              "description" : "string",
              "limits": {},
              "name": "string",
              "namespace": "string",
              "parameters" : {
    
              },
              "sourceCommitLink" : [
                    {
                      "enable" : "boolean",
                      "repositoryName" : "string",
                      "webhookName" : "string"
                    }
              ],
              "resourceId": "string",
              "rules": {},
              "triggerType": "string"
        }
    }
    
    項目タイプ説明備考
    content.descriptionstringトリガー説明
    content.limits使用しない
    content.namestringトリガー名
    content.namespacestring使用者のネームスペース
    content.parametersobjectトリガーのデフォルトパラメータ
    content.sourceCommitLink接続された Object Storage Event Ruleの情報
    content.sourceCommitLink[].enableboolean接続された Source Commit Repositoryの Webhook活性化ステータス
    content.sourceCommitLink[].repositoryNamestring接続された Source Commit Repository名
    content.sourceCommitLink[].webhookNamestringSource Commit Repositoryの Webhook名
    content.resourceIdstringトリガーの resourceId
    content.rulesstringトリガーアクション接続情報
    content.triggerTypestringトリガータイプ

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.