Release Notes and Announcements

Release Notes

Product Introduction

Overview

Features

Strengths

Use Cases

Use Limits

Basic Concepts

Getting Started

Quick Start

Scenario 1: Device Interconnection

Scenario 2: Device Status Reporting and Setting

MQTT.fx Connection Guide

Console Guide

Product Management

Rule Engine

Sub-account Access to IoT Hub

Firmware Upgrade

Resource Management

Certificate Management

Developer Manual

Feature Components

Signature Algorithm

Device Authentication

Device Connection Protocol

Gateway Subdevice

Message Communication

Device Shadow

Device Firmware Upgrade

Remote Device Configuration

Resource Management

Device Log Reporting

NTP Service

Device Connection Manual

Device Connection Overview

Connection Based on SDK for C

Connection Based on SDK for Android

Connection Based on SDK for Java

Connection Based on SDK for Python

API Documentation

History

Introduction

API Category

Making API Requests

Device Shadow APIs

Device APIs

CA Certificate APIs

Product APIs

Data Types

Error Codes

FAQs

General

Device Connection and Reporting

Rule Engine

Console

IoT Hub Policy

Data Privacy And Security Agreement

Glossary

DescribeProduct

PDF

Focus Mode

Font Size

Last updated: 2025-11-13 20:52:05

1. API Description

Domain name for API request: iotcloud.intl.tencentcloudapi.com.

This API is used to query product details.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeProduct.
Version	Yes	String	Common Params. The value used for this API: 2021-04-08.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
ProductId	Yes	String	Product ID

3. Output Parameters

Parameter Name	Type	Description
ProductId	String	Product ID
ProductName	String	Product name
ProductMetadata	ProductMetadata	Product metadata
ProductProperties	ProductProperties	Product properties
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying product details

Input Example

https://iotcloud.intl.tencentcloudapi.com/?Action=DescribeProduct
&ProductId=ABCDE12345
&<Common request parameters>

Output Example

{
    "Response": {
        "ProductMetadata": {
            "CreationDate": 1509453755000
        },
        "ProductProperties": {
            "ProductDescription": "description1"
        },
        "ProductName": "Test_1",
        "ProductId": "ABCDE12345",
        "RequestId": "8e0b3665-cfb5-4077-a535-0ed7f970cf3b"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error.
InternalError.DBOperationError	An internal database error occurred.
InvalidParameterValue	Invalid parameter value.
ResourceNotFound.ProductNotExist	The product does not exist.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

IoT Hub