Stage 메서드 설정 조회
    • PDF

    Stage 메서드 설정 조회

    • PDF

    기사 요약

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

    지정한 Stage 메서드의 설정 정보를 조회합니다.

    요청

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

    메서드URI
    GET/products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments/{deployment-no}/resources/{resource-id}/methods/{method-name}

    요청 헤더

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

    요청 경로 파라미터

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

    필드타입필수 여부설명
    product-idStringRequiredStage가 속한 Product ID
    api-idStringRequiredStage가 속한 API ID
    stage-idStringRequired메서드 설정 정보를 조회할 Stage ID
    deployment-noLongRequiredStage의 Deployment 번호
    resource-idStringRequiredStage의 Resource ID
    method-nameStringRequired조회할 메서드
    • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

    요청 예시

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

    curl --location --request GET 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***26c7***/deployments/256***/resources/***cd4q***/methods/GET' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    응답

    응답 형식을 설명합니다.

    응답 구문

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

    {
        "stageMethod" : {
            "resourceId" : "resourceId",
            "endpointCode" : "endpointCode",
            "resourcePath" : "resourcePath",
            "methodName" : "ANY",
            "isInherit" : true,
            "methodCode" : "methodCode",
            "endpointDomain" : "endpointDomain",
            "cacheTtlSec" : 0,
            "restUrl" : "restUrl",
            "throttleRps" : 1,
            "endpointActionId" : "endpointActionId",
            "invokeUrl" : "invokeUrl",
            "stageDeploymentNo" : 6,
            "endpointConfigJson" : "endpointConfigJson"
        }
    }
    

    응답 상태 코드

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

    응답 예시

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

    {
        "stageMethod": {
            "stageDeploymentNo": 256***,
            "methodName": "GET",
            "methodCode": "0001",
            "resourceId": "***cd4q***",
            "invokeUrl": "https://***ksk9***.apigw.gov-ntruss.com/api000/stage001/{domainCode}",
            "restUrl": "stage001 - GET /{domainCode}",
            "endpointCode": "0006",
            "endpointConfigJson": "{\"stream\":false,\"method\":\"GET\",\"url\":\"/{domainCode}\"}",
            "isInherit": true
        }
    }
    

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

    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.