Canary Test

인쇄
공유
PDF

Canary Test

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Canary 비활성화

URL

DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary

요청 파라미터

이름	위치	필수여부	타입	설명
productId	path	Y	String	Product Id 길이(최대/최소): 0/10
apiId	path	Y	String	Api Id 길이(최대/최소): 0/10
stageId	path	Y	String	Stage Id 길이(최대/최소): 0/10

요청 바디

없음

응답 코드

응답 바디

없음

Canary 활성화

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary

요청 파라미터

이름	위치	필수여부	타입	설명
productId	path	Y	String	Product Id 길이(최대/최소): 0/10
apiId	path	Y	String	Api Id 길이(최대/최소): 0/10
stageId	path	Y	String	Stage Id 길이(최대/최소): 0/10

요청 바디

없음

응답 코드

응답 바디

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

SDK 내보내기

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/export

요청 파라미터

이름	위치	필수여부	타입	설명
productId	path	Y	String	Product Id 길이(최대/최소): 0/10
apiId	path	Y	String	Api Id 길이(최대/최소): 0/10
stageId	path	Y	String	Stage Id 길이(최대/최소): 0/10
platform	query string	N	String	Platform 허용 가능한 값: SWAGGER_JSON, JAVA_SDK 기본값: 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

요청 바디

없음

응답 코드

응답 바디

"Download File"

Canary 수정

URL

PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary

요청 파라미터

이름	위치	필수여부	타입	설명
productId	path	Y	String	Product Id 길이(최대/최소): 0/10
apiId	path	Y	String	Api Id 길이(최대/최소): 0/10
stageId	path	Y	String	Stage Id 길이(최대/최소): 0/10

요청 바디

{
  "canaryCacheTtlSec" : 0,
  "useDistributionRate" : true,
  "canaryConditions" : [ {
    "parameterName" : "parameterName",
    "parameterCode" : "REQUEST_HEADER",
    "parameterValue" : "parameterValue"
  } ],
  "canaryEndpointDomain" : "canaryEndpointDomain",
  "canaryThrottleRps" : 6,
  "canaryDistributionRate" : 1.4658129
}

응답 코드

응답 바디

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

Canary 승급

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/promote

요청 파라미터

이름	위치	필수여부	타입	설명
productId	path	Y	String	Product Id 길이(최대/최소): 0/10
apiId	path	Y	String	Api Id 길이(최대/최소): 0/10
stageId	path	Y	String	Stage Id 길이(최대/최소): 0/10

요청 바디

없음

응답 코드

응답 바디

없음

Canary Swagger Json 조회

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/swagger-json

요청 파라미터

이름	위치	필수여부	타입	설명
productId	path	Y	String	Product Id 길이(최대/최소): 0/10
apiId	path	Y	String	Api Id 길이(최대/최소): 0/10
stageId	path	Y	String	Stage Id 길이(최대/최소): 0/10

요청 바디

없음

응답 코드

응답 바디

{
  "documentJson" : "documentJson"
}

이 문서가 도움이 되었습니까?

What's Next

Dashboard API Key

Canary 비활성화
Canary 활성화
SDK 내보내기
Canary 수정
Canary 승급
Canary Swagger Json 조회

태그

API Gateway