Modifies the information of a product.

Limits

Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).

Note Resource Access Management (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 key of the product. A product key is a globally unique identifier (GUID) that is issued by IoT Platform to a new product. You can use the IoT Platform console or call the QueryProductList operation to query the details of all the products in the current account.

ProductName String Yes Street light

The new product name that you want to use. The product name must be 4 to 30 characters in length, and can contain letters, digits, and underscores (_).

Note Each product name must be unique in the current account.
IotInstanceId String No iot_instc_pu****_c*-v64********

The instance ID. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

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 specify common request parameters when you call this API operation. For more information, see Common request 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 succeeds.

  • true: The call succeeded.
  • 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, visit the API Error Center.