tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateProduct

Last updated: 2022-09-28 10:37:22

1. API Description

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

This API is used to create a new IoT communication product.

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: CreateProduct.
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.
ProductName Yes String Product name, which cannot be same as that of an existing product. Naming rule: [a-zA-Z0-9:_-]{1,32}.
ProductProperties No ProductProperties Product properties
Skey No String Skey, which is required to create a CLAA product.

3. Output Parameters

Parameter Name Type Description
ProductName String Product name
ProductId String Product ID, the globally unique ID assigned by Tencent Cloud.
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 Creating a product

Input Example

https://iotcloud.tencentcloudapi.com/?Action=CreateProduct
&ProductName=fruit
&ProductProperties.ProductDescription=test
&ProductProperties.EncryptionType=1
&ProductProperties.Region=gz
&ProductProperties.ProductType=0
&ProductProperties.Format=json
&<Common request parameters>

Output Example

{
    "Response": {
        "ProductId": "ABCDE12345",
        &ProductName=fruit
        "ProductProperties": {
            "ProductDescription": "test",
            "EncryptionType": 1,
            "Region": "gz",
            "ProductType": 0,
            "Format": "json",
            "Platform": "DEFAULT",
            "Appeui": ""
        },
        "RequestId": "xxxxxxxxxxxxxxxxxxxxxxx"
    }
}

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

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
FailedOperation.AccountIsolated The operation failed as the account has been suspended due to overdue payments.
InternalError Internal error.
InternalError.DBOperationError An internal database error occurred.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.ProductAlreadyExist This product name already exists.
InvalidParameterValue.ProductTypeNotSupport Unsupported product type.
InvalidParameterValue.TidProductAlreadyExist This TID product already exists.
LimitExceeded.ProductExceedLimit The number of products exceeds the limit.
ResourceNotFound.ThingModelNotExist The TSL model does not exist.
UnauthorizedOperation.UserNotAuthenticaed The user identity is not verified.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy