create

Prev Next

VPC環境で利用できます。

Data Forestアプリを作成します。

リクエスト

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

メソッド URI
POST /api/v2/apps/create

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
accountId String Required アカウント固有 ID
  • 0~22文字
  • UUIDを Base62に変換した形式
  • AccountsのgetListを参照
queueName String Required YARNキュー名
  • longlived (デフォルト)
  • 0~60文字
appTypeId String Required アプリのタイプとバージョン
name String Required アプリ名
  • 英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力
  • 文字列の先頭文字と末尾文字は英字の小文字または数字のみ使用
  • 記号の「-」は連続使用できない
lifetime Integer Required アプリの稼働時間(秒)
  • 300 ~ 604800、-1(永久)
description String Optional アプリの説明
  • 0~2048文字
dependentIds Array Optional アプリの作成時に必要な依存関係アプリ IDリスト
components Array Required アプリ構成コンポーネント

リクエスト例

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

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/create' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "accountId": "***FQJ88q0be79VRB2e***",
    "queueName": "longlived",
    "appTypeId": "KAFKA-2.4.0",
    "name": "kafka001",
    "lifetime": 604800,
    "description": "string",
    "dependentIds": [
        "***OMQ0QwFXb5XINOzf***"
    ],
    "components": [
        {
            "name": "broker",
            "memoryMb": 2048,
            "cpuCount": 4,
            "containerCount": 1
        },
        {
            "name": "kafka-manager",
            "memoryMb": 2048,
            "cpuCount": 1,
            "containerCount": 1
        }
    ]
}'

レスポンス

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

レスポンスボディ

レスポンスボディの詳細は、CreateAppRequestをご参照ください。

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

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

レスポンス例

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

{
    "success": true,
    "id": "***ziexhg0FcWx5eGUA***"
}