Productの変更

Prev Next

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

ユーザーが指定した条件に基づいて Productの情報を変更します。

リクエスト

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

メソッド URI
PATCH /products/{product-id}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
product-id String Required 変更対象の Product ID

リクエスト構文

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

{
    "subscriptionCode" : "PROTECTED",
    "description" : "description",
    "productName" : "productName"
}

リクエストボディ

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

フィールド タイプ 必須の有無 説明
subscriptionCode String Required 変更対象のサブスクリプション方法
  • PUBLIC | PROTECTED
    • PUBLIC: APIを承認なしで誰でも使用可能
    • PROTECTED: APIを使用するには、公開者の承認が必要
description String Optional 変更後の Productの説明
  • 0~300文字
productName String Required 変更後の Product名
  • 0~100文字
  • 変更しない場合、既存の Product名を入力

リクエスト例

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

curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/***681e***' \
--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 '{
    "subscriptionCode" : "PUBLIC",
    "description" : "product002",
    "productName" : "product002"
}'

レスポンス

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

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

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