1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
本接口(CreateGencode)用于生成设备物模型源代码
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateGencode。 |
Version | 是 | String | 公共参数,本接口取值:2019-11-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProductId | 是 | String | 产品ID |
Revision | 是 | Integer | 物模型发布版本号,-1代表未发布的,保存的是草稿箱的版本。1代表已发布的物模型。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ZipCode | String | 生成的源代码(zip压缩后的base64编码) 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 生成设备物模型源代码
输入示例
https://iotvideo.tencentcloudapi.com/?Action=CreateGencode
&ProductId=12345678910
&Revision=1
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "ad80cae4-5b90-4001-a130-2d21345afa41",
"ZipCode": "UEsDBBQAAgAIAAAAAAAAAAAAAgAAAAAAAAALAAAAaXZtX3VzcmV4LmgDAFBLAwQUAAIACAAAAAAAK1LoX+cDAAAVEwAACwAAAGl2bV91c3JleC5jrZddU+IwFIav6a/IyIxDlUFFZZZxvHDxY3UVXT/Zq06bphKFFtuEEXf875v0OyVpK7vcQHPOe07y5B2aNLELJ9RGYA3PDRs5nfGa1syPQRuKY/Di7npYTJsaNPDROx9mH7KYIVYLBMSnkGh/tAbPsE1iGnHIII1GA7tkt3ugCNLSKAv29sqk6qgz8cySymFYrWZLwu6zWh7Fq/Q73W/lCd39XnnC/g6bgvYJzh+vDPROkGsnSYFBWCQgJsFQHm4888LJc5bMsAEeQe7cwC4maUpL53s4RdMAkRZYF+RtsN0GAf5AntMSAjrQWWmxVyfc1I5rThHIfQ6ZhXhg7UCeb04mHjR4kyQ/bhiGDaIrdNAyiPcSeG7aJ8oKx4zEYAol84GdamNlMlaltbHj5FY3fLi8lLLo7SlY9PakLFh+GYvenoIF01WyCD2rUFaxKNPWYkGlxmAsqMIYVOqMFAZVOoNKrVHHGVRqjXrOoFJrlNFYtkZMQ2YNKvWGQEPuDSo1Rx1vUKk56nmDSs2hohH/YRdwMBpxYBlHohB5pDjCsK5UiTBEFtnLQ6nN4SjSqKHOAYnVfCRTSqVLXkngyLySKBRwbI9aE6QrZZV0JPud01bRKVeX0eHKojR5W4t4GJ0ksIwnlQh8DoFk29JUgYmIJMoplWZIikRyhw21PGOSR5L0lSuLhkmJyAyTSgpEJFuVpq5KpGgSOZGKzqsQYScyAUlKhAVUSLgmz+QQROc6VW4eyheYxNIUipxJZeuUSn0o7BQqh8ICKihcI0KJzrKq3BWhxNIKKJWtV4DCTt5yKCyggsI1IpTw/K7MXRFKLK2AUtm6AoqPCPVdsH2gfaZXB+i5AQFwbPobkQYin2DX8VgNrbHW/Xk1eyJbT6Phw+bAWtA7C8KLycXi+tfIuRw6V8OHD/9k+3zg9482j86GJ+Ob89OzPty6Ne13dDy72t18PRvB7tFWcNN3775b098/3LdF//iJ+Ivp3ej+dPrmzPH89ubVen15tGF/ZPWIPx6MB5f9xcc9N6sW3myiq5BnvfBrUMSAP7AwD7FVLd2BLIonNnZbwhL56oxweexFWVCGqhvfG4T5ALTA8jVuA/CfbTD3sL0BZmwK7bhy6Cx10Vtk2p47WfzXok8+JiZ76X+9aDtUQGZty4Sv+VoAWqqOR5Dg+Pjwzx3jWlEzrckKYBdFRT0sbkUL8D7tsDrQG7z90nYVL7edaCrrqVE6SWYnKtbkX0BXds72S2gu39IavZPkmu2znVW2z1JqtE+S8+3boKUygc4C7P8kN2I0S6ccbWdhto2Cc6pnGuWVTTLKiOcXPWRT0/4CUEsDBBQAAgAIAAAAAAAAAAAAAgAAAAAAAAAQAAAAaXZtX3VzcmV4X2Z1bmMuYwMAUEsBAgAAFAACAAgAAAAAAAAAAAACAAAAAAAAAAsAAAAAAAAAAAAAAAAAAAAAAGl2bV91c3JleC5oUEsBAgAAFAACAAgAAAAAACtS6F/nAwAAFRMAAAsAAAAAAAAAAQAAAAAAKwAAAGl2bV91c3JleC5jUEsBAgAAFAACAAgAAAAAAAAAAAACAAAAAAAAABAAAAAAAAAAAAAAAAAAOwQAAGl2bV91c3JleF9mdW5jLmNQSwUGAAAAAAMAAwCwAAAAawQAAAAA"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.SignatureFailure | 签名校验失败。 |
AuthFailure.TokenFailure | 获取token为空。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
FailedOperation.PermissionDenied | 无相关操作权限。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Tid | tid非法。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |