메서드 조회
    • PDF

    메서드 조회

    • PDF

    기사 요약

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

    리소스 경로 안에 사용자가 정의하여 생성한 메서드를 목록으로 나열하여 조회합니다.

    요청

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

    메서드URI
    GET/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods

    요청 헤더

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

    요청 경로 파라미터

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

    필드타입필수 여부설명
    product-idStringRequiredAPI가 속한 Product ID
    api-idStringRequired조회할 API의 ID
    resource-idStringRequiredAPI 내 대상 리소스의 ID

    요청 예시

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

    curl --location --request GET 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/p1hiuvmwv3/methods' \
    --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'
    

    응답

    응답 형식을 설명합니다.

    응답 구문

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

    {
      "methods" : [ {
        "methodDescription" : "methodDescription",
        "resourceId" : "resourceId",
        "useBodyWhenFormData" : true,
        "endpointCode" : "endpointCode",
        "modifier" : "modifier",
        "resourcePath" : "resourcePath",
        "methodName" : "ANY",
        "ncpEndPoint" : {
          "method" : "ANY",
          "stream" : true,
          "service" : "service",
          "actionId" : "actionId",
          "region" : "KR",
          "url" : "url",
          "actionName" : "actionName"
        },
        "requiredApiKey" : {
          "required" : true
        },
        "mockEndPoint" : {
          "headers" : {
            "key" : "value"
          },
          "response" : "response",
          "httpStatus" : 0
        },
        "endpointActionId" : "endpointActionId",
        "produces" : "produces",
        "tenantId" : "tenantId",
        "consumers" : "consumers",
        "methodFilters" : [ {
          "configJson" : "configJson",
          "resourceId" : "resourceId",
          "filterName" : "AUTH",
          "apiId" : "apiId",
          "methodCode" : "methodCode"
        } ],
        "apiId" : "apiId",
        "validation" : {
          "headers" : [ "headers" ],
          "queryStrings" : [ "queryStrings" ],
          "type" : "NONE"
        },
        "authentication" : {
          "authorizerId" : "authorizerId",
          "platform" : "NONE"
        },
        "endpointConfigJson" : "endpointConfigJson",
        "httpEndPoint" : {
          "method" : "ANY",
          "stream" : true,
          "url" : "url"
        }
      } ]
    }
    

    응답 상태 코드

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

    응답 예시

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

    {
        "methods": [
            {
                "methodDescription": "",
                "resourceId": "p1hiuvmwv3",
                "methodName": "DELETE",
                "apiId": "cvcohvd2xj",
                "endpointCode": "0007",
                "mockEndPoint": {
                    "httpStatus": 200,
                    "response": "Successfully deleted",
                    "headers": {
                        "timestamp": "103958846273"
                    }
                },
                "consumers": "application/json",
                "produces": "application/json",
                "useBodyWhenFormData": false,
                "tenantId": "********65ec41039ce6668c2058b8a9",
                "modifier": "********-7fcd-11ec-a6ba-246e9659184c",
                "validation": {
                    "type": "QUERYSTRING_HEADERS",
                    "queryStrings": [
                        "accountId"
                    ],
                    "headers": [
                        "teamNumber"
                    ]
                },
                "authentication": {
                    "platform": "NONE"
                },
                "requiredApiKey": {
                    "required": true
                }
            },
            {
                "methodDescription": "",
                "resourceId": "p1hiuvmwv3",
                "methodName": "OPTIONS",
                "apiId": "cvcohvd2xj",
                "endpointCode": "0008",
                "ncpEndPoint": {
                    "service": "Cloud Functions",
                    "region": "KR",
                    "actionId": "******Jbeodp/pckg/act02",
                    "actionName": "pckg/act02",
                    "stream": true,
                    "method": "OPTIONS",
                    "url": "http://ncf.navercorp.com/api/v1/web/******Jbeodp/pckg/act02.{type}"
                },
                "useBodyWhenFormData": false,
                "tenantId": "********65ec41039ce6668c2058b8a9",
                "modifier": "********-7fcd-11ec-a6ba-246e9659184c",
                "validation": {
                    "type": "NONE"
                },
                "authentication": {
                    "platform": "NONE"
                },
                "requiredApiKey": {
                    "required": 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.