Canary Test
- Print
- PDF
Canary Test
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Disable canary test
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary
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 |
Request Body
- None
Response Code
- 204
Response Body
- None
Enable canary test
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary
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 |
Request Body
- None
Response Code
- 200
Response Body
{
"canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
"canaryDeploymentNo" : 6,
"deployedStageDeploymentNo" : 5,
"canaryCacheTtlSec" : 0,
"useDistributionRate" : true,
"canaryConditions" : [ {
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"parameterValue" : "parameterValue"
} ],
"canaryDeploymentDescription" : "canaryDeploymentDescription",
"canaryEndpointDomain" : "canaryEndpointDomain",
"canaryDistributionRate" : 1.4658129,
"canaryThrottleRps" : 5,
"stageId" : "stageId"
}
Export sdk from stage
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/export
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 |
| platform | query string | N | String | Platform Allowable values: SWAGGER_JSON, JAVA_SDK Default value: SWAGGER_JSON |
| packageName | query string | N | String | Package Name |
| groupId | query string | N | String | Group Id |
| artifactId | query string | N | String | Artifact Id |
| artifactVersion | query string | N | String | Artifact Version |
| license | query string | N | String | License |
| version | query string | N | String | Version |
Request Body
- None
Response Code
- 200
Response Body
"Download File"
Modify canary test
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary
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 |
Request Body
{
"canaryCacheTtlSec" : 0,
"useDistributionRate" : true,
"canaryConditions" : [ {
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"parameterValue" : "parameterValue"
} ],
"canaryEndpointDomain" : "canaryEndpointDomain",
"canaryThrottleRps" : 6,
"canaryDistributionRate" : 1.4658129
}
Response Code
- 200
Response Body
{
"canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
"canaryDeploymentNo" : 6,
"deployedStageDeploymentNo" : 5,
"canaryCacheTtlSec" : 0,
"useDistributionRate" : true,
"canaryConditions" : [ {
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"parameterValue" : "parameterValue"
} ],
"canaryDeploymentDescription" : "canaryDeploymentDescription",
"canaryEndpointDomain" : "canaryEndpointDomain",
"canaryDistributionRate" : 1.4658129,
"canaryThrottleRps" : 5,
"stageId" : "stageId"
}
Promote canary test
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/promote
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 |
Request Body
- None
Response
- 204
Response Body
- None
Canary test swagger json
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/swagger-json
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 |
Request Body
- None
Response Code
- 200
Response Body
{
"documentJson" : "documentJson"
}
Was this article helpful?