MENU
      메서드 응답 설명 수정

        메서드 응답 설명 수정


        기사 요약

        Classic/VPC 환경에서 이용 가능합니다.

        생성한 메서드의 응답 상태 코드에 대한 설명을 수정합니다.

        요청

        요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

        메서드URI
        PATCH/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}

        요청 헤더

        API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

        요청 경로 파라미터

        파라미터에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        product-idStringRequiredAPI가 속한 Product ID
        api-idStringRequired응답 설명을 수정할 API의 ID
        resource-idStringRequiredAPI 내 대상 리소스의 ID
        method-nameStringRequired대상 메서드 타입
        • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD
        status-codeIntegerRequired응답 상태 코드

        요청 구문

        요청 구문은 다음과 같습니다.

        {
          "responseDescription" : "responseDescription"
        }
        JSON

        요청 바디

        요청 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        responseDescriptionStringRequired응답에 대한 설명
        • 0~300자

        요청 예시

        요청 예시는 다음과 같습니다.

        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."
        }'
        Curl

        응답

        응답 형식을 설명합니다.

        응답 구문

        응답 구문은 다음과 같습니다.

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

        응답 상태 코드

        API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

        응답 예시

        응답 예시는 다음과 같습니다.

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

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.