すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:UpdateProduct

最終更新日:Apr 17, 2025

プロダクトに関する情報を変更します。

QPS 制限

この API 操作は、アカウントごとに 1 秒あたり最大 10 回呼び出すことができます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は、署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター タイプ 必須 例 説明
Action String Yes UpdateProduct

実行する操作。値を UpdateProduct に設定します。

ProductKey String Yes a1BwAGV****

プロダクトの ProductKey。ProductKey は、IoT Platform がプロダクトに発行する GUID です。

IoT Platform コンソールを使用するか、QueryProductList 操作を呼び出して、現在の Alibaba Cloud アカウント内のすべてのプロダクトに関する情報を表示できます。

ProductName String Yes Street light

使用する新しいプロダクト名。

名前は 4 ~ 30 文字で、文字、数字、アンダースコア(_)を含めることができます。

重要 各プロダクト名は、現在の Alibaba Cloud アカウント内で一意である必要があります。
IotInstanceId String No iot_instc_pu****_c*-v64********

インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの [概要] ページで確認できます。

重要
  • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。
  • インスタンスに対して [概要] ページまたは [ID] が生成されていない場合は、このパラメーターを設定する必要はありません。

詳細については、「概要」をご参照ください。

Description String No The 2nd generation street light.

プロダクトの説明。説明は 1 ~ 100 文字である必要があります。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを設定する必要があります。共通のリクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター タイプ 例 説明
Code String iot.system.SystemException

呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。

ErrorMessage String A system exception occurred.

呼び出しが失敗した場合に返されるエラーメッセージ。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

リクエストの ID。

Success Boolean true

呼び出しが成功したかどうかを示します。有効な値:

  • true: 呼び出しは成功しました。
  • false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateProduct
&ProductKey=a1BwAGV****
&ProductName=TestProductNew
&Description=new features v2
&<Common request parameters>

成功レスポンスの例

XML 形式

<UpdateProductResponse>
  <RequestId>C4FDA54C-4201-487F-92E9-022F42387458</RequestId>
  <Success>true</Success>
</UpdateProductResponse>

JSON 形式

{
      "RequestId":"C4FDA54C-4201-487F-92E9-022F42387458",
      "Success":true
  }

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。