MENU
      Login
          Login
          目次 x
          メソッドリクエストボディの照会
            目次

            メソッドリクエストボディの照会

              記事の要約

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

              ユーザー定義したメソッドのリクエストボディを照会します。

              リクエスト

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

              メソッドURI
              GET/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/request-body

              リクエストヘッダ

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

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

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

              フィールドタイプ必須の有無説明
              product-idStringRequiredAPIが属する Product ID
              api-idStringRequiredリクエストボディを照会する対象の API ID
              resource-idStringRequiredAPI内対象リソースの ID
              method-nameStringRequired対象メソッドのタイプ
              • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

              リクエスト例

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

              curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/tf73xuex0v/methods/POST/request-body' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
              Curl

              レスポンス

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

              レスポンス構文

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

              {
  "modelId" : "modelId",
  "modelName" : "modelName",
  "bodyName" : "bodyName",
  "bodyDescription" : "bodyDescription"
}
              JSON

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

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

              レスポンス例

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

              {
    "modelId": "qw33h0i33i",
    "modelName": "ApiKeyDto",
    "bodyName": "apiKey",
    "bodyDescription": "request body"
}
              JSON
              この記事は役に立ちましたか?
              Change password!
              Changing your password will log you out immediately. Use the new password to log back in.
              Change profile
              Success!
              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.
              Logout