getList

VPC環境で利用できます。

Data Forestアカウントのすべてのアプリリストを照会します。

リクエスト

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

リクエストヘッダ

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

リクエストボディ

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

リクエスト例

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

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/getList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "search": {
        "accountId": "***FQJ88q0be79VRB2e***"
    }
}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "success": true,
    "total": 1,
    "contents": [
         {
            "id": "***ziexhg0FcWx5eGUA***",
            "name": "app001",
            "state": "RUNNING",
            "queueName": "longlived",
            "accountId": "***FQJ88q0be79VRB2e***",
            "accountName": "df001",
            "startedAt": "2025-02-25T15:49:07+09:00",
            "lifetimeMillis": 604800,
            "disabled": false
        }
    ]
}