Stageデプロイ履歴の照会
    • PDF

    Stageデプロイ履歴の照会

    • PDF

    記事の要約

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

    指定した Stageに APIをデプロイした履歴を照会します。

    リクエスト

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

    メソッドURI
    GET/products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    product-idStringRequiredStageが属する Product ID
    api-idStringRequiredStageが属する API ID
    stage-idStringRequiredデプロイ履歴照会対象の Stage ID

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

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

    フィールドタイプ必須の有無説明
    offsetLongOptionalレスポンスデータの開始点
    • 0~9,223,372,036,854,775,807
    • limitと共にページネーションの実装に使用
    limitLongOptionalレスポンスデータの最大数
    • 1~9,223,372,036,854,775,807
    • offsetと共にページネーションの実装に使用

    リクエスト例

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

    curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***5ei7***/deployments' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

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

    レスポンス構文

    レスポンス構文は次の通りです。

    {
        "total" : 1,
        "content" : [ {
            "deployedTime" : "2000-01-23T04:56:07.000+00:00",
            "deploymentDescription" : "deploymentDescription",
            "stageDeploymentNo" : 0,
            "documentJson" : "documentJson",
            "stageId" : "stageId"
        } ],
        "defaultDeploymentNo" : 6
    }
    

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

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

    レスポンス例

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

    {
        "content": [
            {
                "stageDeploymentNo": 251***,
                "deploymentDescription": "",
                "stageId": "***5ei7***",
                "deployedTime": "2024-05-08T02:38:43Z"
            },
    // (省略)
        ],
        "total": 9,
        "defaultDeploymentNo": 251***
    }
    

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

    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.