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 |
リクエストボディ
- なし
応答コード
- 204
応答ボディ
- なし
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 |
リクエストボディ
- なし
応答コード
- 200
応答ボディ
{
"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 |
リクエストボディ
- なし
応答コード
- 200
応答ボディ
"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
}
応答コード
- 200
応答ボディ
{
"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 |
リクエストボディ
- なし
応答コード
- 204
応答ボディ
- なし
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 |
リクエストボディ
- なし
応答コード
- 200
応答ボディ
{
"documentJson" : "documentJson"
}
この記事は役に立ちましたか?