tencent cloud

All product documents
CreateDevice
Last updated: 2025-02-17 15:36:44
CreateDevice
Last updated: 2025-02-17 15:36:44

1. API Description

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

This API is used to create a device.

A maximum of 50 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: CreateDevice.
Version Yes String Common Params. The value used for this API: 2022-03-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ProjectId Yes String Create the project id to which the device belongs.
DeviceId Yes String Create a device id, which must be unique within the project, consisting of lowercase english letters, numbers, and underscores, with a length not exceeding 18.
DeviceName Yes String Create a device name, with a length of less than 24, which can include chinese, numbers, english letters, and underscores.
DeviceType Yes String Device type, field for on-site device (controlled device), remote for remote device (control device), default is field if not specified.
DeviceToken Yes String Device authentication password, consisting of uppercase and lowercase english letters and digits, must be 16 characters.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Create a Device Example

Input Example

POST / HTTP/1.1
Host: trro.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDevice
<Common request parameters>

{
    "ProjectId": "f3glr49r2nwpey5c",
    "DeviceId": "test2",
    "DeviceName": "test_device",
    "DeviceType": "field",
    "DeviceToken": "abcd1234abcd1234"
}

Output Example

{
    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
    }
}

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 Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
MissingParameter Missing required parameters.
OperationDenied Operation denied.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support