Stage Resource
- Print
- PDF
Stage Resource
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Search method setting
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments/{deployment-no}/resources/{resource-id}/methods/{method-name}
Request Parameter
| Name | Position | Required | Type | Description |
|---|---|---|---|---|
| productId | path | Y | String | Product Id Length(Min/Max): 0/10 |
| apiId | path | Y | String | Api Id Length(Min/Max): 0/10 |
| stageId | path | Y | String | Stage Id Length(Min/Max): 0/10 |
| deploymentNo | path | Y | Long | Deployment No |
| resourceId | path | Y | String | Resource Id Length(Min/Max): 0/10 |
| methodName | path | Y | String | Method Code Allowable values: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
Request Body
- None
Response Code
- 200
Response Body
{
"stageMethod" : {
"resourceId" : "resourceId",
"endpointCode" : "endpointCode",
"resourcePath" : "resourcePath",
"methodName" : "ANY",
"isInherit" : true,
"methodCode" : "methodCode",
"endpointDomain" : "endpointDomain",
"cacheTtlSec" : 0,
"restUrl" : "restUrl",
"throttleRps" : 1,
"endpointActionId" : "endpointActionId",
"invokeUrl" : "invokeUrl",
"stageDeploymentNo" : 6,
"endpointConfigJson" : "endpointConfigJson"
}
}
get methods of the certain stage's resource
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments/{deployment-no}/resources/{resource-id}/methods
Request Parameter
| Name | Position | Required | Type | Description |
|---|---|---|---|---|
| productId | path | Y | String | Product Id Length(Min/Max): 0/10 |
| apiId | path | Y | String | Api Id Length(Min/Max): 0/10 |
| stageId | path | Y | String | Stage Id Length(Min/Max): 0/10 |
| deploymentNo | path | Y | Long | Deployment No |
| resourceId | path | Y | String | Resource Id Length(Min/Max): 0/10 |
Request Body
- None
Response Code
- 200
Response Body
{
"stageMethods" : [ {
"resourceId" : "resourceId",
"endpointCode" : "endpointCode",
"resourcePath" : "resourcePath",
"methodName" : "ANY",
"isInherit" : true,
"methodCode" : "methodCode",
"endpointDomain" : "endpointDomain",
"cacheTtlSec" : 0,
"restUrl" : "restUrl",
"throttleRps" : 1,
"endpointActionId" : "endpointActionId",
"invokeUrl" : "invokeUrl",
"stageDeploymentNo" : 6,
"endpointConfigJson" : "endpointConfigJson"
} ]
}
Override a method's setting
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments/{deployment-no}/resources/{resource-id}/methods/{method-name}
Request Parameter
| Name | Position | Required | Type | Description |
|---|---|---|---|---|
| productId | path | Y | String | Product Id Length(Min/Max): 0/10 |
| apiId | path | Y | String | Api Id Length(Min/Max): 0/10 |
| stageId | path | Y | String | Stage Id Length(Min/Max): 0/10 |
| deploymentNo | path | Y | Long | Deployment No |
| resourceId | path | Y | String | Resource Id Length(Min/Max): 0/10 |
| methodName | path | Y | String | Method Name Allowable values: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
Request Body
{
"cacheTtlSec" : 0,
"throttleRps" : 6,
"isInherit" : true,
"endpointDomain" : "endpointDomain"
}
Response Code
- 200
Response Body
{
"stageMethod" : {
"resourceId" : "resourceId",
"endpointCode" : "endpointCode",
"resourcePath" : "resourcePath",
"methodName" : "ANY",
"isInherit" : true,
"methodCode" : "methodCode",
"endpointDomain" : "endpointDomain",
"cacheTtlSec" : 0,
"restUrl" : "restUrl",
"throttleRps" : 1,
"endpointActionId" : "endpointActionId",
"invokeUrl" : "invokeUrl",
"stageDeploymentNo" : 6,
"endpointConfigJson" : "endpointConfigJson"
}
}
Was this article helpful?