有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

该接口用于获取当前账号的子应用列表,包含主应用。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSubAppIds。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
Name String 子应用名称。
示例值:test
Tags.N Array of ResourceTag 标签信息,查询指定标签的子应用列表。
Offset Integer 分页拉取的起始偏移量。默认值:0。
示例值:0
Limit Integer 分页拉取的最大返回结果数。默认值:200;最大值:200。
示例值:1

3. 输出参数

参数名称 类型 描述
SubAppIdInfoSet Array of SubAppIdInfo 子应用信息集合。
TotalCount Integer 子应用总数量。
示例值:2
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询子应用资源列表

查询子应用资源列表

输入示例

https://vod.tencentcloudapi.com/?Action=DescribeSubAppIds
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "SubAppIdInfoSet": [
            {
                "SubAppId": 1451123904,
                "Name": "子应用1",
                "SubAppIdName": "主应用",
                "Description": "子应用1简介",
                "CreateTime": "2018-10-01T10:00:00Z",
                "Status": "On"
            },
            {
                "SubAppId": 1251123904,
                "Name": "主应用",
                "SubAppIdName": "主应用",
                "Description": "",
                "CreateTime": "2018-10-01T10:00:00Z",
                "Status": "On"
            }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
ResourceNotFound 资源不存在。
ResourceNotFound.ServiceNotExist 没有开通服务。
UnauthorizedOperation 未授权操作。