リクエスト

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

メソッド	URI
GET	/packages/{packageName}/actions/{actionName}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`packageName`	String	Required	パッケージ名パッケージに属さないアクションの場合、記号の「-」を入力 <例> `/packages/-/actions/myaction`
`actionName`	String	Required	アクション名

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

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

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

リクエスト例

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

curl --location --request GET 'https://cloudfunctions.apigw.ntruss.com/api/v2/packages/package003/actions?platform=classic' \
--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}'

レスポンス

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

レスポンスボディ

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

Basicアクション

Basicアクションのレスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`content.custom-options`	Boolean	-	ヘッダオプションの設定ウェブアクションのみサポート
`content.description`	String	-	アクションの説明
`content.exec.binary`	Boolean	-	アクションコードのファイルはバイナリかどうか
`content.exec.code`	String	-	アクションのソースコードまたは Base64-encodedコードファイルのバイナリ
`content.exec.kind`	String	-	使用言語
`content.exec.main`	String	-	実行関数
`content.limits.memory`	Integer	-	アクションコンテナに割り当てられるメモリ容量
`content.limits.timeout`	Integer	-	アクションが実行可能な最大時間
`content.name`	String	-	アクション名
`content.parameters`	Object	-	アクションの基本パラメータ
`content.vpc`	Object	-	VPC情報 `platform`が`vpc`の場合にのみ表示
`content.vpc.vpcNo`	Integer	-	接続された VPC番号
`content.vpc.subnetNo`	Integer	-	接続された Subnet番号
`content.path`	String	-	アクションのパス
`content.raw-http`	Boolean	-	未加工 HTTPの使用有無ウェブアクションのみサポート
`content.resourceId`	String	-	アクションのリソース ID
`content.web`	Boolean	-	ウェブアクションの設定

Sequenceアクション

Sequenceアクションのレスポンスボディの説明は次の通りです。

フィールド	タイプ	説明
`content.description`	String	アクションの説明
`content.exec.components`	Object[]	関連付けられているアクションリスト
`content.exec.kind`	String	アクションの種類 `sequence`(固定値)
`content.name`	String	アクション名
`content.path`	String	アクションのパス
`content.resourceId`	String	アクションのリソース ID
`content.web`	Boolean	ウェブアクションの設定

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

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

レスポンス例

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

{
    "content": {
        "custom-options": false,
        "description": "Create Action",
        "exec": {
            "binary": false,
            "code": "function main(params) { \nlet name = params.name || \"World\";\nlet place = params.place || \"Naver\"; \n  return {payload:  \"abc\"};\n}",
            "kind": "nodejs:16",
            "main": "main"
        },
        "limits": {
            "memory": 128,
            "timeout": 60000
        },
        "name": "action000",
        "parameters": {
            "name": "action000"
        },
        "path": "****YBNz****/package003",
        "raw-http": false,
        "resourceId": "Sy***",
        "web": false
    }
}

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

リクエスト
レスポンス

タグ

Cloud Functions