Canary Test
    • PDF

    Canary Test

    • PDF

    Article Summary

    Canary無効

    URL

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

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    stageIdpathYStringStage Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 204

    応答ボディ

    • なし

    Canary有効

    URL

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

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    stageIdpathYStringStage 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
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    stageIdpathYStringStage Id
    長さ(最大/最小):0 / 10
    platformquery stringNStringPlatform
    許容値:SWAGGER_JSON, JAVA_SDK
    デフォルト値:SWAGGER_JSON
    packageNamequery stringNStringPackage Name
    groupIdquery stringNStringGroup Id
    artifactIdquery stringNStringArtifact Id
    artifactVersionquery stringNStringArtifact Version
    licensequery stringNStringLicense
    versionquery stringNStringVersion

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    "Download File"
    

    Canary修正

    URL

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

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    stageIdpathYStringStage 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
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    stageIdpathYStringStage 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
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiIdpathYStringApi Id
    長さ(最大/最小):0 / 10
    stageIdpathYStringStage Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "documentJson" : "documentJson"
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.