有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

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

产品列表查询

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProductList。
Version String 公共参数,本接口取值:2023-04-27。
Region String 公共参数,详见产品支持的 地域列表
WorkspaceId Integer 工作空间id
示例值:1016
PageNumber Integer 分页查询,第几页
示例值:1
PageSize Integer 每页条数,大于0
示例值:1
ApplicationToken String 应用token
示例值:xxx
DeviceTypeSet.N Array of String 设备类型
示例值:w020202
ProductIdSet.N Array of Integer 产品 pid
示例值:12
ModelIdSet.N Array of String 模型id
示例值:29

3. 输出参数

参数名称 类型 描述
Result ProductSet 产品列表查询结果
示例值:{"PageNumber": 1,"PageSize": 1,"Product": [{"Attribute": 1,"DeviceTypeId": "w777","DeviceTypeName": "","MaintenanceMfr": "未知厂商","Manufacturer": "未知厂商","ModelId": "","ModelName": "","ModelType": 0,"ProductAbility": 1,"ProductId": 2000051,"ProductName": "视频网关","ProductType": "33","WorkspaceId": 1016}],"TotalPage": 132,"TotalRow": 132}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 产品列表查询

正常返回结果

输入示例

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

{
    "WorkspaceId": 1016,
    "PageNumber": 1,
    "PageSize": 1,
    "ApplicationToken": "YzenL5LdGoxQM5gqJfCCoMDeGqUSsY78"
}

输出示例

{
    "Response": {
        "RequestId": "8372d7e4-f04f-43bd-8f7d-d8b4586fdc8b",
        "Result": {
            "PageNumber": 1,
            "PageSize": 1,
            "Product": [
                {
                    "Attribute": 1,
                    "DeviceTypeId": "w777",
                    "DeviceTypeName": "",
                    "MaintenanceMfr": "未知厂商",
                    "Manufacturer": "未知厂商",
                    "ModelId": "",
                    "ModelName": "",
                    "ModelType": 0,
                    "ProductAbility": 1,
                    "ProductId": 2000051,
                    "ProductName": "视频网关",
                    "ProductType": "33",
                    "WorkspaceId": 1016
                }
            ],
            "TotalPage": 132,
            "TotalRow": 132
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.ApiAuthorizationNotFound 未找到此应用该api授权信息
InternalError.AppApiNoSpacePermission 该应用未关联该项目空间数据,无法获取该项目空间数据
InvalidParameter 参数错误。
InvalidParameterValue.InvalidWorkspaceId 错误的工作空间Id
ResourceNotFound 资源不存在。