DescribeSuperPlayerConfigs

Last updated: 2020-11-24 18:54:22

1. API Description

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

This API is used to query the list of superplayer configurations and supports paginated queries by filters.

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 parameter. The value used for this API: DescribeSuperPlayerConfigs.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
Names.N No Array of String Player configuration name filter. Array length limit: 100.
Offset No Integer Pagination offset. Default value: 0.
Limit No Integer Number of entries to be returned. Default value: 10. Maximum value: 100.
Type No String Player configuration type filter. Valid values:
  • Preset: preset configuration;
  • Custom: custom configuration.
  • SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible entries.
    PlayerConfigSet Array of PlayerConfig Player configuration array.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the superplayer configuration list

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeSuperPlayerConfigs
    &Names.0=test
    &<Public request parameters>

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "PlayerConfigSet": [
          {
            "Name": "test",
            "Type": "Custom",
            "DrmSwitch": "OFF",
            "AdaptiveDynamicStreamingDefinition": 10,
            "ImageSpriteDefinition": 10,
            "ResolutionNameSet": [
              {
                "MinEdgeLength": 480,
                "Name": "SD"
              },
              {
                "MinEdgeLength": 1440,
                "Name": "2K"
              }
            ],
            "Domain": "xxx.vod2.myqcloud.com",
            "Scheme": "HTTPS",
            "Comment": "",
            "CreateTime": "2019-10-11T10:00:00Z",
            "UpdateTime": "2019-10-11T10:00:00Z"
          }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-4594145287e1"
      }
    }

    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
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    UnauthorizedOperation Unauthorized operation.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help