View method response

Available in Classic and VPC

View the response information for a created method.

Request

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

Request headers

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

Request path parameters

The following describes the parameters.

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/responses' \
--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.

{
  "responses" : [ {
    "tenantId" : "tenantId",
    "apiId" : "apiId",
    "resourceId" : "resourceId",
    "methodCode" : "methodCode",
    "statusCode" : 0,
    "responseDescription" : "responseDescription",
    "modifier" : "modifier",
  } ]
}

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.

{
    "responses": [
        {
            "tenantId": "********65ec41039ce6668c2058b8a9",
            "apiId": "cvcohvd2xj",
            "resourceId": "tf73xuex0v",
            "methodCode": "0001",
            "statusCode": 200,
            "responseDescription": "OK"
        },
        {
            "tenantId": "********65ec41039ce6668c2058b8a9",
            "apiId": "cvcohvd2xj",
            "resourceId": "tf73xuex0v",
            "methodCode": "0001",
            "statusCode": 404,
            "responseDescription": "not found"
        }
    ]
}