Stageメソッド設定の照会
    • PDF

    Stageメソッド設定の照会

    • PDF

    記事の要約

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

    指定した Stageメソッドの設定情報を照会します。

    リクエスト

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

    メソッドURI
    GET/products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments/{deployment-no}/resources/{resource-id}/methods/{method-name}

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    product-idStringRequiredStageが属する Product ID
    api-idStringRequiredStageが属する API ID
    stage-idStringRequiredメソッド設定情報を照会する対象の Stage ID
    deployment-noLongRequiredStageの Deployment番号
    resource-idStringRequiredStageの Resource ID
    method-nameStringRequired照会する対象のメソッド
    • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

    リクエスト例

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

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

    レスポンス

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

    レスポンス構文

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

    {
        "stageMethod" : {
            "resourceId" : "resourceId",
            "endpointCode" : "endpointCode",
            "resourcePath" : "resourcePath",
            "methodName" : "ANY",
            "isInherit" : true,
            "methodCode" : "methodCode",
            "endpointDomain" : "endpointDomain",
            "cacheTtlSec" : 0,
            "restUrl" : "restUrl",
            "throttleRps" : 1,
            "endpointActionId" : "endpointActionId",
            "invokeUrl" : "invokeUrl",
            "stageDeploymentNo" : 6,
            "endpointConfigJson" : "endpointConfigJson"
        }
    }
    

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

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

    レスポンス例

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

    {
        "stageMethod": {
            "stageDeploymentNo": 256***,
            "methodName": "GET",
            "methodCode": "0001",
            "resourceId": "***cd4q***",
            "invokeUrl": "https://***ksk9***.apigw.ntruss.com/api000/stage001/{domainCode}",
            "restUrl": "stage001 - GET /{domainCode}",
            "endpointCode": "0006",
            "endpointConfigJson": "{\"stream\":false,\"method\":\"GET\",\"url\":\"/{domainCode}\"}",
            "isInherit": true
        }
    }
    

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

    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.