Get Trigger

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

Cloud Functionsトリガーを照会します。

リクエスト

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

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

参考

シンガポールリージョンと日本リージョンは、VPC環境でのみ利用できます。

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`triggerName`	String	Required	トリガー名

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

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

フィールド	タイプ	必須の有無	説明
`platform`	String	Optional	プラットフォーム区分 `vpc`(デフォルト) \| `classic`

リクエスト例

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

curl -X GET 'https://cloudfunctions.apigw.ntruss.com/ncf/api/v2/triggers/{triggerName}?platform=vpc' \
--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}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`content`	Object	-	トリガー情報
`content.actions`	Array	-	トリガーに関連付けられたアクションリスト
`content.description`	String	-	トリガーの説明
`content.execOption`	Array	-	トリガータイプ別実行オプション: execOption
`content.name`	String	-	トリガー名
`content.resourceId`	String	-	トリガーのリソース ID
`content.type`	String	-	トリガーのタイプ

`execOption`

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

フィールド	タイプ	必須の有無	説明
`key`	String	-	トリガーの種類
`value`	Integer	-	トリガー実行条件

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

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

レスポンス例

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

{
    "content": {
        "actions": [
            "myaction"
        ],
        "description": "My GitHub trigger",
        "execOption": [
            {
                "key": "events",
                "value": "*"
            }
        ],
        "name": "my_github_trigger",
        "resourceId": "NSRoF",
        "type": "github"
    }
}