Get Action
    • PDF

    Get Action

    • PDF

    記事の要約

    class="platform-info type-classic/vpc">Classic/VPC環境で利用できます。

    Cloud Functionsアクションを照会します。

    リクエスト

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

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

    リクエストヘッダ

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

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

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

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

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

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

    フィールドタイプ必須の有無説明
    platformStringOptionalプラットフォームタイプ
    • 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-optionsBooleanヘッダオプションの設定
    • ウェブアクションタイプのみサポート
    content.descriptionStringアクションの説明
    content.exec.binaryBooleanアクションコードのファイルはバイナリかどうか
    content.exec.codeStringアクションのソースコードまたは Base64-encodedコードファイルのバイナリ
    content.exec.kindString使用言語
    content.exec.mainString実行関数
    content.limits.memoryIntegerアクションコンテナに割り当てられるメモリ容量
    content.limits.timeoutIntegerアクションが実行可能な最大時間
    content.nameStringアクション名
    content.parametersObjectアクションの基本パラメータ
    content.vpcObjectVPC情報
    • platformvpcの場合にのみ表示
    content.vpc.vpcNoInteger接続された VPC番号
    content.vpc.subnetNoInteger接続された Subnet番号
    content.pathStringアクションのパス
    content.raw-httpBoolean未加工 HTTPの使用有無
    • ウェブアクションタイプのみサポート
    content.resourceIdStringアクションのリソース ID
    content.webBooleanウェブアクションの設定

    Sequenceアクション

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

    フィールドタイプ説明
    content.descriptionStringアクションの説明
    content.exec.componentsString[]関連付けられているアクションリスト
    content.exec.kindStringアクションの種類
    • sequence(固定値)
    content.nameStringアクション名
    content.pathStringアクションのパス
    content.resourceIdStringアクションのリソース ID
    content.webBooleanウェブアクションの設定

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

    レスポンスステータスコードの説明は次の通りです。

    HTTPステータスコードコードメッセージ説明
    40080302ACTION_PLATFORM_MISMATCH正しくないプラットフォームパラメータ
    40380002SUB_ACC_NO_PERMISSIONリソース照会権限エラー
    40480301ACTION_NOT_FOUNDアクションが見つからない

    レスポンス例

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

    {
        "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": "****YBNzcd4Z/package003",
            "raw-http": false,
            "resourceId": "Sy***",
            "web": false
        }
    }
    

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

    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.