Modifies the information about a product.

QPS limits

You can call this API operation up to 10 times per second per account.

Note The RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateProduct

The operation that you want to perform. Set the value to UpdateProduct.

ProductKey String Yes a1BwAGV****

The ProductKey of the product. A ProductKey is a GUID that is issued by IoT Platform to the product.

You can use the IoT Platform console or call the QueryProductList operation to view the information about all products within the current Alibaba Cloud account.

ProductName String Yes Street light

The new product name that you want to use.

The name must be 4 to 30 characters in length, and can contain letters, digits, and underscores (_).

Important Each product name must be unique within the current Alibaba Cloud account.
IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the instance. You can view the ID of the instance on the Overview page in the IoT Platform console.

Important
  • If your instance has an ID, you must specify the ID for this parameter. Otherwise, the call fails.
  • If no Overview page or ID is generated for your instance, you do not need to configure this parameter.

For more information, see Overview.

Description String No The 2nd generation street light.

The description of the product. The description must be 1 to 100 characters in length.

In addition to the preceding operation-specific request parameters, you must configure common request parameters when you call this operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

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

The ID of the request.

Success Boolean true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, see Service error codes.