Canaryの有効化

Classic/VPC環境で利用できます。

API明細を Stageに公開する前に、運用環境でテストできる Canary機能を有効化します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

構文は次の通りです。

{
    "stageId": "stageId",
    "canaryCertificateId": "canaryCertificateId",
    "canaryDeploymentNo": 0,
    "canaryDistributionRate": 0.0,
    "canaryEndpointDomain": "canaryEndpointDomain",
    "canaryDeployedTime": "2024-05-08T06:29:48Z",
    "canaryDeploymentDescription": "canaryDeploymentDescription",
    "deployedStageDeploymentNo": 0,
    "useDistributionRate": true
}

レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "stageId": "*****7mhdv",
    "canaryCertificateId": "",
    "canaryDeploymentNo": 251371,
    "canaryDistributionRate": 0.0,
    "canaryEndpointDomain": "NONE",
    "canaryDeployedTime": "2024-05-08T06:29:48Z",
    "canaryDeploymentDescription": "default canary desc",
    "deployedStageDeploymentNo": 251072,
    "useDistributionRate": true
}