View method request parameter

Prev Next

Available in Classic and VPC

View the list of request parameters of a created method.

Request

The following describes the request format for the endpoint. The request format is as follows:

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

Request headers

For headers common to API Gateway, see API Gateway common request headers.

Request path parameters

The following describes the parameters.

Field Type Required Description
product-id String Required Product ID that the API belongs to
api-id String Required ID of the API whose parameter you want to view
resource-id String Required ID of the target resource in the API
method-name String Required Target method type
  • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

Request example

The following is a sample request.

curl --location --request GET 'https://apigateway.apigw.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'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
  "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
}

Response status codes

For response status codes common to API Gateway, see API Gateway response status codes.

Response example

The following is a sample response.

{
    "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
}