リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	制限事項	説明
accountId	YES	String	最大22文字まで入力	- アカウント識別子の UUID(base62) - accountIdは AccountsのgetList APIを通じて取得可能
queueName	YES	String	- 最大60文字まで入力 - longlivedのみ使用可能	- YARNキューの名前 - デフォルト: longlived
appTypeId	YES	String	最大60文字まで入力	- Data Forestアプリタイプとアプリバージョン - 例: DEV-1.0.0 - appTypeIdはgetAppTypeIdList APIを通じて取得可能
name	YES	String	3~15文字以内で入力	アプリの名前
lifetime	YES	Integer	300(秒) ~ 604800(秒)、-1(infinite)	アプリの lifetime(稼働時間)(単位: 秒)
description	NO	String	最大2048文字まで入力	アプリの説明
dependentIds	NO	List<String>		アプリ作成に必要な依存アプリの IDリスト
components	YES	AppComponentRequest		- AppComponentRequestデータタイプ - Data Forestアプリを構成するコンポーネント - コンポーネント情報はgetAppBasicSetting APIを実行して取得可能

リクエストヘッダ

共通ガイドを参照

リクエストボディ

JSON

{
    "components": [
        {
        "containerCount": 0,
        "cpuCount": 0,
        "memoryMb": 0,
        "name": "string"
        }
    ],
    "accountId": "string",
    "appTypeId": "string",
    "dependentIds": [
        "string"
    ],
    "description": "string",
    "lifetime": 0,
    "name": "string",
    "queueName": "longlived"
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<CreateAppRequest>
    <components>
        <containerCount>0</containerCount>
        <cpuCount>0</cpuCount>
        <memoryMb>0</memoryMb>
        <name>string</name>
    </components>
    <accountId>string</accountId>
    <appTypeId>string</appTypeId>
    <dependentIds>string</dependentIds>
    <description>string</description>
    <lifetime>0</lifetime>
    <name>string</name>
    <queueName>longlived</queueName>
</CreateAppRequest>

レスポンス

レスポンスボディ

CreateAppRequest

JSON

{
"id": "string",
"message": "string",
"success": true
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<CreateAppResponse>
    <id>string</id>
    <message>string</message>
    <success>true</success>
</CreateAppResponse>

エラーコード

Data Forestの概要を参照

例

リクエスト例

HTTP

POST https://df.apigw.ntruss.com/api/v2/apps/create
HOST: df.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
"accountId": "0EUndFjwPUpehRdMm4X4Vj",
"queueName": "longlived",
"appTypeId": "DEV-1.0.0",
"name": "dev24x7",
"lifetime": 604800,
"description": "string",
"dependentIds": [
    "8xaHHIwgJG1cSNkIeDrr8D"
],
"components": [
    {
    "name": "shell",
    "memoryMb": 2048,
    "cpuCount": 1,
    "containerCount": 1
    }
]
}

BASH

curl -X POST "https://df.apigw.ntruss.com/api/v2/apps/create" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-apigw-timestamp:1505290625682" \
-H "x-ncp-iam-access-key:D78BB444D6D3C84CA38A" \
-H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo="
-d '{
"accountId": "0EUndFjwPUpehRdMm4X4Vj",
"queueName": "longlived",
"appTypeId": "DEV-1.0.0",
"name": "dev24x7",
"lifetime": 604800,
"description": "string",
"dependentIds": [
    "8xaHHIwgJG1cSNkIeDrr8D"
],
"components": [
    {
    "name": "shell",
    "memoryMb": 2048,
    "cpuCount": 1,
    "containerCount": 1
    }
]
}'

レスポンス例

HTTP
HTTP Status Description
200 OK

HTTP Status	Description
200	OK

BASH

{
"success": true,
"message": "success",
"id": "VmYi7mOFyhNe107T2p9vDi"
}

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

リクエスト
レスポンス
- レスポンスボディ
エラーコード
例
- リクエスト例
- レスポンス例

タグ

Data Forest