修改项目安全模式

最近更新时间:2025-04-25 02:04:57

我的收藏

1. 接口描述

接口请求域名: trro.tencentcloudapi.com 。

使用项目共享密钥可动态生成设备登录密钥,登录前无需对设备进行提前注册,适合希望简化业务流程的客户。由于是公共密钥,请务必注意保护项目共享密钥,并及时更新。建议项目共享密钥保存在服务器侧。由服务器生成设备登录密码下发给设备,避免密钥保存在客户端侧产生的密钥泄露风险。

开启项目共享密钥后,对于已注册的设备,仍可使用原设备密码登录。若希望仅能通过共享密钥生成密码登录,请通过云 API 将设备密码更新为"USEPROJECTKEYPWD"。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyProjectSecMode。
Version String 公共参数,本接口取值:2022-03-25。
Region String 公共参数,详见产品支持的 地域列表
ProjectId String 项目ID
示例值:m82k540iwduvuuma
Mode Integer 安全模式
0:关闭项目共享密钥
1:开启项目共享密钥
示例值:1
Key String 项目密钥 32位 小写英文+数字; 项目密钥模式必填
示例值:123456789012345678901234567abcde
AutoRegister Integer 自动注册方式
0:关闭自动注册
1:仅允许现场设备自动注册
2:仅允许远端设备自动注册
3:允许现场和远端设备均自动注册
示例值:1
FieldListEnable Integer 是否允许远端获取现场设备列表(getGwList)
0:不允许
1:允许
示例值:1

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改项目授权模式

输入示例

POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProjectSecMode
<公共请求参数>

{
    "ProjectId": "m82k540iwduvuuma",
    "Mode": 1,
    "Key": "123456789012345678901234567abcde",
    "AutoRegister": 3,
    "FieldListEnable": 1
}

输出示例

{
    "Response": {
        "RequestId": "abcd"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
OperationDenied 操作被拒绝。