---
title: "메서드 응답 설명 수정"
slug: "apigateway-method-patchresponses"
tags: ["API Gateway", "Method"]
updated: 2026-07-23T09:04:32Z
published: 2026-07-23T09:04:32Z
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/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/apigateway-product-getproductlist) 참조 |
| `api-id` | String | Required | 응답 설명을 수정할 API의 ID - 1~10자 - [API 조회](/docs/apigateway-api-apis) 참조 |
| `resource-id` | String | Required | API 내 대상 리소스의 ID - 1~10자 - [Resource 목록 조회](/docs/apigateway-resource-getresourcelist) 참조 |
| `method-name` | String | Required | 대상 메서드 타입 - `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD` |
| `status-code` | Integer | Required | 응답 상태 코드 - [메서드 응답 조회](/docs/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/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"
    }
}
```