tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Application Rendering
    Documentation
    Download PDF

    DescribeApplicationProjectAdvancedConfig

    Last updated: 2024-09-14 10:44:53
    Download PDF

    1. API Description

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

    This API is used to obtain the advanced configuration information of a cloud application project.

    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: DescribeApplicationProjectAdvancedConfig.
    Version Yes String Common Params. The value used for this API: 2022-01-10.
    Region No String Common Params. This parameter is not required for this API.
    ProjectId Yes String Application project ID.

    3. Output Parameters

    Parameter Name Type Description
    ApplicationParams String Application startup parameters.

    Note: This field may return null, indicating that no valid values can be obtained.
    Resolution String Resolution, in the format of widthxheight, such as 1920x1080.Note: This field may return null, indicating that no valid values can be obtained.
    FPS Integer Frame rate. Valid values: 0, 30, 60.Note: This field may return null, indicating that no valid values can be obtained.
    MinBitrate Integer Minimum bitrate, in Mbps.Note: This field may return null, indicating that no valid values can be obtained.
    MaxBitrate Integer Maximum bitrate, in Mbps.Note: This field may return null, indicating that no valid values can be obtained.
    PreloadDuration String Waiting time for application pre-launch.Note: This field may return null, indicating that no valid values can be obtained.
    ReconnectTimeout String Waiting time for reconnection.Note: This field may return null, indicating that no valid values can be obtained.
    UpstreamAudioOption String Upstream audio options.DisableMixIntoStreamPush: not mixing upstream audio in streaming.Note: This field may return null, indicating that no valid values can be obtained.
    VideoEncodeConfig VideoEncodeConfig Video encoding configuration.Note: This field may return null, indicating that no valid values can be obtained.
    XRMaxWidth Integer Upper limit of the XR application resolution.If the project concurrency type is L or L2, the upper limit is 5000; if the project concurrency type is XL2, the upper limit is 6000.Note: This field may return null, indicating that no valid values can be obtained.
    BackgroundImage BackgroundImage Background image information.Note: This field may return null, indicating that no valid values can be obtained.
    DisableVideoCodecs Array of String Disabled code list.Note: This field may return null, indicating that no valid values can be obtained.
    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

    Example1 Obtaining the Advanced Configuration Data of a Cloud Application Project

    This example shows you how to obtain advanced configuration parameters of a cloud application.

    Input Example

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



{
    "ProjectId": "abc"
}

    Output Example

    {
    "Response": {
        "ApplicationParams": "abc",
        "Resolution": "abc",
        "FPS": 0,
        "MinBitrate": 0,
        "MaxBitrate": 0,
        "PreloadDuration": "10s",
        "ReconnectTimeout": "10s",
        "DisableVideoCodecs": [
            "H265"
        ],
        "RequestId": "abc"
    }
}

    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.
    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
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy