メソッドリクエストパラメータの削除
    • PDF

    メソッドリクエストパラメータの削除

    • PDF

    記事の要約

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

    追加したリクエストパラメータ(ヘッダ、クエリ文字列)の中から目的の項目を削除します。

    リクエスト

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

    メソッドURI
    POST/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/parameters/delete

    リクエストヘッダ

    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

    リクエスト構文

    リクエスト構文は次の通りです。

    {
      "parameterName" : "parameterName"
    }
    

    リクエストボディ

    リクエストボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    parameterNameStringRequiredヘッダ、クエリ文字列またはフォームデータの名前
    • 単数形だけ処理可能

    リクエスト例

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

    curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/tf73xuex0v/methods/GET/parameters/delete' \
    --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' \
    --data '{
      "parameterName" : "distance"
    }'
    

    レスポンス

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

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

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


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

    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.