tencent cloud

All product documents
Video on Demand
DocumentationVideo on DemandServer APIsCarousel-Related APIsDescribeRoundPlays
DescribeRoundPlays
Download PDF
Last updated: 2025-02-14 17:29:01
DescribeRoundPlays
Last updated: 2025-02-14 17:29:01
Download PDF

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to query playlists.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeRoundPlays.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
SubAppId No Integer VOD subapplication id. starting from december 25, 2023, if you want to access resources in the vod application (whether it is the default application or a newly created application), you must enter the application id in this field..
RoundPlayIds.N No Array of String Filter criteria: playlist identifier, array length limit: 100.
Status No String Filter criteria: playlist status, optional values:
  • enabled: startup status;
  • disabled: stopped status.
    • .
    CreateTime No TimeRange Filter criteria: playlist creation time.
    UpdateTime No TimeRange Filter criteria: playlist update time.
    ScrollToken No String Scrolling identifier which is used for pulling in batches. if a single request cannot pull all the data entries, the API will return scrolltoken, and if the next request carries it, the next pull will start from the next entry.
    Offset No Integer Pagination offset, default value: 0. this field is obsolete. please use the scrolltoken parameter for batch queries.
    Limit No Integer Number of returned entries. default value: 10. maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The total number of carousel broadcast playlists that meet the filter criteria. deprecated. for batch inquiries, please use the scrolltoken parameter.
    RoundPlaySet Array of RoundPlayInfo The details of the playlist.
    ScrollToken String Scrolling identifier. if a request does not return all the data entries, this field indicates the id of the next entry. if this field is empty, there is no more data.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Get the playlist, name, description and other detailed information of all carousel playlists.

    Input Example

    POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoundPlays
<Common request parameters>

{}

    Output Example

    {
    "Response": {
        "TotalCount": 0,
        "RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3",
        "RoundPlaySet": [
            {
                "Name": "Demo",
                "RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
                "StartTime": "2022-06-01T00:00:00+08:00",
                "Desc": "Demo",
                "Url": "http://123.vod-qcloud.com/rplay/v1/xxxx/playlist.m3u8",
                "Status": "Enabled",
                "PlayBackMode": "Loop",
                "RoundPlaylist": [
                    {
                        "ItemId": "a01",
                        "AudioVideoType": "Transcode",
                        "Definition": 100,
                        "FileId": "528xxx5487985271487"
                    }
                ]
            }
        ]
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    ResourceNotFound The resource does not exist.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon