智能创作
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 智能创作 > 服务端 API > 平台管理相关接口 > 获取平台列表

获取平台列表

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

我的收藏

本页目录：

1. 接口描述

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

  • 支持获取所创建的所有平台列表信息；
  • 支持获取指定的平台列表信息。

    • 关于平台概念，请参见文档 平台。

    默认接口请求频率限制：100次/秒。

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

    2. 输入参数

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

    参数名称 必选 类型 描述
    Action 是 String 公共参数，本接口取值：DescribePlatforms。
    Version 是 String 公共参数，本接口取值：2019-10-29。
    Region 否 String 公共参数，本接口不需要传递此参数。
    Platforms.N 否 Array of String 平台 Id 列表。如果不填，则不按平台 Id 进行过滤。
    示例值：test
    LicenseIds.N 否 Array of String 平台绑定的 License Id 列表。如果不填，则不按平台绑定的 License Id 进行过滤。
    示例值：cmelid_8621ba0483c211ea90dc6c92bf621f6e
    Offset 否 Integer 分页返回的起始偏移量，默认值：0。
    示例值：0
    Limit 否 Integer 分页返回的记录条数，默认值：10，最大值：20。
    示例值：10

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合查询条件的记录总数。
    示例值：10
    PlatformInfoSet Array of PlatformInfo 平台信息列表。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取所有创建的平台列表

    输入示例

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

{}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "PlatformInfoSet": [
            {
                "Platform": "1112",
                "Status": "Valid",
                "Description": "test",
                "VodSubAppId": 140000303,
                "LicenseId": "cmelid_8621ba0483c211ea90dc6c92bf621f6e",
                "CreateTime": "2018-12-01T13:00:00Z",
                "UpdateTime": "2018-12-01T13:00:00Z"
            }
        ],
        "RequestId": "946c2480-a14f-4d18-8a09-31a45cbd21af"
    }
}

    示例2 指定绑定的 License Id 获取平台列表

    输入示例

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

{
    "LicenseIds": [
        "cmelid_8621ba0483c211ea90dc6c92bf621f6e"
    ]
}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "PlatformInfoSet": [
            {
                "Platform": "1112",
                "Status": "Valid",
                "Description": "test",
                "VodSubAppId": 140000303,
                "LicenseId": "cmelid_8621ba0483c211ea90dc6c92bf621f6e",
                "CreateTime": "2018-12-01T13:00:00Z",
                "UpdateTime": "2018-12-01T13:00:00Z"
            }
        ],
        "RequestId": "946c2480-a14f-4d18-8a09-31a45cbd21af"
    }
}

    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 参数取值错误。
    InvalidParameterValue.Limit 返回记录条数不合法。
    UnauthorizedOperation 未授权操作。
    中国站