게이트웨이 응답 상태 코드 추가
    • PDF

    게이트웨이 응답 상태 코드 추가

    • PDF

    기사 요약

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

    정의된 게이트웨이의 응답 상태 코드를 변경합니다.

    요청

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

    메서드URI
    POST/products/{product-id}/apis/{api-id}/responses/{response-type}

    요청 헤더

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

    요청 경로 파라미터

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

    필드타입필수 여부설명
    product-idStringRequiredAPI가 속한 Product ID
    api-idStringRequired응답 상태 코드를 변경할 API의 ID
    response-typeStringRequired게이트웨이 응답의 유형

    요청 구문

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

    {
      "statusCode" : 0
    }
    

    요청 바디

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

    필드타입필수 여부설명
    statusCodeIntegerRequired변경할 응답 상태 코드

    요청 예시

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

    curl --location --request POST 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/responses/AUTHENTICATION_FAILED' \
    --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 '{
      "statusCode" : 401
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 구문

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

    {
        "apiId": "apiId",
        "responseType": "responseType",
        "responseName": "responseName",
        "statusCode": 000,
        "default": false
    }
    

    응답 상태 코드

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

    응답 예시

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

    {
        "apiId": "cvcohvd2xj",
        "responseType": "AUTHENTICATION_FAILED",
        "responseName": "Authentication Failed",
        "statusCode": 401,
        "default": false
    }
    

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

    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.