Add method response
- Print
- PDF
Add method response
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Define and add a response status code for a created method.
Request
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
POST | /products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses |
Request headers
For headers common to API Gateway, see API Gateway common 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 response you want to add
|
resource-id | String | Required | ID of the target resource in the API
|
method-name | String | Required | Target method type
|
Request syntax
The request syntax is as follows.
{
"responseDescription" : "responseDescription",
"statusCode" : 0
}
Request body
The following describes the request body.
Field | Type | Required | Description |
---|---|---|---|
responseDescription | String | Optional | Response description
|
statusCode | Integer | Required | Response status code
|
Request example
The following is a sample request.
curl --location --request POST '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' \
--data '{
"responseDescription" : "Bad Request",
"statusCode" : 400
}'
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"methodResponseDto" : {
"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.
{
"methodResponseDto": {
"tenantId": "********65ec41039ce6668c2058b8a9",
"apiId": "cvcohvd2xj",
"resourceId": "tf73xuex0v",
"methodCode": "0001",
"statusCode": 400,
"responseDescription": "Bad Request",
"modifier": "********-7fcd-11ec-a6ba-246e9659184c"
}
}
Was this article helpful?