메서드 요청 파라미터 조회
    • PDF

    메서드 요청 파라미터 조회

    • PDF

    기사 요약

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

    생성한 메서드의 요청 파라미터 목록을 조회합니다.

    요청

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

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

    요청 헤더

    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

    요청 예시

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

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

    응답

    응답 형식을 설명합니다.

    응답 구문

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

    {
      "headers" : [ {
        "resourceId" : "resourceId",
        "methodCode" : "methodCode",
        "tenantId" : "tenantId",
        "parameterCode" : "REQUEST_HEADER",
        "parameterType" : "string",
        "apiId" : "apiId",
        "parameterName" : "parameterName",
        "statusCode" : 6,
        "parameterDescription" : "parameterDescription",    
        "isRequired" : true,
        "isArray" : true,
        "modifier" : "modifier",
        "parameterNo" : 0
      } ],
      "queryStrings" : [ {
        "resourceId" : "resourceId",
        "methodCode" : "methodCode",
        "tenantId" : "tenantId",
        "parameterCode" : "REQUEST_HEADER",
        "parameterType" : "string",
        "apiId" : "apiId",
        "parameterName" : "parameterName",
        "statusCode" : 6,
        "parameterDescription" : "parameterDescription",
        "isRequired" : true,
        "isArray" : true,
        "modifier" : "modifier",
        "parameterNo" : 0
      } ],
      "formDatas" : [ {
        "resourceId" : "resourceId",
        "methodCode" : "methodCode",
        "tenantId" : "tenantId",
        "parameterCode" : "REQUEST_HEADER",
        "parameterType" : "string",
        "apiId" : "apiId",
        "parameterName" : "parameterName",
        "statusCode" : 6,
        "parameterDescription" : "parameterDescription",
        "isRequired" : true,
        "isArray" : true,
        "modifier" : "modifier",
        "parameterNo" : 0
      } ],
      "isNcpTenant" : true,
      "useBodyWhenFormData" : true
    }
    

    응답 상태 코드

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

    응답 예시

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

    {
        "headers": [
            {
                "resourceId": "tf73xuex0v",
                "methodCode": "0001",
                "tenantId": "********65ec41039ce6668c2058b8a9",
                "parameterCode": "REQUEST_HEADER",
                "parameterType": "string",
                "apiId": "cvcohvd2xj",
                "parameterName": "x_header",
                "statusCode": 0,
                "parameterDescription": "header 1",
                "isRequired": true,
                "isArray": false
            }
        ],
        "queryStrings": [
            {
                "resourceId": "tf73xuex0v",
                "methodCode": "0001",
                "tenantId": "********65ec41039ce6668c2058b8a9",
                "parameterCode": "REQUEST_QUERY",
                "parameterType": "string",
                "apiId": "cvcohvd2xj",
                "parameterName": "name",
                "statusCode": 0,
                "parameterDescription": "name desc",
                "isRequired": false,
                "isArray": false
            }
        ],
        "formDatas": [
            {
                "resourceId": "tf73xuex0v",
                "methodCode": "0001",
                "tenantId": "********65ec41039ce6668c2058b8a9",
                "parameterCode": "REQUEST_FORMDATA",
                "parameterType": "string",
                "apiId": "cvcohvd2xj",
                "parameterName": "data_field1",
                "statusCode": 0,
                "parameterDescription": "",
                "isRequired": true,
                "isArray": false
            }
        ],
        "isNcpTenant": false,
        "useBodyWhenFormData": 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.