---
title: "メソッドリクエストボディの保存"
slug: "apigateway-postrequestbody"
updated: 2026-09-17T09:57:24Z
published: 2026-09-17T09:57:24Z
canonical: "api.ncloud-docs.com/apigateway-postrequestbody"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# メソッドリクエストボディの保存

Classic/VPC環境で利用できます。

ユーザー定義したメソッドにリクエストボディを追加します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| POST | /api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/request-body |

### リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、[API Gatewayのリクエストヘッダ](/docs/ja/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `product-id` | String | Required | APIが属する Product ID - 1~10文字 - [Productリストの照会](/docs/ja/apigateway-product-getproductlist)を参照 |
| `api-id` | String | Required | リクエストボディ追加対象 APIの ID - 1~10文字 - [APIの照会](/docs/ja/apigateway-api-apis)を参照 |
| `resource-id` | String | Required | APIの対象リソースの ID - 1~10文字 - [Resourceリストの照会](/docs/ja/apigateway-resource-getresourcelist)を参照 |
| `method-name` | String | Required | 対象メソッドのタイプ - `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD` |

### リクエスト構文

リクエスト構文は次の通りです。

```
{
  "bodyName" : "bodyName",
  "modelId" : "modelId",
  "bodyDescription" : "bodyDescription"
}
```

### リクエストボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `bodyName` | String | Required | 保存するリクエストボディの名前 - 0~100文字 |
| `modelId` | String | Required | 適用対象モデルの ID - 事前に作成したモデルを使用 - 利用可能なモデルは[モデルの照会](/doc/apigateway-getmodels)アクションを通じて確認 |
| `bodyDescription` | String | Optional | リクエストボディの説明 - 0~2000文字 |

### リクエスト例

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

```
curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/tf73xuex0v/methods/PATCH/request-body' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "bodyName" : "patchbody",
  "modelId" : "qw33h0i33i",
  "bodyDescription" : "api key body"
}'
```

## レスポンス

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

### レスポンス構文

レスポンス構文は次の通りです。

```
{
  "modelId" : "modelId",
  "modelName" : "modelName",
  "bodyName" : "bodyName",
  "bodyDescription" : "bodyDescription"
}
```

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

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、[API Gatewayのレスポンスステータスコード](/docs/ja/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
    "modelId": "qw33h0i33i",
    "modelName": "ApiKeyDto",
    "bodyName": "patchbody",
    "bodyDescription": "api key body"
}
```