---
title: "メソッドレスポンス説明の変更"
slug: "apigateway-method-patchresponses"
updated: 2026-09-17T09:57:26Z
published: 2026-09-17T09:57:26Z
canonical: "api.ncloud-docs.com/apigateway-method-patchresponses"
---

> ## 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 |
| --- | --- |
| PATCH | /api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code} |

### リクエストヘッダ

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` |
| `status-code` | Integer | Required | レスポンスステータスコード - [メソッドレスポンスの照会](/docs/ja/apigateway-method-getresponses)を参照 |

### リクエスト構文

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

```
{
  "responseDescription" : "responseDescription"
}
```

### リクエストボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `responseDescription` | String | Required | レスポンスの説明 - 0~2000文字 |

### リクエスト例

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

```
curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/tf73xuex0v/methods/GET/responses/400' \
--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 '{
  "responseDescription" : "Wrong request. Check parameters."
}'
```

## レスポンス

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

### レスポンス構文

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

```
{
  "methodResponseDto" : {
    "tenantId" : "tenantId",
    "apiId" : "apiId",
    "resourceId" : "resourceId",
    "methodCode" : "methodCode",
    "statusCode" : 0,
    "responseDescription" : "responseDescription",
    "modifier" : "modifier"
  }
}
```

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

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)をご参照ください。

### レスポンス例

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

```
{
    "methodResponseDto": {
        "tenantId": "********65ec41039ce6668c2058b8a9",
        "apiId": "cvcohvd2xj",
        "resourceId": "tf73xuex0v",
        "methodCode": "0001",
        "statusCode": 400,
        "responseDescription": "Wrong request. Check parameters.",
        "modifier": "********-7fcd-11ec-a6ba-246e9659184c"
    }
}
```