获取项目列表

最近更新时间：2024-03-12 01:18:39

我的收藏

本页目录：

1. 接口描述

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

支持根据多种条件过滤出项目列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeProjects。
Version	是	String	公共参数，本接口取值：2019-10-29。
Region	否	String	公共参数，本接口不需要传递此参数。
Platform	是	String	平台 Id，指定访问的平台。关于平台概念，请参见文档平台。示例值：test
ProjectIds.N	否	Array of String	项目 Id 过滤参数列表，最大支持20个项目 Id 过滤。如果不填不需要项目 Id 进行过滤。示例值：["1111"]
AspectRatioSet.N	否	Array of String	画布宽高比过滤参数列表。如果不填则不用画布宽高比进行过滤。
CategorySet.N	否	Array of String	项目类型过滤参数列表，取值有： VIDEO_EDIT：视频编辑。 SWITCHER：导播台。 VIDEO_SEGMENTATION：视频拆条。 STREAM_CONNECT：云转推。 RECORD_REPLAY：录制回放。 MEDIA_CAST：点播转直播。注：如果不填则不使用项目类型进行过滤。
Modes.N	否	Array of String	项目模式过滤参数列表，一个项目可以有多种模式并相互切换。当 Category 为 VIDEO_EDIT 时，可选模式有： Default：默认模式。 VideoEditTemplate：视频编辑模板制作模式。注：不填不使用项目模式进行过滤。
Sort	否	SortBy	结果排序方式，支持下列排序字段： CreateTime：创建时间； UpdateTime：更新时间。注：如不填，则使用项目创建时间倒序排列。
Owner	否	Entity	项目所有者，目前仅支持个人项目过滤。
Offset	否	Integer	分页返回的起始偏移量，默认值：0。示例值：0
Limit	否	Integer	分页返回的记录条数，默认值：10。示例值：10
Operator	否	String	操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以查询一切用户项目信息。如果指定操作者，则操作者必须为项目所有者。

3. 输出参数

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

4. 示例

示例1 获取项目列表

输入示例

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

{
    "Platform": "test",
    "ProjectIds": [
        "cmepid_60599df66a6b440001518159"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "ProjectInfoSet": [
            {
                "ProjectId": "cmepid_60599df66a6b440001518159",
                "Name": "test",
                "AspectRatio": "16:9",
                "Category": "VIDEO_EDIT",
                "Owner": {
                    "Type": "PERSON",
                    "Id": "user_31345df76a6b44104571916a"
                },
                "StreamConnectProjectInfo": null,
                "MediaCastProjectInfo": null,
                "UpdateTime": "2020-11-13T06:41:34.808Z",
                "CreateTime": "2020-11-13T06:41:34.808Z",
                "CoverUrl": ""
            }
        ],
        "RequestId": "c44cbb5b-b809-4061-8c45-7469b64e8e5c"
    }
}

示例2 获取云转推项目信息

输入示例

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

{
    "Platform": "test",
    "CategorySet": [
        "STREAM_CONNECT"
    ],
    "ProjectIds": [
        "cmepid_60599df66a6b440001518169"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "ProjectInfoSet": [
            {
                "ProjectId": "cmepid_60599df66a6b440001518169",
                "Name": "test",
                "AspectRatio": "",
                "Category": "STREAM_CONNECT",
                "Owner": {
                    "Type": "PERSON",
                    "Id": "user_31345df76a6b44104571916a"
                },
                "UpdateTime": "2020-11-13T06:41:34.808Z",
                "CreateTime": "2020-11-13T06:41:34.808Z",
                "CoverUrl": "",
                "MediaCastProjectInfo": null,
                "StreamConnectProjectInfo": {
                    "Status": "Working",
                    "CurrentInputEndpoint": "Main",
                    "CurrentStartTime": "2020-11-13T06:41:34.808Z",
                    "CurrentStopTime": "2020-11-13T08:41:34.808Z",
                    "LastStopTime": "2020-11-12T07:41:34.808Z",
                    "MainInput": {
                        "InputType": "LivePull",
                        "LivePullInputInfo": {
                            "InputUrl": "rtmp://liveplay.video-studio.myqcloud.com/output/1250000001-600e8e7fb1cc1c0001293759?txSecret=d5f0d5e9eadda723d7fbf6822313b1c0&txTime=6017C8FF"
                        }
                    },
                    "OutputSet": [
                        {
                            "PushSwitch": "On",
                            "StreamConnectOutput": {
                                "Id": "124522",
                                "PushUrl": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600e8e66194ef500012d9b08",
                                "Name": "test"
                            }
                        }
                    ]
                }
            }
        ],
        "RequestId": "c44cbb5b-b809-4061-8c45-7469b64e8e5c"
    }
}

示例3 获取点播转直播项目信息

输入示例

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

{
    "Platform": "test",
    "CategorySet": [
        "MEDIA_CAST"
    ],
    "ProjectIds": [
        "cmepid_60599df66a6b440001518169"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "ProjectInfoSet": [
            {
                "ProjectId": "cmepid_60599df66a6b440001518169",
                "Name": "test",
                "AspectRatio": "",
                "Category": "MEDIA_CAST",
                "Owner": {
                    "Type": "PERSON",
                    "Id": "user_31345df76a6b44104571916a"
                },
                "UpdateTime": "2020-11-13T06:41:34.808Z",
                "CreateTime": "2020-11-13T06:41:34.808Z",
                "CoverUrl": "",
                "StreamConnectProjectInfo": null,
                "MediaCastProjectInfo": {
                    "Status": "Working",
                    "StartTime": "2020-11-13T06:41:34.808Z",
                    "StopTime": "2020-11-14T06:41:34.808Z",
                    "SourceInfos": [
                        {
                            "Id": "fsdf",
                            "Type": "CME",
                            "MaterialId": "a123"
                        },
                        {
                            "Id": "sdfs",
                            "Type": "VOD",
                            "FileId": "53434"
                        }
                    ],
                    "DestinationInfos": [
                        {
                            "Id": "2342342",
                            "Name": "test",
                            "PushUrl": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600e8e66194ef500012d9b08"
                        }
                    ],
                    "PlaySetting": {
                        "LoopCount": 2
                    },
                    "OutputMediaSetting": {
                        "VideoSetting": {
                            "Width": 1920,
                            "Height": 1080,
                            "Bitrate": 2500,
                            "FrameRate": 25
                        }
                    }
                }
            }
        ],
        "RequestId": "c44cbb5b-b809-4061-8c45-7469b64e8e5c"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.AspectRatioSet	画布宽高比不合法。
InvalidParameterValue.CategorySet	项目类别不合法。
InvalidParameterValue.Limit	返回记录条数不合法。
InvalidParameterValue.OwnerId	归属者 ID 不合法。
InvalidParameterValue.OwnerType	归属者类型不合法。
InvalidParameterValue.Platform	平台参数取值错误。
InvalidParameterValue.SortOrder	排序方式无效。
OperationDenied.PermissionDeny	权限不足，请检查对应操作者的权限。
ResourceNotFound	资源不存在。
ResourceNotFound.Platform	平台不存在。
UnauthorizedOperation	未授权操作。