1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
提供修改产品的名称和描述等信息的能力,对于已发布产品不允许进行修改。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyStudioProduct。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProductId | 是 | String | 产品ID 示例值:4GDIU5HTEN |
ProductName | 是 | String | 产品名称 示例值:testProduct |
ProductDesc | 是 | String | 产品描述 示例值:Pdesc |
ModuleId | 是 | Integer | 模型ID 示例值:0 |
EnableProductScript | 否 | String | 是否打开二进制转Json功能, 取值为字符串 true/false 示例值:"" |
BindStrategy | 否 | Integer | 传1或者2;1代表强踢,2代表非强踢。传其它值不做任何处理 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Product | ProductEntry | 产品描述 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改产品
修改产品名称和描述等信息
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyStudioProduct
<公共请求参数>
{
"BindStrategy": "1",
"ModuleId": "0",
"ProductName": "testProduct",
"ProductDesc": "Pdesc",
"ProductId": "4GDIU5HTEN"
}
输出示例
{
"Response": {
"Product": {
"DevStatus": "dev",
"EncryptionType": "2",
"DataProtocol": 1,
"ProjectId": "prj-zunfat46",
"Region": "gz",
"ModuleId": 0,
"EnableProductScript": "true",
"UpdateTime": 1,
"ProductName": "testProduct",
"CreateUserId": 0,
"ProductDesc": "test",
"NetType": "else",
"ProductType": 0,
"CreatorNickName": "test",
"CreateTime": 1,
"CategoryId": 3,
"BindStrategy": 0,
"ProductId": "4GDIU5HTEN"
},
"RequestId": "1c469fbf-d80c-4299-9b54-31340898b839"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DBOpertaionError | DB操作错误。 |
InternalError.InternalRPCError | 内部RPC错误。 |
InternalError.InternalServerExceptionDB | 内部DB错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.ModelDefineDontMatchTemplate | 物模型不符合产品模板。 |
InvalidParameterValue.ProductAlreadyExist | 创建的产品名已存在。 |
InvalidParameterValue.ProductIDInvalid | 产品ID非法。 |
InvalidParameterValue.ProductParmsError | 产品参数错误。 |
LimitExceeded.StudioProductExceedLimit | 产品数量超出限制。 |
ResourceNotFound.ProductNotExist | 产品不存在。 |
ResourceNotFound.ProductOrDeviceNotExist | 产品或设备不存在。 |
ResourceNotFound.ProjectNotExist | 项目不存在。 |
ResourceNotFound.StudioProductNotExist | 产品不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NoPermissionToProject | 项目ACL错误。 |
UnauthorizedOperation.NoPermissionToStudioProduct | 产品ACL错误。 |
UnsupportedOperation.InstanceIsolated | 由于实例到期已被禁用,请续费后使用。 |
UnsupportedOperation.VideoProductNotExist | Video平台产品不存在。 |