Login
      目次 x
      Put Trigger
        • 印刷する
        • PDF
        目次

        Put Trigger

          • 印刷する
          • PDF
          記事の要約

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

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

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

          リクエスト

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

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

          リクエストヘッダ

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

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

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

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

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

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

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

          リクエストボディ

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

          Basicトリガー

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

          フィールドタイプ必須の有無説明
          triggerObjectRequiredトリガー情報
          trigger.descriptionStringOptionalトリガーの説明(Byte)
          • 0~3,000
          trigger.parametersObjectOptionalトリガーの基本パラメータ
          • {"key": "value"}形式の JSON
          • トリガー実行時、パラメータ適用の優先順位
            • 1番目: 実行時に渡されるランタイムパラメータ
            • 2番目: 関連付けられているトリガーの基本パラメータ
            • 3番目: アクションの基本パラメータ
            • 4番目: 含まれているパッケージの基本パラメータ
          linkObjectConditionalAPI Gateway情報
          • トリガー作成時にのみ有効で、必ず入力
          link.productIdStringConditionalAPI Gatewayの商品 ID
          link.apiNameStringConditionalAPI Gatewayの API名
          link.stageNameStringConditionalAPI Gatewayのステージ名
          link.authenticationStringOptionalAPI Gatewayの認証方法
          • NONE(デフォルト) | IAM

          cronトリガー

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

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

          GitHubトリガー

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

          フィールドタイプ必須の有無説明
          triggerObjectRequiredトリガー情報
          trigger.descriptionStringOptionalトリガーの説明
          • 0~3,000 bytes
          trigger.parametersObjectOptionalトリガーの基本パラメータ
          • {"key": "value"}形式の JSON
          • トリガー実行時、パラメータ適用の優先順位
            • 1番目: 実行時に渡されるランタイムパラメータ
            • 2番目: 関連付けられているトリガーの基本パラメータ
            • 3番目: アクションの基本パラメータ
            • 4番目: 含まれているパッケージの基本パラメータ
          trigger.credentials.usernameStringRequiredGitHubユーザー名
          trigger.credentials.accessTokenStringRequiredGitHubアクセストークン
          trigger.credentials.repositoryStringRequiredGitHubリポジトリ
          • リポジトリ名またはOrganization/リポジトリ名形式で入力
          trigger.eventsArrayRequiredトリガーするイベント
          • * | 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
          linkObjectConditionalAPI Gateway情報
          • トリガー作成時にのみ有効で、必ず入力
          link.productIdStringConditionalAPI Gatewayの商品 ID
          link.apiNameStringConditionalAPI Gateway API名
          link.stageNameStringConditionalAPI Gatewayのステージ名

          Cloud Insightトリガー

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

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

          Cloud IoT Coreトリガー

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

          フィールドタイプ必須の有無説明
          triggerObjectRequiredトリガー情報
          trigger.descriptionStringOptionalトリガーの説明(Byte)
          • 0~3,000
          trigger.parametersObjectOptionalトリガーの基本パラメータ
          • {"key": "value"}形式の JSON
          • トリガー実行時、パラメータ適用の優先順位
            • 1番目: 実行時に渡されるランタイムパラメータ
            • 2番目: 関連付けられているトリガーの基本パラメータ
            • 3番目: アクションの基本パラメータ
            • 4番目: 含まれているパッケージの基本パラメータ
          trigger.iotLinkObject[]RequiredCloud IoT Core情報
          trigger.iotLink[].ruleNameStringRequiredCloud IoT Coreルールの名前

          Object Storageトリガー

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

          注意

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

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

          Source Commitトリガー

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

          参考

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

          フィールドタイプ必須の有無説明
          triggerObjectRequiredトリガー情報
          trigger.descriptionStringOptionalトリガーの説明(Byte)
          • 0~3,000
          trigger.parametersObjectOptionalトリガーの基本パラメータ
          • {"key": "value"}形式の JSON
          • トリガー実行時、パラメータ適用の優先順位
            • 1番目: 実行時に渡されるランタイムパラメータ
            • 2番目: 関連付けられているトリガーの基本パラメータ
            • 3番目: アクションの基本パラメータ
            • 4番目: 含まれているパッケージの基本パラメータ
          trigger.sourceCommitLinkObject[]RequiredSourceCommit情報
          trigger.sourceCommitLink[].enableBooleanOptionalSourceCommit Webフックを有効化するかどうか
          • true(デフォルト) | false
            trigger.sourceCommitLink[].repositoryNameStringRequiredSourceCommitリポジトリ名
            trigger.sourceCommitLink[].webhookNameStringRequiredSourceCommit 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": {

        }
    }
}

            レスポンス

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

            レスポンスボディ

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

            Basicトリガー

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

            フィールドタイプ説明
            content.nameStringトリガー名
            content.namespaceStringユーザーのネームスペース
            content.descriptionStringトリガーの説明
            content.triggerTypeStringトリガータイプ
            content.resourceIdStringトリガーのリソース ID
            content.parametersObjectトリガーの基本パラメータ
            content.rulesStringトリガーとアクションの関連付け情報

            Cronトリガー

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

            フィールドタイプ説明
            content.cronOptionsStringトリガー cronの実行オプション
            content.descriptionStringトリガーの説明
            content.nameStringトリガー名
            content.namespaceStringユーザーのネームスペース
            content.parametersObjectトリガーの基本パラメータ
            content.resourceIdStringトリガーのリソース ID
            content.rulesStringトリガーとアクションの関連付け情報
            content.triggerTypeStringトリガータイプ

            GitHubトリガー

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

            フィールドタイプ説明
            content.credentialsObjectトリガー GitHubの連携情報
            content.descriptionStringトリガーの説明
            content.eventsStringトリガーの実行 GitHubイベントオプション
            content.nameStringトリガー名
            content.namespaceStringユーザーのネームスペース
            content.parametersObjectトリガーの基本パラメータ
            content.resourceIdString-
            content.rulesStringトリガーとアクションの関連付け情報
            link.stageNameStringトリガータイプ

            Cloud Insightトリガー

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

            フィールドタイプ説明
            content.descriptionStringトリガーの説明
            content.nameStringトリガー名
            content.namespaceStringユーザーのネームスペース
            content.parametersObjectトリガーの基本パラメータ
            content.insightLinkObject[]関連付けられた Cloud Insightイベントルール情報
            content.insightLink[].prodKeyStringCloud Insightイベントルールの prodKey
            content.insightLink[].ruleGrpIdStringCloud Insightイベントルールの groupId
            content.insightLink[].reminderTimeIntegerCloud Insightイベントルールのリマインダー周期(分)
            content.insightLink[].enableNotiWhenEventCloseBooleanイベント終了時、Cloud Insightイベントルールを呼び出すかどうか
            content.resourceIdString-
            content.rulesString-
            content.triggerTypeString-

            Cloud IoT Coreトリガー

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

            フィールドタイプ説明
            content.descriptionStringトリガーの説明
            content.nameStringトリガー名
            content.namespaceStringユーザーのネームスペース
            content.parametersObjectトリガーの基本パラメータ
            content.iotLinkObject[]関連付けられた Cloud IoT Coreルール情報
            content.iotLink[].ruleNameStringCloud IoT Coreルールの名前
            content.resourceIdStringトリガーのリソース ID
            content.rulesStringトリガーとアクションの関連付け情報
            content.triggerTypeStringトリガータイプ

            Object Storageトリガー

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

            フィールドタイプ説明
            content.descriptionStringトリガーの説明
            content.nameStringトリガー名
            content.namespaceStringユーザーのネームスペース
            content.parametersObjectトリガーの基本パラメータ
            content.objectStorageLinkObject[]関連付けられた Object Storageイベントルール情報
            content.objectStorageLink[].bucketNameStringObject Storageイベントルールのバケット名
            content.objectStorageLink[].eventRuleNameStringObject Storageのイベントルール名
            content.resourceIdStringトリガーのリソース ID
            content.rulesStringトリガーとアクションの関連付け情報
            content.triggerTypeStringトリガータイプ

            Source Commitトリガー

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

            フィールドタイプ説明
            content.descriptionStringトリガーの説明
            content.nameStringトリガー名
            content.namespaceStringユーザーのネームスペース
            content.parametersObjectトリガーの基本パラメータ
            content.sourceCommitLinkObject[]関連付けられた Source Commitのリポジトリ情報
            content.sourceCommitLink[].enableBooleanSource Commit Webフックを有効化するかどうか
            content.sourceCommitLink[].repositoryNameStringSource Commitリポジトリ名
            content.sourceCommitLink[].webhookNameStringSource Commit Webフック名
            content.resourceIdStringトリガーのリソース ID
            content.rulesStringトリガーとアクションの関連付け情報
            content.triggerTypeStringトリガータイプ

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

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

            レスポンス例

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

            {
    "content": {
        "cronOption": "0 10 * * *",
        "description": "cron Trigger",
        "limits": {},
        "name": "trigger002",
        "namespace": "****YBNz****",
        "parameters": {},
        "resourceId": "Nu3**",
        "rules": {},
        "triggerType": "Cron"
    }
}
            この記事は役に立ちましたか?
            What's Next
            Change password!
            Changing your password will log you out immediately. Use the new password to log back in.
            Change profile
            Success!
            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.
            Logout