获取分类列表

最近更新时间:2024-03-15 16:02:01

我的收藏

1. 接口描述

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

获取指定归属者下所有的分类信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClass。
Version String 公共参数,本接口取值:2019-10-29。
Region String 公共参数,本接口不需要传递此参数。
Platform String 平台名称,指定访问的平台。
示例值:test
Owner Entity 归属者。
Operator String 操作者。填写用户的 Id,用于标识调用者及校验操作权限。
示例值:userId

3. 输出参数

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

4. 示例

示例1 获取分类列表

输入示例

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

{
    "Owner": {
        "Type": "PERSON",
        "Id": "1111"
    },
    "Platform": "test"
}

输出示例

{
    "Response": {
        "RequestId": "requestId",
        "ClassInfoSet": [
            {
                "Owner": {
                    "Id": "1111",
                    "Type": "PERSON"
                },
                "ClassPath": "/a/b"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameterValue.OwnerType 归属者类型不合法。
InvalidParameterValue.Platform 平台参数取值错误。
OperationDenied.PermissionDeny 权限不足,请检查对应操作者的权限。
ResourceNotFound.Platform 平台不存在。
UnauthorizedOperation 未授权操作。