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-id`	String	Required	Stageが属する Product ID 0~10文字 Productリストの照会アクションを通じて確認
`api-id`	String	Required	Stageが属する API ID 0~10文字 APIの照会アクションを通じて確認
`stage-id`	String	Required	メソッド設定情報を照会する対象の Stage ID 0~10文字 Stageリストの照会アクションを通じて確認
`deployment-no`	Long	Required	Stageの Deployment番号 Stageリストの照会を通じて確認
`resource-id`	String	Required	Stageの Resource ID 0~10文字 Resourceリストの照会を通じて確認
`method-name`	String	Required	照会する対象のメソッド `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
    }
}

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

What's Next

Stage全メソッド設定の照会

リクエスト
レスポンス